From 842bde9e13adeefff8ff6c83650c279d18f8a1e3 Mon Sep 17 00:00:00 2001 From: awstools Date: Thu, 22 Aug 2024 18:27:18 +0000 Subject: [PATCH] chore(models): update API models --- .../sdk-codegen/aws-models/auto-scaling.json | 22021 +-- codegen/sdk-codegen/aws-models/bedrock.json | 18011 +-- .../aws-models/emr-containers.json | 9470 +- .../sdk-codegen/aws-models/inspector2.json | 30777 ++-- .../sdk-codegen/aws-models/quicksight.json | 113185 ++++++++------- codegen/sdk-codegen/aws-models/route-53.json | 24576 ++-- 6 files changed, 109716 insertions(+), 108324 deletions(-) diff --git a/codegen/sdk-codegen/aws-models/auto-scaling.json b/codegen/sdk-codegen/aws-models/auto-scaling.json index 4821b31e5b94..80788987f2b0 100644 --- a/codegen/sdk-codegen/aws-models/auto-scaling.json +++ b/codegen/sdk-codegen/aws-models/auto-scaling.json @@ -1,11135 +1,11186 @@ { - "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.autoscaling#AcceleratorCountRequest": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.autoscaling#NullablePositiveInteger", - "traits": { - "smithy.api#documentation": "

The minimum value.

" - } - }, - "Max": { - "target": "com.amazonaws.autoscaling#NullablePositiveInteger", - "traits": { - "smithy.api#documentation": "

The maximum value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the minimum and maximum for the AcceleratorCount object when\n you specify InstanceRequirements for an Auto Scaling group.

" - } - }, - "com.amazonaws.autoscaling#AcceleratorManufacturer": { - "type": "enum", - "members": { - "NVIDIA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "nvidia" - } - }, - "AMD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "amd" - } - }, - "AMAZON_WEB_SERVICES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "amazon-web-services" - } - }, - "XILINX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "xilinx" - } - } - } - }, - "com.amazonaws.autoscaling#AcceleratorManufacturers": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#AcceleratorManufacturer" - } - }, - "com.amazonaws.autoscaling#AcceleratorName": { - "type": "enum", - "members": { - "A100": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "a100" - } - }, - "V100": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "v100" - } - }, - "K80": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "k80" - } - }, - "T4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "t4" - } - }, - "M60": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "m60" - } - }, - "RADEON_PRO_V520": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "radeon-pro-v520" - } - }, - "VU9P": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "vu9p" - } - } - } - }, - "com.amazonaws.autoscaling#AcceleratorNames": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#AcceleratorName" - } - }, - "com.amazonaws.autoscaling#AcceleratorTotalMemoryMiBRequest": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.autoscaling#NullablePositiveInteger", - "traits": { - "smithy.api#documentation": "

The memory minimum in MiB.

" - } - }, - "Max": { - "target": "com.amazonaws.autoscaling#NullablePositiveInteger", - "traits": { - "smithy.api#documentation": "

The memory maximum in MiB.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the minimum and maximum for the AcceleratorTotalMemoryMiB\n object when you specify InstanceRequirements for an Auto Scaling group.

" - } - }, - "com.amazonaws.autoscaling#AcceleratorType": { - "type": "enum", - "members": { - "GPU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "gpu" - } - }, - "FPGA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "fpga" - } - }, - "INFERENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "inference" - } - } - } - }, - "com.amazonaws.autoscaling#AcceleratorTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#AcceleratorType" - } - }, - "com.amazonaws.autoscaling#ActiveInstanceRefreshNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ActiveInstanceRefreshNotFound", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The request failed because an active instance refresh or rollback for the specified\n Auto Scaling group was not found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.autoscaling#Activities": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#Activity" - } - }, - "com.amazonaws.autoscaling#ActivitiesType": { - "type": "structure", - "members": { - "Activities": { - "target": "com.amazonaws.autoscaling#Activities", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The scaling activities. Activities are sorted by start time. Activities still in\n progress are described first.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" - } - } - } - }, - "com.amazonaws.autoscaling#Activity": { - "type": "structure", - "members": { - "ActivityId": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the activity.

", - "smithy.api#required": {} - } - }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

A friendly, more verbose description of the activity.

" - } - }, - "Cause": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The reason the activity began.

", - "smithy.api#required": {} - } - }, - "StartTime": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The start time of the activity.

", - "smithy.api#required": {} - } - }, - "EndTime": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The end time of the activity.

" - } - }, - "StatusCode": { - "target": "com.amazonaws.autoscaling#ScalingActivityStatusCode", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The current status of the activity.

", - "smithy.api#required": {} - } - }, - "StatusMessage": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

A friendly, more verbose description of the activity status.

" - } - }, - "Progress": { - "target": "com.amazonaws.autoscaling#Progress", - "traits": { - "smithy.api#documentation": "

A value between 0 and 100 that indicates the progress of the activity.

" - } - }, - "Details": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The details about the activity.

" - } - }, - "AutoScalingGroupState": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupState", - "traits": { - "smithy.api#documentation": "

The state of the Auto Scaling group, which is either InService or\n Deleted.

" - } - }, - "AutoScalingGroupARN": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Auto Scaling group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes scaling activity, which is a long-running process that represents a change\n to your Auto Scaling group, such as changing its size or replacing an instance.

" - } - }, - "com.amazonaws.autoscaling#ActivityIds": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#XmlString" - } - }, - "com.amazonaws.autoscaling#ActivityType": { - "type": "structure", - "members": { - "Activity": { - "target": "com.amazonaws.autoscaling#Activity", - "traits": { - "smithy.api#documentation": "

A scaling activity.

" - } - } - } - }, - "com.amazonaws.autoscaling#AdjustmentType": { - "type": "structure", - "members": { - "AdjustmentType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The policy adjustment type. The valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a policy adjustment type.

" - } - }, - "com.amazonaws.autoscaling#AdjustmentTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#AdjustmentType" - } - }, - "com.amazonaws.autoscaling#Alarm": { - "type": "structure", - "members": { - "AlarmName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the alarm.

" - } - }, - "AlarmARN": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alarm.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an alarm.

" - } - }, - "com.amazonaws.autoscaling#AlarmList": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" - } - }, - "com.amazonaws.autoscaling#AlarmSpecification": { - "type": "structure", - "members": { - "Alarms": { - "target": "com.amazonaws.autoscaling#AlarmList", - "traits": { - "smithy.api#documentation": "

The names of one or more CloudWatch alarms to monitor for the instance refresh. You can\n specify up to 10 alarms.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the CloudWatch alarm specification to use in an instance refresh.

" - } - }, - "com.amazonaws.autoscaling#Alarms": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#Alarm" - } - }, - "com.amazonaws.autoscaling#AllowedInstanceType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 30 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\.\\*\\-]+$" - } - }, - "com.amazonaws.autoscaling#AllowedInstanceTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#AllowedInstanceType" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 400 - } - } - }, - "com.amazonaws.autoscaling#AlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "AlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You already have an Auto Scaling group or launch configuration with this name.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.autoscaling#AnyPrintableAsciiStringMaxLen4000": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 4000 - }, - "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007e]+$" - } - }, - "com.amazonaws.autoscaling#AsciiStringMaxLen255": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[A-Za-z0-9\\-_\\/]+$" - } - }, - "com.amazonaws.autoscaling#AssociatePublicIpAddress": { - "type": "boolean" - }, - "com.amazonaws.autoscaling#AttachInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#AttachInstancesQuery" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - }, - { - "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" - } - ], - "traits": { - "smithy.api#documentation": "

Attaches one or more EC2 instances to the specified Auto Scaling group.

\n

When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the\n number of instances being attached. If the number of instances being attached plus the\n desired capacity of the group exceeds the maximum size of the group, the operation\n fails.

\n

If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are\n also registered with the load balancer. If there are target groups attached to your Auto Scaling\n group, the instances are also registered with the target groups.

\n

For more information, see Detach\n or attach instances in the Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To attach an instance to an Auto Scaling group", - "documentation": "This example attaches the specified instance to the specified Auto Scaling group.", - "input": { - "InstanceIds": ["i-93633f9b"], - "AutoScalingGroupName": "my-auto-scaling-group" - } - } - ] - } - }, - "com.amazonaws.autoscaling#AttachInstancesQuery": { - "type": "structure", - "members": { - "InstanceIds": { - "target": "com.amazonaws.autoscaling#InstanceIds", - "traits": { - "smithy.api#documentation": "

The IDs of the instances. You can specify up to 20 instances.

" - } - }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroupsType" - }, - "output": { - "target": "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroupsResultType" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - }, - { - "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" - } - ], - "traits": { - "smithy.api#documentation": "\n

This API operation is superseded by AttachTrafficSources, which\n can attach multiple traffic sources types. We recommend using\n AttachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support AttachLoadBalancerTargetGroups. You can\n use both the original AttachLoadBalancerTargetGroups API operation and\n AttachTrafficSources on the same Auto Scaling group.

\n \n

Attaches one or more target groups to the specified Auto Scaling group.

\n

This operation is used with the following load balancer types:

\n \n

To describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from\n the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.

\n

This operation is additive and does not detach existing target groups or Classic Load\n Balancers from the Auto Scaling group.

\n

For more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To attach a target group to an Auto Scaling group", - "documentation": "This example attaches the specified target group to the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "TargetGroupARNs": [ - "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" - ] - } - } - ] - } - }, - "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroupsResultType": { - "type": "structure", - "members": {} - }, - "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroupsType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "TargetGroupARNs": { - "target": "com.amazonaws.autoscaling#TargetGroupARNs", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the target groups. You can specify up to 10 target\n groups. To get the ARN of a target group, use the Elastic Load Balancing DescribeTargetGroups API operation.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#AttachLoadBalancers": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#AttachLoadBalancersType" - }, - "output": { - "target": "com.amazonaws.autoscaling#AttachLoadBalancersResultType" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - }, - { - "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" - } - ], - "traits": { - "smithy.api#documentation": "\n

This API operation is superseded by AttachTrafficSources, which\n can attach multiple traffic sources types. We recommend using\n AttachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support AttachLoadBalancers. You can use both\n the original AttachLoadBalancers API operation and\n AttachTrafficSources on the same Auto Scaling group.

\n \n

Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the\n running instances with these Classic Load Balancers.

\n

To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach a load balancer from the Auto Scaling\n group, call the DetachLoadBalancers API.

\n

This operation is additive and does not detach existing Classic Load Balancers or\n target groups from the Auto Scaling group.

\n

For more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To attach a load balancer to an Auto Scaling group", - "documentation": "This example attaches the specified load balancer to the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "LoadBalancerNames": ["my-load-balancer"] + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" } - } ] - } }, - "com.amazonaws.autoscaling#AttachLoadBalancersResultType": { - "type": "structure", - "members": {} - }, - "com.amazonaws.autoscaling#AttachLoadBalancersType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "LoadBalancerNames": { - "target": "com.amazonaws.autoscaling#LoadBalancerNames", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The names of the load balancers. You can specify up to 10 load balancers.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#AttachTrafficSources": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#AttachTrafficSourcesType" - }, - "output": { - "target": "com.amazonaws.autoscaling#AttachTrafficSourcesResultType" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - }, - { - "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" - } - ], - "traits": { - "smithy.api#documentation": "

Attaches one or more traffic sources to the specified Auto Scaling group.

\n

You can use any of the following as traffic sources for an Auto Scaling group:

\n \n

This operation is additive and does not detach existing traffic sources from the Auto Scaling\n group.

\n

After the operation completes, use the DescribeTrafficSources API to\n return details about the state of the attachments between traffic sources and your Auto Scaling\n group. To detach a traffic source from the Auto Scaling group, call the DetachTrafficSources API.

", - "smithy.api#examples": [ - { - "title": "To attach a target group to an Auto Scaling group", - "documentation": "This example attaches the specified target group to the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "TrafficSources": [ - { - "Identifier": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + "shapes": { + "com.amazonaws.autoscaling#AcceleratorCountRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.autoscaling#NullablePositiveInteger", + "traits": { + "smithy.api#documentation": "

The minimum value.

" + } + }, + "Max": { + "target": "com.amazonaws.autoscaling#NullablePositiveInteger", + "traits": { + "smithy.api#documentation": "

The maximum value.

" + } } - ] }, - "output": {} - } - ] - } - }, - "com.amazonaws.autoscaling#AttachTrafficSourcesResultType": { - "type": "structure", - "members": {} - }, - "com.amazonaws.autoscaling#AttachTrafficSourcesType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "TrafficSources": { - "target": "com.amazonaws.autoscaling#TrafficSources", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The unique identifiers of one or more traffic sources. You can specify up to 10\n traffic sources.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#AutoRollback": { - "type": "boolean" - }, - "com.amazonaws.autoscaling#AutoScalingGroup": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "AutoScalingGroupARN": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Auto Scaling group.

" - } - }, - "LaunchConfigurationName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the associated launch configuration.

" - } - }, - "LaunchTemplate": { - "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", - "traits": { - "smithy.api#documentation": "

The launch template for the group.

" - } - }, - "MixedInstancesPolicy": { - "target": "com.amazonaws.autoscaling#MixedInstancesPolicy", - "traits": { - "smithy.api#documentation": "

The mixed instances policy for the group.

" - } - }, - "MinSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The minimum size of the group.

", - "smithy.api#required": {} - } - }, - "MaxSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The maximum size of the group.

", - "smithy.api#required": {} - } - }, - "DesiredCapacity": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The desired size of the group.

", - "smithy.api#required": {} - } - }, - "PredictedCapacity": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupPredictedCapacity", - "traits": { - "smithy.api#documentation": "

The predicted capacity of the group when it has a predictive scaling policy.

" - } - }, - "DefaultCooldown": { - "target": "com.amazonaws.autoscaling#Cooldown", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The duration of the default cooldown period, in seconds.

", - "smithy.api#required": {} - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.autoscaling#AvailabilityZones", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

One or more Availability Zones for the group.

", - "smithy.api#required": {} - } - }, - "LoadBalancerNames": { - "target": "com.amazonaws.autoscaling#LoadBalancerNames", - "traits": { - "smithy.api#documentation": "

One or more load balancers associated with the group.

" - } - }, - "TargetGroupARNs": { - "target": "com.amazonaws.autoscaling#TargetGroupARNs", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the target groups for your load balancer.

" - } - }, - "HealthCheckType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A comma-separated value string of one or more health check types.

", - "smithy.api#required": {} - } - }, - "HealthCheckGracePeriod": { - "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", - "traits": { - "smithy.api#documentation": "

The duration of the health check grace period, in seconds.

" - } - }, - "Instances": { - "target": "com.amazonaws.autoscaling#Instances", - "traits": { - "smithy.api#documentation": "

The EC2 instances associated with the group.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The date and time the group was created.

", - "smithy.api#required": {} - } - }, - "SuspendedProcesses": { - "target": "com.amazonaws.autoscaling#SuspendedProcesses", - "traits": { - "smithy.api#documentation": "

The suspended processes associated with the group.

" - } - }, - "PlacementGroup": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the placement group into which to launch your instances, if any.

" - } - }, - "VPCZoneIdentifier": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen5000", - "traits": { - "smithy.api#documentation": "

One or more subnet IDs, if applicable, separated by commas.

" - } - }, - "EnabledMetrics": { - "target": "com.amazonaws.autoscaling#EnabledMetrics", - "traits": { - "smithy.api#documentation": "

The metrics enabled for the group.

" - } - }, - "Status": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The current state of the group when the DeleteAutoScalingGroup\n operation is in progress.

" - } - }, - "Tags": { - "target": "com.amazonaws.autoscaling#TagDescriptionList", - "traits": { - "smithy.api#documentation": "

The tags for the group.

" - } - }, - "TerminationPolicies": { - "target": "com.amazonaws.autoscaling#TerminationPolicies", - "traits": { - "smithy.api#documentation": "

The termination policies for the group.

" - } - }, - "NewInstancesProtectedFromScaleIn": { - "target": "com.amazonaws.autoscaling#InstanceProtected", - "traits": { - "smithy.api#documentation": "

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in.

" - } - }, - "ServiceLinkedRoleARN": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other Amazon Web Services on your behalf.

" - } - }, - "MaxInstanceLifetime": { - "target": "com.amazonaws.autoscaling#MaxInstanceLifetime", - "traits": { - "smithy.api#documentation": "

The maximum amount of time, in seconds, that an instance can be in service.

\n

Valid Range: Minimum value of 0.

" - } - }, - "CapacityRebalance": { - "target": "com.amazonaws.autoscaling#CapacityRebalanceEnabled", - "traits": { - "smithy.api#documentation": "

Indicates whether Capacity Rebalancing is enabled.

" - } - }, - "WarmPoolConfiguration": { - "target": "com.amazonaws.autoscaling#WarmPoolConfiguration", - "traits": { - "smithy.api#documentation": "

The warm pool for the group.

" - } - }, - "WarmPoolSize": { - "target": "com.amazonaws.autoscaling#WarmPoolSize", - "traits": { - "smithy.api#documentation": "

The current size of the warm pool.

" - } - }, - "Context": { - "target": "com.amazonaws.autoscaling#Context", - "traits": { - "smithy.api#documentation": "

Reserved.

" - } - }, - "DesiredCapacityType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only.

" - } - }, - "DefaultInstanceWarmup": { - "target": "com.amazonaws.autoscaling#DefaultInstanceWarmup", - "traits": { - "smithy.api#documentation": "

The duration of the default instance warmup, in seconds.

" - } - }, - "TrafficSources": { - "target": "com.amazonaws.autoscaling#TrafficSources", - "traits": { - "smithy.api#documentation": "

The traffic sources associated with this Auto Scaling group.

" - } - }, - "InstanceMaintenancePolicy": { - "target": "com.amazonaws.autoscaling#InstanceMaintenancePolicy", - "traits": { - "smithy.api#documentation": "

An instance maintenance policy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Auto Scaling group.

" - } - }, - "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity": { - "type": "integer" - }, - "com.amazonaws.autoscaling#AutoScalingGroupMaxSize": { - "type": "integer" - }, - "com.amazonaws.autoscaling#AutoScalingGroupMinSize": { - "type": "integer" - }, - "com.amazonaws.autoscaling#AutoScalingGroupNames": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" - } - }, - "com.amazonaws.autoscaling#AutoScalingGroupNamesType": { - "type": "structure", - "members": { - "AutoScalingGroupNames": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupNames", - "traits": { - "smithy.api#documentation": "

The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can\n optionally increase this limit using the MaxRecords property.

\n

If you omit this property, all Auto Scaling groups are described.

" - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.autoscaling#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.

" - } - }, - "Filters": { - "target": "com.amazonaws.autoscaling#Filters", - "traits": { - "smithy.api#documentation": "

One or more filters to limit the results based on specific tags.\n

" - } - } - } - }, - "com.amazonaws.autoscaling#AutoScalingGroupPredictedCapacity": { - "type": "integer" - }, - "com.amazonaws.autoscaling#AutoScalingGroupState": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.autoscaling#AutoScalingGroups": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#AutoScalingGroup" - } - }, - "com.amazonaws.autoscaling#AutoScalingGroupsType": { - "type": "structure", - "members": { - "AutoScalingGroups": { - "target": "com.amazonaws.autoscaling#AutoScalingGroups", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The groups.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" - } - } - } - }, - "com.amazonaws.autoscaling#AutoScalingInstanceDetails": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {} - } - }, - "InstanceType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The instance type of the EC2 instance.

" - } - }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group for the instance.

", - "smithy.api#required": {} - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Availability Zone for the instance.

", - "smithy.api#required": {} - } - }, - "LifecycleState": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The lifecycle state for the instance. The Quarantined state is not used.\n For more information, see Amazon EC2 Auto Scaling instance\n lifecycle in the Amazon EC2 Auto Scaling User Guide.

\n

Valid values: Pending | Pending:Wait |\n Pending:Proceed | Quarantined | InService |\n Terminating | Terminating:Wait |\n Terminating:Proceed | Terminated | Detaching\n | Detached | EnteringStandby | Standby |\n Warmed:Pending | Warmed:Pending:Wait |\n Warmed:Pending:Proceed | Warmed:Terminating |\n Warmed:Terminating:Wait | Warmed:Terminating:Proceed |\n Warmed:Terminated | Warmed:Stopped |\n Warmed:Running\n

", - "smithy.api#required": {} - } - }, - "HealthStatus": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The last reported health status of this instance. Healthy means that the\n instance is healthy and should remain in service. Unhealthy means that the\n instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.

", - "smithy.api#required": {} - } - }, - "LaunchConfigurationName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The launch configuration used to launch the instance. This value is not available if\n you attached the instance to the Auto Scaling group.

" - } - }, - "LaunchTemplate": { - "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", - "traits": { - "smithy.api#documentation": "

The launch template for the instance.

" - } - }, - "ProtectedFromScaleIn": { - "target": "com.amazonaws.autoscaling#InstanceProtected", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling\n in.

", - "smithy.api#required": {} - } - }, - "WeightedCapacity": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", - "traits": { - "smithy.api#documentation": "

The number of capacity units contributed by the instance based on its instance\n type.

\n

Valid Range: Minimum value of 1. Maximum value of 999.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an EC2 instance associated with an Auto Scaling group.

" - } - }, - "com.amazonaws.autoscaling#AutoScalingInstances": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#AutoScalingInstanceDetails" - } - }, - "com.amazonaws.autoscaling#AutoScalingInstancesType": { - "type": "structure", - "members": { - "AutoScalingInstances": { - "target": "com.amazonaws.autoscaling#AutoScalingInstances", - "traits": { - "smithy.api#documentation": "

The instances.

" - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" - } - } - } - }, - "com.amazonaws.autoscaling#AutoScalingNotificationTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" - } - }, - "com.amazonaws.autoscaling#AutoScaling_2011_01_01": { - "type": "service", - "version": "2011-01-01", - "operations": [ - { - "target": "com.amazonaws.autoscaling#AttachInstances" - }, - { - "target": "com.amazonaws.autoscaling#AttachLoadBalancers" - }, - { - "target": "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroups" - }, - { - "target": "com.amazonaws.autoscaling#AttachTrafficSources" - }, - { - "target": "com.amazonaws.autoscaling#BatchDeleteScheduledAction" - }, - { - "target": "com.amazonaws.autoscaling#BatchPutScheduledUpdateGroupAction" + "traits": { + "smithy.api#documentation": "

Specifies the minimum and maximum for the AcceleratorCount object when\n you specify InstanceRequirements for an Auto Scaling group.

" + } }, - { - "target": "com.amazonaws.autoscaling#CancelInstanceRefresh" + "com.amazonaws.autoscaling#AcceleratorManufacturer": { + "type": "enum", + "members": { + "NVIDIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nvidia" + } + }, + "AMD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amd" + } + }, + "AMAZON_WEB_SERVICES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amazon-web-services" + } + }, + "XILINX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "xilinx" + } + } + } }, - { - "target": "com.amazonaws.autoscaling#CompleteLifecycleAction" + "com.amazonaws.autoscaling#AcceleratorManufacturers": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#AcceleratorManufacturer" + } }, - { - "target": "com.amazonaws.autoscaling#CreateAutoScalingGroup" + "com.amazonaws.autoscaling#AcceleratorName": { + "type": "enum", + "members": { + "A100": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "a100" + } + }, + "V100": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "v100" + } + }, + "K80": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "k80" + } + }, + "T4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "t4" + } + }, + "M60": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m60" + } + }, + "RADEON_PRO_V520": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "radeon-pro-v520" + } + }, + "VU9P": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vu9p" + } + } + } }, - { - "target": "com.amazonaws.autoscaling#CreateLaunchConfiguration" + "com.amazonaws.autoscaling#AcceleratorNames": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#AcceleratorName" + } }, - { - "target": "com.amazonaws.autoscaling#CreateOrUpdateTags" + "com.amazonaws.autoscaling#AcceleratorTotalMemoryMiBRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.autoscaling#NullablePositiveInteger", + "traits": { + "smithy.api#documentation": "

The memory minimum in MiB.

" + } + }, + "Max": { + "target": "com.amazonaws.autoscaling#NullablePositiveInteger", + "traits": { + "smithy.api#documentation": "

The memory maximum in MiB.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the minimum and maximum for the AcceleratorTotalMemoryMiB\n object when you specify InstanceRequirements for an Auto Scaling group.

" + } }, - { - "target": "com.amazonaws.autoscaling#DeleteAutoScalingGroup" + "com.amazonaws.autoscaling#AcceleratorType": { + "type": "enum", + "members": { + "GPU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gpu" + } + }, + "FPGA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fpga" + } + }, + "INFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inference" + } + } + } }, - { - "target": "com.amazonaws.autoscaling#DeleteLaunchConfiguration" + "com.amazonaws.autoscaling#AcceleratorTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#AcceleratorType" + } }, - { - "target": "com.amazonaws.autoscaling#DeleteLifecycleHook" + "com.amazonaws.autoscaling#ActiveInstanceRefreshNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ActiveInstanceRefreshNotFound", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request failed because an active instance refresh or rollback for the specified\n Auto Scaling group was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.autoscaling#DeleteNotificationConfiguration" + "com.amazonaws.autoscaling#Activities": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#Activity" + } }, - { - "target": "com.amazonaws.autoscaling#DeletePolicy" + "com.amazonaws.autoscaling#ActivitiesType": { + "type": "structure", + "members": { + "Activities": { + "target": "com.amazonaws.autoscaling#Activities", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The scaling activities. Activities are sorted by start time. Activities still in\n progress are described first.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" + } + } + } }, - { - "target": "com.amazonaws.autoscaling#DeleteScheduledAction" + "com.amazonaws.autoscaling#Activity": { + "type": "structure", + "members": { + "ActivityId": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the activity.

", + "smithy.api#required": {} + } + }, + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

A friendly, more verbose description of the activity.

" + } + }, + "Cause": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The reason the activity began.

", + "smithy.api#required": {} + } + }, + "StartTime": { + "target": "com.amazonaws.autoscaling#TimestampType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The start time of the activity.

", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.autoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

The end time of the activity.

" + } + }, + "StatusCode": { + "target": "com.amazonaws.autoscaling#ScalingActivityStatusCode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The current status of the activity.

", + "smithy.api#required": {} + } + }, + "StatusMessage": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

A friendly, more verbose description of the activity status.

" + } + }, + "Progress": { + "target": "com.amazonaws.autoscaling#Progress", + "traits": { + "smithy.api#documentation": "

A value between 0 and 100 that indicates the progress of the activity.

" + } + }, + "Details": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The details about the activity.

" + } + }, + "AutoScalingGroupState": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupState", + "traits": { + "smithy.api#documentation": "

The state of the Auto Scaling group, which is either InService or\n Deleted.

" + } + }, + "AutoScalingGroupARN": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Auto Scaling group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes scaling activity, which is a long-running process that represents a change\n to your Auto Scaling group, such as changing its size or replacing an instance.

" + } }, - { - "target": "com.amazonaws.autoscaling#DeleteTags" + "com.amazonaws.autoscaling#ActivityIds": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#XmlString" + } }, - { - "target": "com.amazonaws.autoscaling#DeleteWarmPool" + "com.amazonaws.autoscaling#ActivityType": { + "type": "structure", + "members": { + "Activity": { + "target": "com.amazonaws.autoscaling#Activity", + "traits": { + "smithy.api#documentation": "

A scaling activity.

" + } + } + } }, - { - "target": "com.amazonaws.autoscaling#DescribeAccountLimits" + "com.amazonaws.autoscaling#AdjustmentType": { + "type": "structure", + "members": { + "AdjustmentType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The policy adjustment type. The valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a policy adjustment type.

" + } }, - { - "target": "com.amazonaws.autoscaling#DescribeAdjustmentTypes" + "com.amazonaws.autoscaling#AdjustmentTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#AdjustmentType" + } }, - { - "target": "com.amazonaws.autoscaling#DescribeAutoScalingGroups" + "com.amazonaws.autoscaling#Alarm": { + "type": "structure", + "members": { + "AlarmName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the alarm.

" + } + }, + "AlarmARN": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alarm.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an alarm.

" + } }, - { - "target": "com.amazonaws.autoscaling#DescribeAutoScalingInstances" + "com.amazonaws.autoscaling#AlarmList": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" + } }, - { - "target": "com.amazonaws.autoscaling#DescribeAutoScalingNotificationTypes" + "com.amazonaws.autoscaling#AlarmSpecification": { + "type": "structure", + "members": { + "Alarms": { + "target": "com.amazonaws.autoscaling#AlarmList", + "traits": { + "smithy.api#documentation": "

The names of one or more CloudWatch alarms to monitor for the instance refresh. You can\n specify up to 10 alarms.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the CloudWatch alarm specification to use in an instance refresh.

" + } }, - { - "target": "com.amazonaws.autoscaling#DescribeInstanceRefreshes" + "com.amazonaws.autoscaling#Alarms": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#Alarm" + } }, - { - "target": "com.amazonaws.autoscaling#DescribeLaunchConfigurations" + "com.amazonaws.autoscaling#AllowedInstanceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\.\\*\\-]+$" + } }, - { - "target": "com.amazonaws.autoscaling#DescribeLifecycleHooks" + "com.amazonaws.autoscaling#AllowedInstanceTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#AllowedInstanceType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 400 + } + } }, - { - "target": "com.amazonaws.autoscaling#DescribeLifecycleHookTypes" + "com.amazonaws.autoscaling#AlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You already have an Auto Scaling group or launch configuration with this name.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.autoscaling#DescribeLoadBalancers" + "com.amazonaws.autoscaling#AnyPrintableAsciiStringMaxLen4000": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4000 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007e]+$" + } }, - { - "target": "com.amazonaws.autoscaling#DescribeLoadBalancerTargetGroups" + "com.amazonaws.autoscaling#AsciiStringMaxLen255": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z0-9\\-_\\/]+$" + } }, - { - "target": "com.amazonaws.autoscaling#DescribeMetricCollectionTypes" + "com.amazonaws.autoscaling#AssociatePublicIpAddress": { + "type": "boolean" }, - { - "target": "com.amazonaws.autoscaling#DescribeNotificationConfigurations" + "com.amazonaws.autoscaling#AttachInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#AttachInstancesQuery" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + }, + { + "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches one or more EC2 instances to the specified Auto Scaling group.

\n

When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the\n number of instances being attached. If the number of instances being attached plus the\n desired capacity of the group exceeds the maximum size of the group, the operation\n fails.

\n

If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are\n also registered with the load balancer. If there are target groups attached to your Auto Scaling\n group, the instances are also registered with the target groups.

\n

For more information, see Detach\n or attach instances in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To attach an instance to an Auto Scaling group", + "documentation": "This example attaches the specified instance to the specified Auto Scaling group.", + "input": { + "InstanceIds": [ + "i-93633f9b" + ], + "AutoScalingGroupName": "my-auto-scaling-group" + } + } + ] + } }, - { - "target": "com.amazonaws.autoscaling#DescribePolicies" + "com.amazonaws.autoscaling#AttachInstancesQuery": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.autoscaling#InstanceIds", + "traits": { + "smithy.api#documentation": "

The IDs of the instances. You can specify up to 20 instances.

" + } + }, + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.autoscaling#DescribeScalingActivities" + "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroupsType" + }, + "output": { + "target": "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroupsResultType" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + }, + { + "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" + } + ], + "traits": { + "smithy.api#documentation": "\n

This API operation is superseded by AttachTrafficSources, which\n can attach multiple traffic sources types. We recommend using\n AttachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support AttachLoadBalancerTargetGroups. You can\n use both the original AttachLoadBalancerTargetGroups API operation and\n AttachTrafficSources on the same Auto Scaling group.

\n \n

Attaches one or more target groups to the specified Auto Scaling group.

\n

This operation is used with the following load balancer types:

\n \n

To describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from\n the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.

\n

This operation is additive and does not detach existing target groups or Classic Load\n Balancers from the Auto Scaling group.

\n

For more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To attach a target group to an Auto Scaling group", + "documentation": "This example attaches the specified target group to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "TargetGroupARNs": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + ] + } + } + ] + } }, - { - "target": "com.amazonaws.autoscaling#DescribeScalingProcessTypes" + "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroupsResultType": { + "type": "structure", + "members": {} + }, + "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroupsType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "TargetGroupARNs": { + "target": "com.amazonaws.autoscaling#TargetGroupARNs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the target groups. You can specify up to 10 target\n groups. To get the ARN of a target group, use the Elastic Load Balancing DescribeTargetGroups API operation.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.autoscaling#DescribeScheduledActions" - }, - { - "target": "com.amazonaws.autoscaling#DescribeTags" - }, - { - "target": "com.amazonaws.autoscaling#DescribeTerminationPolicyTypes" - }, - { - "target": "com.amazonaws.autoscaling#DescribeTrafficSources" - }, - { - "target": "com.amazonaws.autoscaling#DescribeWarmPool" - }, - { - "target": "com.amazonaws.autoscaling#DetachInstances" - }, - { - "target": "com.amazonaws.autoscaling#DetachLoadBalancers" - }, - { - "target": "com.amazonaws.autoscaling#DetachLoadBalancerTargetGroups" - }, - { - "target": "com.amazonaws.autoscaling#DetachTrafficSources" - }, - { - "target": "com.amazonaws.autoscaling#DisableMetricsCollection" - }, - { - "target": "com.amazonaws.autoscaling#EnableMetricsCollection" - }, - { - "target": "com.amazonaws.autoscaling#EnterStandby" - }, - { - "target": "com.amazonaws.autoscaling#ExecutePolicy" - }, - { - "target": "com.amazonaws.autoscaling#ExitStandby" - }, - { - "target": "com.amazonaws.autoscaling#GetPredictiveScalingForecast" - }, - { - "target": "com.amazonaws.autoscaling#PutLifecycleHook" - }, - { - "target": "com.amazonaws.autoscaling#PutNotificationConfiguration" + "com.amazonaws.autoscaling#AttachLoadBalancers": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#AttachLoadBalancersType" + }, + "output": { + "target": "com.amazonaws.autoscaling#AttachLoadBalancersResultType" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + }, + { + "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" + } + ], + "traits": { + "smithy.api#documentation": "\n

This API operation is superseded by AttachTrafficSources, which\n can attach multiple traffic sources types. We recommend using\n AttachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support AttachLoadBalancers. You can use both\n the original AttachLoadBalancers API operation and\n AttachTrafficSources on the same Auto Scaling group.

\n \n

Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the\n running instances with these Classic Load Balancers.

\n

To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach a load balancer from the Auto Scaling\n group, call the DetachLoadBalancers API.

\n

This operation is additive and does not detach existing Classic Load Balancers or\n target groups from the Auto Scaling group.

\n

For more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To attach a load balancer to an Auto Scaling group", + "documentation": "This example attaches the specified load balancer to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LoadBalancerNames": [ + "my-load-balancer" + ] + } + } + ] + } }, - { - "target": "com.amazonaws.autoscaling#PutScalingPolicy" + "com.amazonaws.autoscaling#AttachLoadBalancersResultType": { + "type": "structure", + "members": {} + }, + "com.amazonaws.autoscaling#AttachLoadBalancersType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "LoadBalancerNames": { + "target": "com.amazonaws.autoscaling#LoadBalancerNames", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The names of the load balancers. You can specify up to 10 load balancers.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.autoscaling#PutScheduledUpdateGroupAction" + "com.amazonaws.autoscaling#AttachTrafficSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#AttachTrafficSourcesType" + }, + "output": { + "target": "com.amazonaws.autoscaling#AttachTrafficSourcesResultType" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + }, + { + "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches one or more traffic sources to the specified Auto Scaling group.

\n

You can use any of the following as traffic sources for an Auto Scaling group:

\n \n

This operation is additive and does not detach existing traffic sources from the Auto Scaling\n group.

\n

After the operation completes, use the DescribeTrafficSources API to\n return details about the state of the attachments between traffic sources and your Auto Scaling\n group. To detach a traffic source from the Auto Scaling group, call the DetachTrafficSources API.

", + "smithy.api#examples": [ + { + "title": "To attach a target group to an Auto Scaling group", + "documentation": "This example attaches the specified target group to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "TrafficSources": [ + { + "Identifier": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + } + ] + }, + "output": {} + } + ] + } }, - { - "target": "com.amazonaws.autoscaling#PutWarmPool" + "com.amazonaws.autoscaling#AttachTrafficSourcesResultType": { + "type": "structure", + "members": {} + }, + "com.amazonaws.autoscaling#AttachTrafficSourcesType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "TrafficSources": { + "target": "com.amazonaws.autoscaling#TrafficSources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifiers of one or more traffic sources. You can specify up to 10\n traffic sources.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.autoscaling#RecordLifecycleActionHeartbeat" + "com.amazonaws.autoscaling#AutoRollback": { + "type": "boolean" + }, + "com.amazonaws.autoscaling#AutoScalingGroup": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "AutoScalingGroupARN": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Auto Scaling group.

" + } + }, + "LaunchConfigurationName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the associated launch configuration.

" + } + }, + "LaunchTemplate": { + "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", + "traits": { + "smithy.api#documentation": "

The launch template for the group.

" + } + }, + "MixedInstancesPolicy": { + "target": "com.amazonaws.autoscaling#MixedInstancesPolicy", + "traits": { + "smithy.api#documentation": "

The mixed instances policy for the group.

" + } + }, + "MinSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The minimum size of the group.

", + "smithy.api#required": {} + } + }, + "MaxSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The maximum size of the group.

", + "smithy.api#required": {} + } + }, + "DesiredCapacity": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The desired size of the group.

", + "smithy.api#required": {} + } + }, + "PredictedCapacity": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupPredictedCapacity", + "traits": { + "smithy.api#documentation": "

The predicted capacity of the group when it has a predictive scaling policy.

" + } + }, + "DefaultCooldown": { + "target": "com.amazonaws.autoscaling#Cooldown", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The duration of the default cooldown period, in seconds.

", + "smithy.api#required": {} + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.autoscaling#AvailabilityZones", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

One or more Availability Zones for the group.

", + "smithy.api#required": {} + } + }, + "LoadBalancerNames": { + "target": "com.amazonaws.autoscaling#LoadBalancerNames", + "traits": { + "smithy.api#documentation": "

One or more load balancers associated with the group.

" + } + }, + "TargetGroupARNs": { + "target": "com.amazonaws.autoscaling#TargetGroupARNs", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the target groups for your load balancer.

" + } + }, + "HealthCheckType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A comma-separated value string of one or more health check types.

", + "smithy.api#required": {} + } + }, + "HealthCheckGracePeriod": { + "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", + "traits": { + "smithy.api#documentation": "

The duration of the health check grace period, in seconds.

" + } + }, + "Instances": { + "target": "com.amazonaws.autoscaling#Instances", + "traits": { + "smithy.api#documentation": "

The EC2 instances associated with the group.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.autoscaling#TimestampType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The date and time the group was created.

", + "smithy.api#required": {} + } + }, + "SuspendedProcesses": { + "target": "com.amazonaws.autoscaling#SuspendedProcesses", + "traits": { + "smithy.api#documentation": "

The suspended processes associated with the group.

" + } + }, + "PlacementGroup": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the placement group into which to launch your instances, if any.

" + } + }, + "VPCZoneIdentifier": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen5000", + "traits": { + "smithy.api#documentation": "

One or more subnet IDs, if applicable, separated by commas.

" + } + }, + "EnabledMetrics": { + "target": "com.amazonaws.autoscaling#EnabledMetrics", + "traits": { + "smithy.api#documentation": "

The metrics enabled for the group.

" + } + }, + "Status": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The current state of the group when the DeleteAutoScalingGroup\n operation is in progress.

" + } + }, + "Tags": { + "target": "com.amazonaws.autoscaling#TagDescriptionList", + "traits": { + "smithy.api#documentation": "

The tags for the group.

" + } + }, + "TerminationPolicies": { + "target": "com.amazonaws.autoscaling#TerminationPolicies", + "traits": { + "smithy.api#documentation": "

The termination policies for the group.

" + } + }, + "NewInstancesProtectedFromScaleIn": { + "target": "com.amazonaws.autoscaling#InstanceProtected", + "traits": { + "smithy.api#documentation": "

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in.

" + } + }, + "ServiceLinkedRoleARN": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other Amazon Web Services on your behalf.

" + } + }, + "MaxInstanceLifetime": { + "target": "com.amazonaws.autoscaling#MaxInstanceLifetime", + "traits": { + "smithy.api#documentation": "

The maximum amount of time, in seconds, that an instance can be in service.

\n

Valid Range: Minimum value of 0.

" + } + }, + "CapacityRebalance": { + "target": "com.amazonaws.autoscaling#CapacityRebalanceEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether Capacity Rebalancing is enabled.

" + } + }, + "WarmPoolConfiguration": { + "target": "com.amazonaws.autoscaling#WarmPoolConfiguration", + "traits": { + "smithy.api#documentation": "

The warm pool for the group.

" + } + }, + "WarmPoolSize": { + "target": "com.amazonaws.autoscaling#WarmPoolSize", + "traits": { + "smithy.api#documentation": "

The current size of the warm pool.

" + } + }, + "Context": { + "target": "com.amazonaws.autoscaling#Context", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } + }, + "DesiredCapacityType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only.

" + } + }, + "DefaultInstanceWarmup": { + "target": "com.amazonaws.autoscaling#DefaultInstanceWarmup", + "traits": { + "smithy.api#documentation": "

The duration of the default instance warmup, in seconds.

" + } + }, + "TrafficSources": { + "target": "com.amazonaws.autoscaling#TrafficSources", + "traits": { + "smithy.api#documentation": "

The traffic sources associated with this Auto Scaling group.

" + } + }, + "InstanceMaintenancePolicy": { + "target": "com.amazonaws.autoscaling#InstanceMaintenancePolicy", + "traits": { + "smithy.api#documentation": "

An instance maintenance policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an Auto Scaling group.

" + } }, - { - "target": "com.amazonaws.autoscaling#ResumeProcesses" + "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity": { + "type": "integer" }, - { - "target": "com.amazonaws.autoscaling#RollbackInstanceRefresh" + "com.amazonaws.autoscaling#AutoScalingGroupMaxSize": { + "type": "integer" }, - { - "target": "com.amazonaws.autoscaling#SetDesiredCapacity" + "com.amazonaws.autoscaling#AutoScalingGroupMinSize": { + "type": "integer" }, - { - "target": "com.amazonaws.autoscaling#SetInstanceHealth" + "com.amazonaws.autoscaling#AutoScalingGroupNames": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" + } }, - { - "target": "com.amazonaws.autoscaling#SetInstanceProtection" + "com.amazonaws.autoscaling#AutoScalingGroupNamesType": { + "type": "structure", + "members": { + "AutoScalingGroupNames": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupNames", + "traits": { + "smithy.api#documentation": "

The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can\n optionally increase this limit using the MaxRecords property.

\n

If you omit this property, all Auto Scaling groups are described.

" + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.autoscaling#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.

" + } + }, + "Filters": { + "target": "com.amazonaws.autoscaling#Filters", + "traits": { + "smithy.api#documentation": "

One or more filters to limit the results based on specific tags.\n

" + } + } + } }, - { - "target": "com.amazonaws.autoscaling#StartInstanceRefresh" + "com.amazonaws.autoscaling#AutoScalingGroupPredictedCapacity": { + "type": "integer" }, - { - "target": "com.amazonaws.autoscaling#SuspendProcesses" + "com.amazonaws.autoscaling#AutoScalingGroupState": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } }, - { - "target": "com.amazonaws.autoscaling#TerminateInstanceInAutoScalingGroup" + "com.amazonaws.autoscaling#AutoScalingGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#AutoScalingGroup" + } }, - { - "target": "com.amazonaws.autoscaling#UpdateAutoScalingGroup" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "Auto Scaling", - "arnNamespace": "autoscaling", - "cloudFormationName": "AutoScaling", - "cloudTrailEventSource": "autoscaling.amazonaws.com", - "docId": "autoscaling-2011-01-01", - "endpointPrefix": "autoscaling" - }, - "aws.auth#sigv4": { - "name": "autoscaling" - }, - "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "Amazon EC2 Auto Scaling\n

Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances\n based on user-defined scaling policies, scheduled actions, and health checks.

\n

For more information, see the Amazon EC2 Auto Scaling User Guide and the Amazon EC2 Auto Scaling API Reference.

", - "smithy.api#title": "Auto Scaling", - "smithy.api#xmlNamespace": { - "uri": "http://autoscaling.amazonaws.com/doc/2011-01-01/" - }, - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" + "com.amazonaws.autoscaling#AutoScalingGroupsType": { + "type": "structure", + "members": { + "AutoScalingGroups": { + "target": "com.amazonaws.autoscaling#AutoScalingGroups", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The groups.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" } - ] } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] + } + }, + "com.amazonaws.autoscaling#AutoScalingInstanceDetails": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "InstanceType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The instance type of the EC2 instance.

" } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group for the instance.

", + "smithy.api#required": {} } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" + }, + "AvailabilityZone": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Availability Zone for the instance.

", + "smithy.api#required": {} } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://autoscaling-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-us-gov" - ] - } - ], - "endpoint": { - "url": "https://autoscaling.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://autoscaling-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://autoscaling.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://autoscaling.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + }, + "LifecycleState": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The lifecycle state for the instance. The Quarantined state is not used.\n For more information, see Amazon EC2 Auto Scaling instance\n lifecycle in the Amazon EC2 Auto Scaling User Guide.

\n

Valid values: Pending | Pending:Wait |\n Pending:Proceed | Quarantined | InService |\n Terminating | Terminating:Wait |\n Terminating:Proceed | Terminated | Detaching\n | Detached | EnteringStandby | Standby |\n Warmed:Pending | Warmed:Pending:Wait |\n Warmed:Pending:Proceed | Warmed:Terminating |\n Warmed:Terminating:Wait | Warmed:Terminating:Proceed |\n Warmed:Terminated | Warmed:Stopped |\n Warmed:Running\n

", + "smithy.api#required": {} + } + }, + "HealthStatus": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The last reported health status of this instance. Healthy means that the\n instance is healthy and should remain in service. Unhealthy means that the\n instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.

", + "smithy.api#required": {} + } + }, + "LaunchConfigurationName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The launch configuration used to launch the instance. This value is not available if\n you attached the instance to the Auto Scaling group.

" + } + }, + "LaunchTemplate": { + "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", + "traits": { + "smithy.api#documentation": "

The launch template for the instance.

" + } + }, + "ProtectedFromScaleIn": { + "target": "com.amazonaws.autoscaling#InstanceProtected", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling\n in.

", + "smithy.api#required": {} + } + }, + "WeightedCapacity": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", + "traits": { + "smithy.api#documentation": "

The number of capacity units contributed by the instance based on its instance\n type.

\n

Valid Range: Minimum value of 1. Maximum value of 999.

" } - ], - "type": "tree" } - ], - "type": "tree" }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" + "traits": { + "smithy.api#documentation": "

Describes an EC2 instance associated with an Auto Scaling group.

" } - ] }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-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://autoscaling-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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling-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://autoscaling-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://autoscaling.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://autoscaling.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling-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://autoscaling.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://autoscaling-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.autoscaling#AvailabilityZones": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" - } - }, - "com.amazonaws.autoscaling#BareMetal": { - "type": "enum", - "members": { - "INCLUDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "included" - } - }, - "EXCLUDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "excluded" - } - }, - "REQUIRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "required" - } - } - } - }, - "com.amazonaws.autoscaling#BaselineEbsBandwidthMbpsRequest": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.autoscaling#NullablePositiveInteger", - "traits": { - "smithy.api#documentation": "

The minimum value in Mbps.

" - } - }, - "Max": { - "target": "com.amazonaws.autoscaling#NullablePositiveInteger", - "traits": { - "smithy.api#documentation": "

The maximum value in Mbps.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the minimum and maximum for the BaselineEbsBandwidthMbps object\n when you specify InstanceRequirements for an Auto Scaling group.

" - } - }, - "com.amazonaws.autoscaling#BatchDeleteScheduledAction": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#BatchDeleteScheduledActionType" - }, - "output": { - "target": "com.amazonaws.autoscaling#BatchDeleteScheduledActionAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes one or more scheduled actions for the specified Auto Scaling group.

" - } - }, - "com.amazonaws.autoscaling#BatchDeleteScheduledActionAnswer": { - "type": "structure", - "members": { - "FailedScheduledActions": { - "target": "com.amazonaws.autoscaling#FailedScheduledUpdateGroupActionRequests", - "traits": { - "smithy.api#documentation": "

The names of the scheduled actions that could not be deleted, including an error\n message.

" - } - } - } - }, - "com.amazonaws.autoscaling#BatchDeleteScheduledActionType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "ScheduledActionNames": { - "target": "com.amazonaws.autoscaling#ScheduledActionNames", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The names of the scheduled actions to delete. The maximum number allowed is 50.\n

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#BatchPutScheduledUpdateGroupAction": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#BatchPutScheduledUpdateGroupActionType" - }, - "output": { - "target": "com.amazonaws.autoscaling#BatchPutScheduledUpdateGroupActionAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#AlreadyExistsFault" - }, - { - "target": "com.amazonaws.autoscaling#LimitExceededFault" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates or updates one or more scheduled scaling actions for an Auto Scaling group.

" - } - }, - "com.amazonaws.autoscaling#BatchPutScheduledUpdateGroupActionAnswer": { - "type": "structure", - "members": { - "FailedScheduledUpdateGroupActions": { - "target": "com.amazonaws.autoscaling#FailedScheduledUpdateGroupActionRequests", - "traits": { - "smithy.api#documentation": "

The names of the scheduled actions that could not be created or updated, including an\n error message.

" - } - } - } - }, - "com.amazonaws.autoscaling#BatchPutScheduledUpdateGroupActionType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "ScheduledUpdateGroupActions": { - "target": "com.amazonaws.autoscaling#ScheduledUpdateGroupActionRequests", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

One or more scheduled actions. The maximum number allowed is 50.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#BlockDeviceEbsDeleteOnTermination": { - "type": "boolean" - }, - "com.amazonaws.autoscaling#BlockDeviceEbsEncrypted": { - "type": "boolean" - }, - "com.amazonaws.autoscaling#BlockDeviceEbsIops": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 100, - "max": 20000 - } - } - }, - "com.amazonaws.autoscaling#BlockDeviceEbsThroughput": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 125, - "max": 1000 - } - } - }, - "com.amazonaws.autoscaling#BlockDeviceEbsVolumeSize": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 16384 - } - } - }, - "com.amazonaws.autoscaling#BlockDeviceEbsVolumeType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.autoscaling#BlockDeviceMapping": { - "type": "structure", - "members": { - "VirtualName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the instance store volume (virtual device) to attach to an instance at\n launch. The name must be in the form ephemeralX where\n X is a number starting from zero (0), for example,\n ephemeral0.

" - } - }, - "DeviceName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The device name assigned to the volume (for example, /dev/sdh or\n xvdh). For more information, see Device naming on Linux\n instances in the Amazon EC2 User Guide for Linux Instances.

\n \n

To define a block device mapping, set the device name and exactly one of the\n following properties: Ebs, NoDevice, or\n VirtualName.

\n ", - "smithy.api#required": {} - } - }, - "Ebs": { - "target": "com.amazonaws.autoscaling#Ebs", - "traits": { - "smithy.api#documentation": "

Information to attach an EBS volume to an instance at launch.

" - } - }, - "NoDevice": { - "target": "com.amazonaws.autoscaling#NoDevice", - "traits": { - "smithy.api#documentation": "

Setting this value to true prevents a volume that is included in the\n block device mapping of the AMI from being mapped to the specified device name at\n launch.

\n

If NoDevice is true for the root device, instances might\n fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches replacement instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a block device mapping.

" - } - }, - "com.amazonaws.autoscaling#BlockDeviceMappings": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#BlockDeviceMapping" - } - }, - "com.amazonaws.autoscaling#BurstablePerformance": { - "type": "enum", - "members": { - "INCLUDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "included" - } - }, - "EXCLUDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "excluded" - } - }, - "REQUIRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "required" - } - } - } - }, - "com.amazonaws.autoscaling#CancelInstanceRefresh": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#CancelInstanceRefreshType" - }, - "output": { - "target": "com.amazonaws.autoscaling#CancelInstanceRefreshAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ActiveInstanceRefreshNotFoundFault" - }, - { - "target": "com.amazonaws.autoscaling#LimitExceededFault" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Cancels an instance refresh or rollback that is in progress. If an instance refresh or\n rollback is not in progress, an ActiveInstanceRefreshNotFound error\n occurs.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group\n after you make configuration changes.

\n

When you cancel an instance refresh, this does not roll back any changes that it made.\n Use the RollbackInstanceRefresh API to roll back instead.

", - "smithy.api#examples": [ - { - "title": "To cancel an instance refresh", - "documentation": "This example cancels an instance refresh operation in progress.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group" - }, - "output": { - "InstanceRefreshId": "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b" - } - } - ] - } - }, - "com.amazonaws.autoscaling#CancelInstanceRefreshAnswer": { - "type": "structure", - "members": { - "InstanceRefreshId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The instance refresh ID associated with the request. This is the unique ID assigned to\n the instance refresh when it was started.

" - } - } - } - }, - "com.amazonaws.autoscaling#CancelInstanceRefreshType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#CapacityForecast": { - "type": "structure", - "members": { - "Timestamps": { - "target": "com.amazonaws.autoscaling#PredictiveScalingForecastTimestamps", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The timestamps for the data points, in UTC format.

", - "smithy.api#required": {} - } - }, - "Values": { - "target": "com.amazonaws.autoscaling#PredictiveScalingForecastValues", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The values of the data points.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A GetPredictiveScalingForecast call returns the capacity forecast for a\n predictive scaling policy. This structure includes the data points for that capacity\n forecast, along with the timestamps of those data points.

" - } - }, - "com.amazonaws.autoscaling#CapacityRebalanceEnabled": { - "type": "boolean" - }, - "com.amazonaws.autoscaling#CheckpointDelay": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 172800 - } - } - }, - "com.amazonaws.autoscaling#CheckpointPercentages": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#NonZeroIntPercent" - } - }, - "com.amazonaws.autoscaling#ClassicLinkVPCSecurityGroups": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" - } - }, - "com.amazonaws.autoscaling#CompleteLifecycleAction": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#CompleteLifecycleActionType" - }, - "output": { - "target": "com.amazonaws.autoscaling#CompleteLifecycleActionAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Completes the lifecycle action for the specified token or instance with the specified\n result.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.

    \n
    2. \n
  2. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.

    \n
    3. \n
  3. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    4. \n
  4. \n

    Create the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.

    \n
    5. \n
  5. \n

    If you need more time, record the lifecycle action heartbeat to keep the\n instance in a wait state.

    \n
    6. \n
  6. \n

    \n If you finish before the timeout period ends, send a\n callback by using the CompleteLifecycleAction API\n call.\n

    \n
    7. \n
\n

For more information, see Complete a lifecycle\n action in the Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To complete the lifecycle action", - "documentation": "This example notifies Auto Scaling that the specified lifecycle action is complete so that it can finish launching or terminating the instance.", - "input": { - "LifecycleHookName": "my-lifecycle-hook", - "AutoScalingGroupName": "my-auto-scaling-group", - "LifecycleActionToken": "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635", - "LifecycleActionResult": "CONTINUE" + "com.amazonaws.autoscaling#AutoScalingInstances": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#AutoScalingInstanceDetails" } - } - ] - } - }, - "com.amazonaws.autoscaling#CompleteLifecycleActionAnswer": { - "type": "structure", - "members": {} - }, - "com.amazonaws.autoscaling#CompleteLifecycleActionType": { - "type": "structure", - "members": { - "LifecycleHookName": { - "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the lifecycle hook.

", - "smithy.api#required": {} - } - }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "LifecycleActionToken": { - "target": "com.amazonaws.autoscaling#LifecycleActionToken", - "traits": { - "smithy.api#documentation": "

A universally unique identifier (UUID) that identifies a specific lifecycle action\n associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you\n specified when you created the lifecycle hook.

" - } - }, - "LifecycleActionResult": { - "target": "com.amazonaws.autoscaling#LifecycleActionResult", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The action for the group to take. You can specify either CONTINUE or\n ABANDON.

", - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", - "traits": { - "smithy.api#documentation": "

The ID of the instance.

" - } - } - } - }, - "com.amazonaws.autoscaling#Context": { - "type": "string" - }, - "com.amazonaws.autoscaling#Cooldown": { - "type": "integer" - }, - "com.amazonaws.autoscaling#CpuManufacturer": { - "type": "enum", - "members": { - "INTEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "intel" - } - }, - "AMD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "amd" - } - }, - "AMAZON_WEB_SERVICES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "amazon-web-services" - } - } - } - }, - "com.amazonaws.autoscaling#CpuManufacturers": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#CpuManufacturer" - } - }, - "com.amazonaws.autoscaling#CreateAutoScalingGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#CreateAutoScalingGroupType" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#AlreadyExistsFault" - }, - { - "target": "com.amazonaws.autoscaling#LimitExceededFault" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - }, - { - "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" - } - ], - "traits": { - "smithy.api#documentation": "

\n We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n

\n

Creates an Auto Scaling group with the specified name and attributes.

\n

If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit,\n call the DescribeAccountLimits API. For information about updating\n this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

If you're new to Amazon EC2 Auto Scaling, see the introductory tutorials in Get started\n with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

Every Auto Scaling group has three size properties (DesiredCapacity,\n MaxSize, and MinSize). Usually, you set these sizes based\n on a specific number of instances. However, if you configure a mixed instances policy\n that defines weights for the instance types, you must specify these sizes with the same\n units that you use for weighting instances.

", - "smithy.api#examples": [ - { - "title": "To create an Auto Scaling group with an attached target group", - "documentation": "This example creates an Auto Scaling group and attaches the specified target group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "LaunchTemplate": { - "LaunchTemplateName": "my-template-for-auto-scaling", - "Version": "$Default" - }, - "MinSize": 1, - "MaxSize": 3, - "TargetGroupARNs": [ - "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" - ], - "HealthCheckType": "ELB", - "HealthCheckGracePeriod": 300, - "VPCZoneIdentifier": "subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE" - } - }, - { - "title": "To create an Auto Scaling group with a mixed instances policy", - "documentation": "This example creates an Auto Scaling group with a mixed instances policy. It specifies the c5.large, c5a.large, and c6g.large instance types and defines a different launch template for the c6g.large instance type.", - "input": { - "AutoScalingGroupName": "my-asg", - "MixedInstancesPolicy": { - "LaunchTemplate": { - "LaunchTemplateSpecification": { - "LaunchTemplateName": "my-launch-template-for-x86", - "Version": "$Default" - }, - "Overrides": [ - { - "InstanceType": "c6g.large", - "LaunchTemplateSpecification": { - "LaunchTemplateName": "my-launch-template-for-arm", - "Version": "$Default" - } - }, - { - "InstanceType": "c5.large" - }, - { - "InstanceType": "c5a.large" + }, + "com.amazonaws.autoscaling#AutoScalingInstancesType": { + "type": "structure", + "members": { + "AutoScalingInstances": { + "target": "com.amazonaws.autoscaling#AutoScalingInstances", + "traits": { + "smithy.api#documentation": "

The instances.

" } - ] }, - "InstancesDistribution": { - "OnDemandBaseCapacity": 1, - "OnDemandPercentageAboveBaseCapacity": 50, - "SpotAllocationStrategy": "price-capacity-optimized" - } - }, - "MinSize": 1, - "MaxSize": 5, - "DesiredCapacity": 3, - "VPCZoneIdentifier": "subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE" - } - }, - { - "title": "To create an Auto Scaling group using attribute-based instance type selection", - "documentation": "This example creates an Auto Scaling group using attribute-based instance type selection. It requires the instance types to have a minimum of four vCPUs and a maximum of eight vCPUs, a minimum of 16,384 MiB of memory, and an Intel manufactured CPU.", - "input": { - "AutoScalingGroupName": "my-asg", - "MixedInstancesPolicy": { - "LaunchTemplate": { - "LaunchTemplateSpecification": { - "LaunchTemplateName": "my-template-for-auto-scaling", - "Version": "$Default" - }, - "Overrides": [ - { - "InstanceRequirements": { - "VCpuCount": { - "Min": 4, - "Max": 8 - }, - "MemoryMiB": { - "Min": 16384 - }, - "CpuManufacturers": ["intel"] - } + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" } - ] - }, - "InstancesDistribution": { - "OnDemandPercentageAboveBaseCapacity": 50, - "SpotAllocationStrategy": "price-capacity-optimized" - } - }, - "MinSize": 0, - "MaxSize": 100, - "DesiredCapacity": 4, - "DesiredCapacityType": "units", - "VPCZoneIdentifier": "subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE" - } - }, - { - "title": "To create an Auto Scaling group", - "documentation": "This example creates an Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "LaunchTemplate": { - "LaunchTemplateName": "my-template-for-auto-scaling", - "Version": "$Default" - }, - "MinSize": 1, - "MaxSize": 3, - "MaxInstanceLifetime": 2592000, - "DefaultInstanceWarmup": 120, - "VPCZoneIdentifier": "subnet-057fa0918fEXAMPLE" - } - } - ] - } - }, - "com.amazonaws.autoscaling#CreateAutoScalingGroupType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group. This name must be unique per Region per account.

\n

The name can contain any ASCII character 33 to 126 including most punctuation\n characters, digits, and upper and lowercased letters.

\n \n

You cannot use a colon (:) in the name.

\n ", - "smithy.api#required": {} - } - }, - "LaunchConfigurationName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the launch configuration to use to launch instances.

\n

Conditional: You must specify either a launch template (LaunchTemplate or\n MixedInstancesPolicy) or a launch configuration\n (LaunchConfigurationName or InstanceId).

" - } - }, - "LaunchTemplate": { - "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", - "traits": { - "smithy.api#documentation": "

Information used to specify the launch template and version to use to launch\n instances.

\n

Conditional: You must specify either a launch template (LaunchTemplate or\n MixedInstancesPolicy) or a launch configuration\n (LaunchConfigurationName or InstanceId).

\n \n

The launch template that is specified must be configured for use with an Auto Scaling\n group. For more information, see Create a launch\n template for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n " - } - }, - "MixedInstancesPolicy": { - "target": "com.amazonaws.autoscaling#MixedInstancesPolicy", - "traits": { - "smithy.api#documentation": "

The mixed instances policy. For more information, see Auto Scaling\n groups with multiple instance types and purchase options in the\n Amazon EC2 Auto Scaling User Guide.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", - "traits": { - "smithy.api#documentation": "

The ID of the instance used to base the launch configuration on. If specified, Amazon\n EC2 Auto Scaling uses the configuration values from the specified instance to create a\n new launch configuration. To get the instance ID, use the Amazon EC2 DescribeInstances API operation. For more information, see Create an Auto Scaling group using parameters from an existing instance in the\n Amazon EC2 Auto Scaling User Guide.

" - } - }, - "MinSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The minimum size of the group.

", - "smithy.api#required": {} - } - }, - "MaxSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The maximum size of the group.

\n \n

With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to\n go above MaxSize to meet your capacity requirements. In this event,\n Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance\n weight (weights that define how many units each instance contributes to the desired\n capacity of the group).

\n ", - "smithy.api#required": {} - } - }, - "DesiredCapacity": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", - "traits": { - "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group at the time of its\n creation and the capacity it attempts to maintain. It can scale beyond this capacity if\n you configure auto scaling. This number must be greater than or equal to the minimum\n size of the group and less than or equal to the maximum size of the group. If you do not\n specify a desired capacity, the default is the minimum size of the group.

" - } - }, - "DefaultCooldown": { - "target": "com.amazonaws.autoscaling#Cooldown", - "traits": { - "smithy.api#documentation": "

\n Only needed if you use simple scaling policies.\n

\n

The amount of time, in seconds, between one scaling activity ending and another one\n starting due to simple scaling policies. For more information, see Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

Default: 300 seconds

" - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.autoscaling#AvailabilityZones", - "traits": { - "smithy.api#documentation": "

A list of Availability Zones where instances in the Auto Scaling group can be created. Used\n for launching into the default VPC subnet in each Availability Zone when not using the\n VPCZoneIdentifier property, or for attaching a network interface when\n an existing network interface ID is specified in a launch template.

" - } - }, - "LoadBalancerNames": { - "target": "com.amazonaws.autoscaling#LoadBalancerNames", - "traits": { - "smithy.api#documentation": "

A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers,\n specify the TargetGroupARNs property instead.

" - } - }, - "TargetGroupARNs": { - "target": "com.amazonaws.autoscaling#TargetGroupARNs", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling\n group. Instances are registered as targets with the target groups. The target groups\n receive incoming traffic and route requests to one or more registered targets. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

" - } - }, - "HealthCheckType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", - "traits": { - "smithy.api#documentation": "

A comma-separated value string of one or more health check types.

\n

The valid values are EC2, ELB, and VPC_LATTICE.\n EC2 is the default health check and cannot be disabled. For more\n information, see Health checks\n for instances in an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n

Only specify EC2 if you must clear a value that was previously\n set.

" - } - }, - "HealthCheckGracePeriod": { - "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", - "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n health check. This is useful if your instances do not immediately pass their health\n checks after they enter the InService state. For more information, see\n Set the health check\n grace period for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n

Default: 0 seconds

" - } - }, - "PlacementGroup": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the placement group into which to launch your instances. For more\n information, see Placement groups in the\n Amazon EC2 User Guide for Linux Instances.

\n \n

A cluster placement group is a logical grouping of instances\n within a single Availability Zone. You cannot specify multiple Availability Zones\n and a cluster placement group.

\n " - } - }, - "VPCZoneIdentifier": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen5000", - "traits": { - "smithy.api#documentation": "

A comma-separated list of subnet IDs for a virtual private cloud (VPC) where instances\n in the Auto Scaling group can be created. If you specify VPCZoneIdentifier with\n AvailabilityZones, the subnets that you specify must reside in those\n Availability Zones.

" - } - }, - "TerminationPolicies": { - "target": "com.amazonaws.autoscaling#TerminationPolicies", - "traits": { - "smithy.api#documentation": "

A policy or a list of policies that are used to select the instance to terminate.\n These policies are executed in the order that you list them. For more information, see\n Configure\n termination policies for Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.

\n

Valid values: Default | AllocationStrategy |\n ClosestToNextInstanceHour | NewestInstance |\n OldestInstance | OldestLaunchConfiguration |\n OldestLaunchTemplate |\n arn:aws:lambda:region:account-id:function:my-function:my-alias\n

" - } - }, - "NewInstancesProtectedFromScaleIn": { - "target": "com.amazonaws.autoscaling#InstanceProtected", - "traits": { - "smithy.api#documentation": "

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in. For more information about preventing instances from terminating on\n scale in, see Use\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.

" - } - }, - "CapacityRebalance": { - "target": "com.amazonaws.autoscaling#CapacityRebalanceEnabled", - "traits": { - "smithy.api#documentation": "

Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is\n disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot\n Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of\n interruption. After launching a new instance, it then terminates an old instance. For\n more information, see Use Capacity\n Rebalancing to handle Amazon EC2 Spot Interruptions in the in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "LifecycleHookSpecificationList": { - "target": "com.amazonaws.autoscaling#LifecycleHookSpecifications", - "traits": { - "smithy.api#documentation": "

One or more lifecycle hooks to add to the Auto Scaling group before instances are\n launched.

" - } - }, - "Tags": { - "target": "com.amazonaws.autoscaling#Tags", - "traits": { - "smithy.api#documentation": "

One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2\n instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS\n volumes, specify the tags in a launch template but use caution. If the launch template\n specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling\n overrides the value of that instance tag with the value specified by the Auto Scaling group. For\n more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "ServiceLinkedRoleARN": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other Amazon Web Services service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role\n named AWSServiceRoleForAutoScaling, which it creates if it does not exist.\n For more information, see Service-linked\n roles in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "MaxInstanceLifetime": { - "target": "com.amazonaws.autoscaling#MaxInstanceLifetime", - "traits": { - "smithy.api#documentation": "

The maximum amount of time, in seconds, that an instance can be in service. The\n default is null. If specified, the value must be either 0 or a number equal to or\n greater than 86,400 seconds (1 day). For more information, see Replace Auto Scaling instances based on maximum instance lifetime in the\n Amazon EC2 Auto Scaling User Guide.

" - } - }, - "Context": { - "target": "com.amazonaws.autoscaling#Context", - "traits": { - "smithy.api#documentation": "

Reserved.

" - } - }, - "DesiredCapacityType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only. For more information, see Create a mixed instances group using attribute-based instance type\n selection in the Amazon EC2 Auto Scaling User Guide.

\n

By default, Amazon EC2 Auto Scaling specifies units, which translates into number of\n instances.

\n

Valid values: units | vcpu | memory-mib\n

" - } - }, - "DefaultInstanceWarmup": { - "target": "com.amazonaws.autoscaling#DefaultInstanceWarmup", - "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, until a new instance is considered to have finished\n initializing and resource consumption to become stable after it enters the\n InService state.

\n

During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an\n instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the\n warm-up period before aggregating the metrics for new instances with existing instances\n in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage\n data. For more information, see Set\n the default instance warmup for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n \n

To manage various warm-up settings at the group level, we recommend that you set\n the default instance warmup, even if it is set to 0 seconds. To\n remove a value that you previously set, include the property but specify\n -1 for the value. However, we strongly recommend keeping the\n default instance warmup enabled by specifying a value of 0 or other\n nominal value.

\n \n

Default: None

" - } - }, - "TrafficSources": { - "target": "com.amazonaws.autoscaling#TrafficSources", - "traits": { - "smithy.api#documentation": "

The list of traffic sources to attach to this Auto Scaling group. You can use any of the\n following as traffic sources for an Auto Scaling group: Classic Load Balancer, Application Load Balancer, Gateway Load Balancer, Network Load Balancer, and\n VPC Lattice.

" - } - }, - "InstanceMaintenancePolicy": { - "target": "com.amazonaws.autoscaling#InstanceMaintenancePolicy", - "traits": { - "smithy.api#documentation": "

An instance maintenance policy. For more information, see Set instance maintenance policy in the\n Amazon EC2 Auto Scaling User Guide.

" - } - } - } - }, - "com.amazonaws.autoscaling#CreateLaunchConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#CreateLaunchConfigurationType" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#AlreadyExistsFault" - }, - { - "target": "com.amazonaws.autoscaling#LimitExceededFault" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a launch configuration.

\n

If you exceed your maximum limit of launch configurations, the call fails. To query\n this limit, call the DescribeAccountLimits API. For information about\n updating this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

For more information, see Launch\n configurations in the Amazon EC2 Auto Scaling User Guide.

\n \n

Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a\n launch template or a launch configuration. We strongly recommend that you do not use\n launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2.\n For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.

\n ", - "smithy.api#examples": [ - { - "title": "To create a launch configuration", - "documentation": "This example creates a launch configuration.", - "input": { - "LaunchConfigurationName": "my-launch-config", - "ImageId": "ami-12345678", - "SecurityGroups": ["sg-eb2af88e"], - "InstanceType": "m3.medium", - "IamInstanceProfile": "my-iam-role" + } } - } - ] - } - }, - "com.amazonaws.autoscaling#CreateLaunchConfigurationType": { - "type": "structure", - "members": { - "LaunchConfigurationName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the launch configuration. This name must be unique per Region per\n account.

", - "smithy.api#required": {} - } - }, - "ImageId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) that was assigned during registration. For\n more information, see Find a Linux AMI in the\n Amazon EC2 User Guide for Linux Instances.

\n

If you specify InstanceId, an ImageId is not\n required.

" - } - }, - "KeyName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the key pair. For more information, see Amazon EC2 key pairs and Amazon EC2\n instances in the Amazon EC2 User Guide for Linux Instances.

" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.autoscaling#SecurityGroups", - "traits": { - "smithy.api#documentation": "

A list that contains the security group IDs to assign to the instances in the Auto Scaling\n group. For more information, see Control traffic to your Amazon Web Services\n resources using security groups in the Amazon Virtual Private\n Cloud User Guide.

" - } - }, - "ClassicLinkVPCId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

Available for backward compatibility.

" - } - }, - "ClassicLinkVPCSecurityGroups": { - "target": "com.amazonaws.autoscaling#ClassicLinkVPCSecurityGroups", - "traits": { - "smithy.api#documentation": "

Available for backward compatibility.

" - } - }, - "UserData": { - "target": "com.amazonaws.autoscaling#XmlStringUserData", - "traits": { - "smithy.api#documentation": "

The user data to make available to the launched EC2 instances. For more information,\n see Instance metadata and user data (Linux) and Instance metadata and\n user data (Windows). If you are using a command line tool, base64-encoding\n is performed for you, and you can load the text from a file. Otherwise, you must provide\n base64-encoded text. User data is limited to 16 KB.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", - "traits": { - "smithy.api#documentation": "

The ID of the instance to use to create the launch configuration. The new launch\n configuration derives attributes from the instance, except for the block device\n mapping.

\n

To create a launch configuration with a block device mapping or override any other\n instance attributes, specify them as part of the same request.

\n

For more information, see Create a launch\n configuration in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "InstanceType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

Specifies the instance type of the EC2 instance. For information about available\n instance types, see Available\n instance types in the Amazon EC2 User Guide for Linux Instances.

\n

If you specify InstanceId, an InstanceType is not\n required.

" - } - }, - "KernelId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The ID of the kernel associated with the AMI.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide for Linux Instances.

\n " - } - }, - "RamdiskId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The ID of the RAM disk to select.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide for Linux Instances.

\n " - } - }, - "BlockDeviceMappings": { - "target": "com.amazonaws.autoscaling#BlockDeviceMappings", - "traits": { - "smithy.api#documentation": "

The block device mapping entries that define the block devices to attach to the\n instances at launch. By default, the block devices specified in the block device mapping\n for the AMI are used. For more information, see Block device\n mappings in the Amazon EC2 User Guide for Linux Instances.

" - } - }, - "InstanceMonitoring": { - "target": "com.amazonaws.autoscaling#InstanceMonitoring", - "traits": { - "smithy.api#documentation": "

Controls whether instances in this group are launched with detailed\n (true) or basic (false) monitoring.

\n

The default value is true (enabled).

\n \n

When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and\n your account is charged a fee. When you disable detailed monitoring, CloudWatch generates\n metrics every 5 minutes. For more information, see Configure\n monitoring for Auto Scaling instances in the\n Amazon EC2 Auto Scaling User Guide.

\n " - } - }, - "SpotPrice": { - "target": "com.amazonaws.autoscaling#SpotPrice", - "traits": { - "smithy.api#documentation": "

The maximum hourly price to be paid for any Spot Instance launched to fulfill the\n request. Spot Instances are launched when the price you specify exceeds the current Spot\n price. For more information, see Request Spot\n Instances for fault-tolerant and flexible applications in the\n Amazon EC2 Auto Scaling User Guide.

\n

Valid Range: Minimum value of 0.001

\n \n

When you change your maximum price by creating a new launch configuration, running\n instances will continue to run as long as the maximum price for those running\n instances is higher than the current Spot price.

\n " - } - }, - "IamInstanceProfile": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen1600", - "traits": { - "smithy.api#documentation": "

The name or the Amazon Resource Name (ARN) of the instance profile associated with the\n IAM role for the instance. The instance profile contains the IAM role. For more\n information, see IAM role for applications that run\n on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "EbsOptimized": { - "target": "com.amazonaws.autoscaling#EbsOptimized", - "traits": { - "smithy.api#documentation": "

Specifies whether the launch configuration is optimized for EBS I/O\n (true) or not (false). The optimization provides dedicated\n throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O\n performance. This optimization is not available with all instance types. Additional fees\n are incurred when you enable EBS optimization for an instance type that is not\n EBS-optimized by default. For more information, see Amazon EBS-optimized instances\n in the Amazon EC2 User Guide for Linux Instances.

\n

The default value is false.

" - } - }, - "AssociatePublicIpAddress": { - "target": "com.amazonaws.autoscaling#AssociatePublicIpAddress", - "traits": { - "smithy.api#documentation": "

Specifies whether to assign a public IPv4 address to the group's instances. If the\n instance is launched into a default subnet, the default is to assign a public IPv4\n address, unless you disabled the option to assign a public IPv4 address on the subnet.\n If the instance is launched into a nondefault subnet, the default is not to assign a\n public IPv4 address, unless you enabled the option to assign a public IPv4 address on\n the subnet.

\n

If you specify true, each instance in the Auto Scaling group receives a unique\n public IPv4 address. For more information, see Provide network connectivity for\n your Auto Scaling instances using Amazon VPC in the\n Amazon EC2 Auto Scaling User Guide.

\n

If you specify this property, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.

" - } - }, - "PlacementTenancy": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", - "traits": { - "smithy.api#documentation": "

The tenancy of the instance, either default or dedicated. An\n instance with dedicated tenancy runs on isolated, single-tenant hardware\n and can only be launched into a VPC. To launch dedicated instances into a shared tenancy\n VPC (a VPC with the instance placement tenancy attribute set to default),\n you must set the value of this property to dedicated.

\n

If you specify PlacementTenancy, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.

\n

Valid values: default | dedicated\n

" - } - }, - "MetadataOptions": { - "target": "com.amazonaws.autoscaling#InstanceMetadataOptions", - "traits": { - "smithy.api#documentation": "

The metadata options for the instances. For more information, see Configure the instance metadata options in the\n Amazon EC2 Auto Scaling User Guide.

" - } - } - } - }, - "com.amazonaws.autoscaling#CreateOrUpdateTags": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#CreateOrUpdateTagsType" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#AlreadyExistsFault" - }, - { - "target": "com.amazonaws.autoscaling#LimitExceededFault" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - }, - { - "target": "com.amazonaws.autoscaling#ResourceInUseFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates or updates tags for the specified Auto Scaling group.

\n

When you specify a tag with a key that already exists, the operation overwrites the\n previous tag definition, and you do not get an error message.

\n

For more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To create or update tags for an Auto Scaling group", - "documentation": "This example adds two tags to the specified Auto Scaling group.", - "input": { - "Tags": [ + }, + "com.amazonaws.autoscaling#AutoScalingNotificationTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" + } + }, + "com.amazonaws.autoscaling#AutoScaling_2011_01_01": { + "type": "service", + "version": "2011-01-01", + "operations": [ { - "ResourceId": "my-auto-scaling-group", - "ResourceType": "auto-scaling-group", - "Key": "Role", - "Value": "WebServer", - "PropagateAtLaunch": true + "target": "com.amazonaws.autoscaling#AttachInstances" }, { - "ResourceId": "my-auto-scaling-group", - "ResourceType": "auto-scaling-group", - "Key": "Dept", - "Value": "Research", - "PropagateAtLaunch": true - } - ] - } - } - ] - } - }, - "com.amazonaws.autoscaling#CreateOrUpdateTagsType": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.autoscaling#Tags", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

One or more tags.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#CustomizedMetricSpecification": { - "type": "structure", - "members": { - "MetricName": { - "target": "com.amazonaws.autoscaling#MetricName", - "traits": { - "smithy.api#documentation": "

The name of the metric. To get the exact metric name, namespace, and dimensions,\n inspect the Metric object\n that is returned by a call to ListMetrics.

" - } - }, - "Namespace": { - "target": "com.amazonaws.autoscaling#MetricNamespace", - "traits": { - "smithy.api#documentation": "

The namespace of the metric.

" - } - }, - "Dimensions": { - "target": "com.amazonaws.autoscaling#MetricDimensions", - "traits": { - "smithy.api#documentation": "

The dimensions of the metric.

\n

Conditional: If you published your metric with dimensions, you must specify the same\n dimensions in your scaling policy.

" - } - }, - "Statistic": { - "target": "com.amazonaws.autoscaling#MetricStatistic", - "traits": { - "smithy.api#documentation": "

The statistic of the metric.

" - } - }, - "Unit": { - "target": "com.amazonaws.autoscaling#MetricUnit", - "traits": { - "smithy.api#documentation": "

The unit of the metric. For a complete list of the units that CloudWatch supports, see the\n MetricDatum\n data type in the Amazon CloudWatch API Reference.

" - } - }, - "Metrics": { - "target": "com.amazonaws.autoscaling#TargetTrackingMetricDataQueries", - "traits": { - "smithy.api#documentation": "

The metrics to include in the target tracking scaling policy, as a metric data query.\n This can include both raw metric and metric math expressions.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use\n with Amazon EC2 Auto Scaling.

\n

To create your customized metric specification:

\n \n

For more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts.

\n \n

Each individual service provides information about the metrics, namespace, and\n dimensions they use. For more information, see Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.

\n " - } - }, - "com.amazonaws.autoscaling#DefaultInstanceWarmup": { - "type": "integer" - }, - "com.amazonaws.autoscaling#DeleteAutoScalingGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DeleteAutoScalingGroupType" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - }, - { - "target": "com.amazonaws.autoscaling#ResourceInUseFault" - }, - { - "target": "com.amazonaws.autoscaling#ScalingActivityInProgressFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified Auto Scaling group.

\n

If the group has instances or scaling activities in progress, you must specify the\n option to force the deletion in order for it to succeed. The force delete operation will\n also terminate the EC2 instances. If the group has a warm pool, the force delete option\n also deletes the warm pool.

\n

To remove instances from the Auto Scaling group before deleting it, call the DetachInstances API with the list of instances and the option to\n decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement\n instances.

\n

To terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity\n of the Auto Scaling group to\n zero.

\n

If the group has scaling policies, deleting the group deletes the policies, the\n underlying alarm actions, and any alarm that no longer has an associated action.

\n

For more information, see Delete your Auto Scaling\n infrastructure in the Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To delete an Auto Scaling group", - "documentation": "This example deletes the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group" - } - }, - { - "title": "To delete an Auto Scaling group and all its instances", - "documentation": "This example deletes the specified Auto Scaling group and all its instances.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "ForceDelete": true - } - } - ] - } - }, - "com.amazonaws.autoscaling#DeleteAutoScalingGroupType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "ForceDelete": { - "target": "com.amazonaws.autoscaling#ForceDelete", - "traits": { - "smithy.api#documentation": "

Specifies that the group is to be deleted along with all instances associated with the\n group, without waiting for all instances to be terminated. This action also deletes any\n outstanding lifecycle actions associated with the group.

" - } - } - } - }, - "com.amazonaws.autoscaling#DeleteLaunchConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#LaunchConfigurationNameType" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - }, - { - "target": "com.amazonaws.autoscaling#ResourceInUseFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified launch configuration.

\n

The launch configuration must not be attached to an Auto Scaling group. When this call\n completes, the launch configuration is no longer available for use.

", - "smithy.api#examples": [ - { - "title": "To delete a launch configuration", - "documentation": "This example deletes the specified launch configuration.", - "input": { - "LaunchConfigurationName": "my-launch-config" - } - } - ] - } - }, - "com.amazonaws.autoscaling#DeleteLifecycleHook": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DeleteLifecycleHookType" - }, - "output": { - "target": "com.amazonaws.autoscaling#DeleteLifecycleHookAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified lifecycle hook.

\n

If there are any outstanding lifecycle actions, they are completed first\n (ABANDON for launching instances, CONTINUE for terminating\n instances).

", - "smithy.api#examples": [ - { - "title": "To delete a lifecycle hook", - "documentation": "This example deletes the specified lifecycle hook.", - "input": { - "LifecycleHookName": "my-lifecycle-hook", - "AutoScalingGroupName": "my-auto-scaling-group" - } - } - ] - } - }, - "com.amazonaws.autoscaling#DeleteLifecycleHookAnswer": { - "type": "structure", - "members": {} - }, - "com.amazonaws.autoscaling#DeleteLifecycleHookType": { - "type": "structure", - "members": { - "LifecycleHookName": { - "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the lifecycle hook.

", - "smithy.api#required": {} - } - }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#DeleteNotificationConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DeleteNotificationConfigurationType" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified notification.

", - "smithy.api#examples": [ - { - "title": "To delete an Auto Scaling notification", - "documentation": "This example deletes the specified notification from the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic" - } - } - ] - } - }, - "com.amazonaws.autoscaling#DeleteNotificationConfigurationType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "TopicARN": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SNS topic.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#DeletePolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DeletePolicyType" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - }, - { - "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified scaling policy.

\n

Deleting either a step scaling policy or a simple scaling policy deletes the\n underlying alarm action, but does not delete the alarm, even if it no longer has an\n associated action.

\n

For more information, see Delete a scaling\n policy in the Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To delete an Auto Scaling policy", - "documentation": "This example deletes the specified Auto Scaling policy.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "PolicyName": "my-step-scale-out-policy" - } - } - ] - } - }, - "com.amazonaws.autoscaling#DeletePolicyType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

" - } - }, - "PolicyName": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the policy.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#DeleteScheduledAction": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DeleteScheduledActionType" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified scheduled action.

", - "smithy.api#examples": [ - { - "title": "To delete a scheduled action from an Auto Scaling group", - "documentation": "This example deletes the specified scheduled action from the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "ScheduledActionName": "my-scheduled-action" - } - } - ] - } - }, - "com.amazonaws.autoscaling#DeleteScheduledActionType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "ScheduledActionName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the action to delete.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#DeleteTags": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DeleteTagsType" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - }, - { - "target": "com.amazonaws.autoscaling#ResourceInUseFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified tags.

", - "smithy.api#examples": [ - { - "title": "To delete a tag from an Auto Scaling group", - "documentation": "This example deletes the specified tag from the specified Auto Scaling group.", - "input": { - "Tags": [ + "target": "com.amazonaws.autoscaling#AttachLoadBalancers" + }, { - "ResourceId": "my-auto-scaling-group", - "ResourceType": "auto-scaling-group", - "Key": "Dept", - "Value": "Research" - } - ] - } - } - ] - } - }, - "com.amazonaws.autoscaling#DeleteTagsType": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.autoscaling#Tags", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

One or more tags.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#DeleteWarmPool": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DeleteWarmPoolType" - }, - "output": { - "target": "com.amazonaws.autoscaling#DeleteWarmPoolAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#LimitExceededFault" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - }, - { - "target": "com.amazonaws.autoscaling#ResourceInUseFault" - }, - { - "target": "com.amazonaws.autoscaling#ScalingActivityInProgressFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the warm pool for the specified Auto Scaling group.

\n

For more information, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "com.amazonaws.autoscaling#DeleteWarmPoolAnswer": { - "type": "structure", - "members": {} - }, - "com.amazonaws.autoscaling#DeleteWarmPoolType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "ForceDelete": { - "target": "com.amazonaws.autoscaling#ForceDelete", - "traits": { - "smithy.api#documentation": "

Specifies that the warm pool is to be deleted along with all of its associated\n instances, without waiting for all instances to be terminated. This parameter also\n deletes any outstanding lifecycle actions associated with the warm pool\n instances.

" - } - } - } - }, - "com.amazonaws.autoscaling#DescribeAccountLimits": { - "type": "operation", - "input": { - "target": "smithy.api#Unit" - }, - "output": { - "target": "com.amazonaws.autoscaling#DescribeAccountLimitsAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the current Amazon EC2 Auto Scaling resource quotas for your account.

\n

When you establish an Amazon Web Services account, the account has initial quotas on the maximum\n number of Auto Scaling groups and launch configurations that you can create in a given Region.\n For more information, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To describe your Auto Scaling account limits", - "documentation": "This example describes the Amazon EC2 Auto Scaling service quotas for your account.", - "output": { - "MaxNumberOfAutoScalingGroups": 20, - "MaxNumberOfLaunchConfigurations": 100, - "NumberOfAutoScalingGroups": 3, - "NumberOfLaunchConfigurations": 5 - } - } - ] - } - }, - "com.amazonaws.autoscaling#DescribeAccountLimitsAnswer": { - "type": "structure", - "members": { - "MaxNumberOfAutoScalingGroups": { - "target": "com.amazonaws.autoscaling#MaxNumberOfAutoScalingGroups", - "traits": { - "smithy.api#documentation": "

The maximum number of groups allowed for your account. The default is 200 groups per\n Region.

" - } - }, - "MaxNumberOfLaunchConfigurations": { - "target": "com.amazonaws.autoscaling#MaxNumberOfLaunchConfigurations", - "traits": { - "smithy.api#documentation": "

The maximum number of launch configurations allowed for your account. The default is\n 200 launch configurations per Region.

" - } - }, - "NumberOfAutoScalingGroups": { - "target": "com.amazonaws.autoscaling#NumberOfAutoScalingGroups", - "traits": { - "smithy.api#documentation": "

The current number of groups for your account.

" - } - }, - "NumberOfLaunchConfigurations": { - "target": "com.amazonaws.autoscaling#NumberOfLaunchConfigurations", - "traits": { - "smithy.api#documentation": "

The current number of launch configurations for your account.

" - } - } - } - }, - "com.amazonaws.autoscaling#DescribeAdjustmentTypes": { - "type": "operation", - "input": { - "target": "smithy.api#Unit" - }, - "output": { - "target": "com.amazonaws.autoscaling#DescribeAdjustmentTypesAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the available adjustment types for step scaling and simple scaling\n policies.

\n

The following adjustment types are supported:

\n ", - "smithy.api#examples": [ - { - "title": "To describe the Amazon EC2 Auto Scaling adjustment types", - "documentation": "This example describes the available adjustment types.", - "output": { - "AdjustmentTypes": [ + "target": "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroups" + }, { - "AdjustmentType": "ChangeInCapacity" + "target": "com.amazonaws.autoscaling#AttachTrafficSources" }, { - "AdjustmentType": "ExactCapcity" + "target": "com.amazonaws.autoscaling#BatchDeleteScheduledAction" }, { - "AdjustmentType": "PercentChangeInCapacity" - } - ] - } - } - ] - } - }, - "com.amazonaws.autoscaling#DescribeAdjustmentTypesAnswer": { - "type": "structure", - "members": { - "AdjustmentTypes": { - "target": "com.amazonaws.autoscaling#AdjustmentTypes", - "traits": { - "smithy.api#documentation": "

The policy adjustment types.

" - } - } - } - }, - "com.amazonaws.autoscaling#DescribeAutoScalingGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupNamesType" - }, - "output": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupsType" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#InvalidNextToken" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about the Auto Scaling groups in the account and Region.

\n

If you specify Auto Scaling group names, the output includes information for only the\n specified Auto Scaling groups. If you specify filters, the output includes information for only\n those Auto Scaling groups that meet the filter criteria. If you do not specify group names or\n filters, the output includes information for all Auto Scaling groups.

\n

This operation also returns information about instances in Auto Scaling groups. To retrieve\n information about the instances in a warm pool, you must call the DescribeWarmPool API.

", - "smithy.api#examples": [ - { - "title": "To describe an Auto Scaling group", - "documentation": "This example describes the specified Auto Scaling group.", - "input": { - "AutoScalingGroupNames": ["my-auto-scaling-group"] - }, - "output": { - "AutoScalingGroups": [ - { - "AutoScalingGroupName": "my-auto-scaling-group", - "AutoScalingGroupARN": "arn:aws:autoscaling:us-west-1:123456789012:autoScalingGroup:12345678-1234-1234-1234-123456789012:autoScalingGroupName/my-auto-scaling-group", - "LaunchConfigurationName": "my-launch-config", - "MinSize": 1, - "MaxSize": 5, - "DesiredCapacity": 2, - "DefaultCooldown": 300, - "AvailabilityZones": ["us-west-2a", "us-west-2b", "us-west-2c"], - "LoadBalancerNames": [], - "TargetGroupARNs": [], - "HealthCheckType": "EC2", - "HealthCheckGracePeriod": 300, - "Instances": [ - { - "ProtectedFromScaleIn": false, - "AvailabilityZone": "us-west-2c", - "LaunchConfigurationName": "my-launch-config", - "InstanceId": "i-05b4f7d5be44822a6", - "InstanceType": "t3.micro", - "HealthStatus": "Healthy", - "LifecycleState": "InService" - }, - { - "ProtectedFromScaleIn": false, - "AvailabilityZone": "us-west-2b", - "LaunchConfigurationName": "my-launch-config", - "InstanceId": "i-0c20ac468fa3049e8", - "InstanceType": "t3.micro", - "HealthStatus": "Healthy", - "LifecycleState": "InService" - } - ], - "CreatedTime": "2023-03-09T22:15:11.611Z", - "SuspendedProcesses": [], - "VPCZoneIdentifier": "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782", - "EnabledMetrics": [], - "Tags": [], - "TerminationPolicies": ["Default"], - "NewInstancesProtectedFromScaleIn": false, - "ServiceLinkedRoleARN": "arn:aws:iam::123456789012:role/aws-service-role/autoscaling.amazonaws.com/AWSServiceRoleForAutoScaling", - "TrafficSources": [] - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AutoScalingGroups", - "pageSize": "MaxRecords" - }, - "smithy.waiters#waitable": { - "GroupExists": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "length(AutoScalingGroups) > `0`", - "expected": "true", - "comparator": "booleanEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "output": { - "path": "length(AutoScalingGroups) > `0`", - "expected": "false", - "comparator": "booleanEquals" - } - } - } - ], - "minDelay": 5 - }, - "GroupInService": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "contains(AutoScalingGroups[].[length(Instances[?LifecycleState=='InService']) >= MinSize][], `false`)", - "expected": "false", - "comparator": "booleanEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "output": { - "path": "contains(AutoScalingGroups[].[length(Instances[?LifecycleState=='InService']) >= MinSize][], `false`)", - "expected": "true", - "comparator": "booleanEquals" - } - } - } - ], - "minDelay": 15 - }, - "GroupNotExists": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "length(AutoScalingGroups) > `0`", - "expected": "false", - "comparator": "booleanEquals" - } - } - }, - { - "state": "retry", - "matcher": { - "output": { - "path": "length(AutoScalingGroups) > `0`", - "expected": "true", - "comparator": "booleanEquals" - } - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.autoscaling#DescribeAutoScalingInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DescribeAutoScalingInstancesType" - }, - "output": { - "target": "com.amazonaws.autoscaling#AutoScalingInstancesType" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#InvalidNextToken" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about the Auto Scaling instances in the account and Region.

", - "smithy.api#examples": [ - { - "title": "To describe one or more Auto Scaling instances", - "documentation": "This example describes the specified Auto Scaling instance.", - "input": { - "InstanceIds": ["i-05b4f7d5be44822a6"] - }, - "output": { - "AutoScalingInstances": [ - { - "ProtectedFromScaleIn": false, - "AvailabilityZone": "us-west-2c", - "LaunchConfigurationName": "my-launch-config", - "InstanceId": "i-05b4f7d5be44822a6", - "InstanceType": "t3.micro", - "AutoScalingGroupName": "my-auto-scaling-group", - "HealthStatus": "HEALTHY", - "LifecycleState": "InService" - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AutoScalingInstances", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.autoscaling#DescribeAutoScalingInstancesType": { - "type": "structure", - "members": { - "InstanceIds": { - "target": "com.amazonaws.autoscaling#InstanceIds", - "traits": { - "smithy.api#documentation": "

The IDs of the instances. If you omit this property, all Auto Scaling instances are described.\n If you specify an ID that does not exist, it is ignored with no error.

\n

Array Members: Maximum number of 50 items.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.autoscaling#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 50.

" - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" - } - } - } - }, - "com.amazonaws.autoscaling#DescribeAutoScalingNotificationTypes": { - "type": "operation", - "input": { - "target": "smithy.api#Unit" - }, - "output": { - "target": "com.amazonaws.autoscaling#DescribeAutoScalingNotificationTypesAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the notification types that are supported by Amazon EC2 Auto Scaling.

", - "smithy.api#examples": [ - { - "title": "To describe the Auto Scaling notification types", - "documentation": "This example describes the available notification types.", - "output": { - "AutoScalingNotificationTypes": [ - "autoscaling:EC2_INSTANCE_LAUNCH", - "autoscaling:EC2_INSTANCE_LAUNCH_ERROR", - "autoscaling:EC2_INSTANCE_TERMINATE", - "autoscaling:EC2_INSTANCE_TERMINATE_ERROR", - "autoscaling:TEST_NOTIFICATION" - ] - } - } - ] - } - }, - "com.amazonaws.autoscaling#DescribeAutoScalingNotificationTypesAnswer": { - "type": "structure", - "members": { - "AutoScalingNotificationTypes": { - "target": "com.amazonaws.autoscaling#AutoScalingNotificationTypes", - "traits": { - "smithy.api#documentation": "

The notification types.

" - } - } - } - }, - "com.amazonaws.autoscaling#DescribeInstanceRefreshes": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DescribeInstanceRefreshesType" - }, - "output": { - "target": "com.amazonaws.autoscaling#DescribeInstanceRefreshesAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#InvalidNextToken" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about the instance refreshes for the specified Auto Scaling group from the\n previous six weeks.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group\n after you make configuration changes.

\n

To help you determine the status of an instance refresh, Amazon EC2 Auto Scaling returns information\n about the instance refreshes you previously initiated, including their status, start\n time, end time, the percentage of the instance refresh that is complete, and the number\n of instances remaining to update before the instance refresh is complete. If a rollback\n is initiated while an instance refresh is in progress, Amazon EC2 Auto Scaling also returns information\n about the rollback of the instance refresh.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.autoscaling#DescribeInstanceRefreshesAnswer": { - "type": "structure", - "members": { - "InstanceRefreshes": { - "target": "com.amazonaws.autoscaling#InstanceRefreshes", - "traits": { - "smithy.api#documentation": "

The instance refreshes for the specified group, sorted by creation timestamp in\n descending order.

" - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" - } - } - } - }, - "com.amazonaws.autoscaling#DescribeInstanceRefreshesType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "InstanceRefreshIds": { - "target": "com.amazonaws.autoscaling#InstanceRefreshIds", - "traits": { - "smithy.api#documentation": "

One or more instance refresh IDs.

" - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.autoscaling#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.

" - } - } - } - }, - "com.amazonaws.autoscaling#DescribeLaunchConfigurations": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#LaunchConfigurationNamesType" - }, - "output": { - "target": "com.amazonaws.autoscaling#LaunchConfigurationsType" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#InvalidNextToken" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about the launch configurations in the account and Region.

", - "smithy.api#examples": [ - { - "title": "To describe Auto Scaling launch configurations", - "documentation": "This example describes the specified launch configuration.", - "input": { - "LaunchConfigurationNames": ["my-launch-config"] - }, - "output": { - "LaunchConfigurations": [ - { - "EbsOptimized": false, - "LaunchConfigurationARN": "arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config", - "InstanceMonitoring": { - "Enabled": true - }, - "ImageId": "ami-043a5034", - "CreatedTime": "2014-05-07T17:39:28.599Z", - "BlockDeviceMappings": [], - "SecurityGroups": ["sg-67ef0308"], - "LaunchConfigurationName": "my-launch-config", - "InstanceType": "t1.micro", - "AssociatePublicIpAddress": true - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "LaunchConfigurations", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.autoscaling#DescribeLifecycleHookTypes": { - "type": "operation", - "input": { - "target": "smithy.api#Unit" - }, - "output": { - "target": "com.amazonaws.autoscaling#DescribeLifecycleHookTypesAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the available types of lifecycle hooks.

\n

The following hook types are supported:

\n ", - "smithy.api#examples": [ - { - "title": "To describe the available types of lifecycle hooks", - "documentation": "This example describes the available lifecycle hook types.", - "output": { - "LifecycleHookTypes": ["autoscaling:EC2_INSTANCE_LAUNCHING", "autoscaling:EC2_INSTANCE_TERMINATING"] - } - } - ] - } - }, - "com.amazonaws.autoscaling#DescribeLifecycleHookTypesAnswer": { - "type": "structure", - "members": { - "LifecycleHookTypes": { - "target": "com.amazonaws.autoscaling#AutoScalingNotificationTypes", - "traits": { - "smithy.api#documentation": "

The lifecycle hook types.

" - } - } - } - }, - "com.amazonaws.autoscaling#DescribeLifecycleHooks": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DescribeLifecycleHooksType" - }, - "output": { - "target": "com.amazonaws.autoscaling#DescribeLifecycleHooksAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about the lifecycle hooks for the specified Auto Scaling group.

", - "smithy.api#examples": [ - { - "title": "To describe your lifecycle hooks", - "documentation": "This example describes the lifecycle hooks for the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group" - }, - "output": { - "LifecycleHooks": [ + "target": "com.amazonaws.autoscaling#BatchPutScheduledUpdateGroupAction" + }, { - "GlobalTimeout": 172800, - "HeartbeatTimeout": 3600, - "RoleARN": "arn:aws:iam::123456789012:role/my-auto-scaling-role", - "AutoScalingGroupName": "my-auto-scaling-group", - "LifecycleHookName": "my-lifecycle-hook", - "DefaultResult": "ABANDON", - "NotificationTargetARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic", - "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING" - } - ] - } - } - ] - } - }, - "com.amazonaws.autoscaling#DescribeLifecycleHooksAnswer": { - "type": "structure", - "members": { - "LifecycleHooks": { - "target": "com.amazonaws.autoscaling#LifecycleHooks", - "traits": { - "smithy.api#documentation": "

The lifecycle hooks for the specified group.

" - } - } - } - }, - "com.amazonaws.autoscaling#DescribeLifecycleHooksType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "LifecycleHookNames": { - "target": "com.amazonaws.autoscaling#LifecycleHookNames", - "traits": { - "smithy.api#documentation": "

The names of one or more lifecycle hooks. If you omit this property, all lifecycle\n hooks are described.

" - } - } - } - }, - "com.amazonaws.autoscaling#DescribeLoadBalancerTargetGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DescribeLoadBalancerTargetGroupsRequest" - }, - "output": { - "target": "com.amazonaws.autoscaling#DescribeLoadBalancerTargetGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#InvalidNextToken" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "\n

This API operation is superseded by DescribeTrafficSources,\n which can describe multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DescribeLoadBalancerTargetGroups. You\n can use both the original DescribeLoadBalancerTargetGroups API\n operation and DescribeTrafficSources on the same Auto Scaling group.

\n \n

Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.

\n

To determine the attachment status of the target group, use the State\n element in the response. When you attach a target group to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the target group. If\n Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the target group is in the InService state, Amazon EC2 Auto Scaling can terminate and\n replace any instances that are reported as unhealthy. If no registered instances pass\n the health checks, the target group doesn't enter the InService state.

\n

Target groups also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your target group state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.

\n

For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n \n

You can use this operation to describe target groups that were attached by using\n AttachLoadBalancerTargetGroups, but not for target groups that\n were attached by using AttachTrafficSources.

\n ", - "smithy.api#examples": [ - { - "title": "To describe the target groups for an Auto Scaling group", - "documentation": "This example describes the target groups attached to the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group" - }, - "output": { - "LoadBalancerTargetGroups": [ + "target": "com.amazonaws.autoscaling#CancelInstanceRefresh" + }, { - "LoadBalancerTargetGroupARN": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", - "State": "Added" - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.autoscaling#DescribeLoadBalancerTargetGroupsRequest": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.autoscaling#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 100 and the maximum value is 100.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.autoscaling#DescribeLoadBalancerTargetGroupsResponse": { - "type": "structure", - "members": { - "LoadBalancerTargetGroups": { - "target": "com.amazonaws.autoscaling#LoadBalancerTargetGroupStates", - "traits": { - "smithy.api#documentation": "

Information about the target groups.

" - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.autoscaling#DescribeLoadBalancers": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DescribeLoadBalancersRequest" - }, - "output": { - "target": "com.amazonaws.autoscaling#DescribeLoadBalancersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#InvalidNextToken" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "\n

This API operation is superseded by DescribeTrafficSources,\n which can describe multiple traffic sources types. We recommend using\n DescribeTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DescribeLoadBalancers. You can use both\n the original DescribeLoadBalancers API operation and\n DescribeTrafficSources on the same Auto Scaling group.

\n \n

Gets information about the load balancers for the specified Auto Scaling group.

\n

This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the\n DescribeLoadBalancerTargetGroups API instead.

\n

To determine the attachment status of the load balancer, use the State\n element in the response. When you attach a load balancer to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the load balancer.\n If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the load balancer is in the InService state, Amazon EC2 Auto Scaling can terminate\n and replace any instances that are reported as unhealthy. If no registered instances\n pass the health checks, the load balancer doesn't enter the InService\n state.

\n

Load balancers also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your load balancer state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.

\n

For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To describe the load balancers for an Auto Scaling group", - "documentation": "This example describes the load balancers attached to the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group" - }, - "output": { - "LoadBalancers": [ + "target": "com.amazonaws.autoscaling#CompleteLifecycleAction" + }, { - "State": "Added", - "LoadBalancerName": "my-load-balancer" - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.autoscaling#DescribeLoadBalancersRequest": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.autoscaling#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 100 and the maximum value is 100.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.autoscaling#DescribeLoadBalancersResponse": { - "type": "structure", - "members": { - "LoadBalancers": { - "target": "com.amazonaws.autoscaling#LoadBalancerStates", - "traits": { - "smithy.api#documentation": "

The load balancers.

" - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.autoscaling#DescribeMetricCollectionTypes": { - "type": "operation", - "input": { - "target": "smithy.api#Unit" - }, - "output": { - "target": "com.amazonaws.autoscaling#DescribeMetricCollectionTypesAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.

", - "smithy.api#examples": [ - { - "title": "To describe the Auto Scaling metric collection types", - "documentation": "This example describes the available metric collection types.", - "output": { - "Metrics": [ + "target": "com.amazonaws.autoscaling#CreateAutoScalingGroup" + }, { - "Metric": "GroupMinSize" + "target": "com.amazonaws.autoscaling#CreateLaunchConfiguration" }, { - "Metric": "GroupMaxSize" + "target": "com.amazonaws.autoscaling#CreateOrUpdateTags" }, { - "Metric": "GroupDesiredCapacity" + "target": "com.amazonaws.autoscaling#DeleteAutoScalingGroup" }, { - "Metric": "GroupInServiceInstances" + "target": "com.amazonaws.autoscaling#DeleteLaunchConfiguration" }, { - "Metric": "GroupPendingInstances" + "target": "com.amazonaws.autoscaling#DeleteLifecycleHook" }, { - "Metric": "GroupTerminatingInstances" + "target": "com.amazonaws.autoscaling#DeleteNotificationConfiguration" }, { - "Metric": "GroupStandbyInstances" + "target": "com.amazonaws.autoscaling#DeletePolicy" }, { - "Metric": "GroupTotalInstances" - } - ], - "Granularities": [ + "target": "com.amazonaws.autoscaling#DeleteScheduledAction" + }, { - "Granularity": "1Minute" - } - ] - } - } - ] - } - }, - "com.amazonaws.autoscaling#DescribeMetricCollectionTypesAnswer": { - "type": "structure", - "members": { - "Metrics": { - "target": "com.amazonaws.autoscaling#MetricCollectionTypes", - "traits": { - "smithy.api#documentation": "

The metrics.

" - } - }, - "Granularities": { - "target": "com.amazonaws.autoscaling#MetricGranularityTypes", - "traits": { - "smithy.api#documentation": "

The granularities for the metrics.

" - } - } - } - }, - "com.amazonaws.autoscaling#DescribeNotificationConfigurations": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DescribeNotificationConfigurationsType" - }, - "output": { - "target": "com.amazonaws.autoscaling#DescribeNotificationConfigurationsAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#InvalidNextToken" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about the Amazon SNS notifications that are configured for one or more\n Auto Scaling groups.

", - "smithy.api#examples": [ - { - "title": "To describe Auto Scaling notification configurations", - "documentation": "This example describes the notification configurations for the specified Auto Scaling group.", - "input": { - "AutoScalingGroupNames": ["my-auto-scaling-group"] - }, - "output": { - "NotificationConfigurations": [ + "target": "com.amazonaws.autoscaling#DeleteTags" + }, { - "AutoScalingGroupName": "my-auto-scaling-group", - "NotificationType": "autoscaling:TEST_NOTIFICATION", - "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic-2" + "target": "com.amazonaws.autoscaling#DeleteWarmPool" }, { - "AutoScalingGroupName": "my-auto-scaling-group", - "NotificationType": "autoscaling:TEST_NOTIFICATION", - "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic" - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "NotificationConfigurations", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.autoscaling#DescribeNotificationConfigurationsAnswer": { - "type": "structure", - "members": { - "NotificationConfigurations": { - "target": "com.amazonaws.autoscaling#NotificationConfigurations", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The notification configurations.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" - } - } - } - }, - "com.amazonaws.autoscaling#DescribeNotificationConfigurationsType": { - "type": "structure", - "members": { - "AutoScalingGroupNames": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupNames", - "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

" - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.autoscaling#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.

" - } - } - } - }, - "com.amazonaws.autoscaling#DescribePolicies": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DescribePoliciesType" - }, - "output": { - "target": "com.amazonaws.autoscaling#PoliciesType" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#InvalidNextToken" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - }, - { - "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about the scaling policies in the account and Region.

", - "smithy.api#examples": [ - { - "title": "To describe scaling policies", - "documentation": "This example describes the policies for the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group" - }, - "output": { - "ScalingPolicies": [ - { - "PolicyName": "ScaleIn", - "AutoScalingGroupName": "my-auto-scaling-group", - "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn", - "AdjustmentType": "ChangeInCapacity", - "Alarms": [], - "ScalingAdjustment": -1 - }, - { - "PolicyName": "ScalePercentChange", - "MinAdjustmentStep": 2, - "AutoScalingGroupName": "my-auto-scaling-group", - "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2b435159-cf77-4e89-8c0e-d63b497baad7:autoScalingGroupName/my-auto-scaling-group:policyName/ScalePercentChange", - "Cooldown": 60, - "AdjustmentType": "PercentChangeInCapacity", - "Alarms": [], - "ScalingAdjustment": 25 - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ScalingPolicies", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.autoscaling#DescribePoliciesType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

" - } - }, - "PolicyNames": { - "target": "com.amazonaws.autoscaling#PolicyNames", - "traits": { - "smithy.api#documentation": "

The names of one or more policies. If you omit this property, all policies are\n described. If a group name is provided, the results are limited to that group. If you\n specify an unknown policy name, it is ignored with no error.

\n

Array Members: Maximum number of 50 items.

" - } - }, - "PolicyTypes": { - "target": "com.amazonaws.autoscaling#PolicyTypes", - "traits": { - "smithy.api#documentation": "

One or more policy types. The valid values are SimpleScaling,\n StepScaling, TargetTrackingScaling, and\n PredictiveScaling.

" - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.autoscaling#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of items to be returned with each call. The default value is\n 50 and the maximum value is 100.

" - } - } - } - }, - "com.amazonaws.autoscaling#DescribeScalingActivities": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DescribeScalingActivitiesType" - }, - "output": { - "target": "com.amazonaws.autoscaling#ActivitiesType" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#InvalidNextToken" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about the scaling activities in the account and Region.

\n

When scaling events occur, you see a record of the scaling activity in the scaling\n activities. For more information, see Verify a scaling\n activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

\n

If the scaling event succeeds, the value of the StatusCode element in the\n response is Successful. If an attempt to launch instances failed, the\n StatusCode value is Failed or Cancelled and\n the StatusMessage element in the response indicates the cause of the\n failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To describe the scaling activities for an Auto Scaling group", - "documentation": "This example describes the scaling activities for the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group" - }, - "output": { - "Activities": [ - { - "Description": "Launching a new EC2 instance: i-4ba0837f", - "AutoScalingGroupName": "my-auto-scaling-group", - "ActivityId": "f9f2d65b-f1f2-43e7-b46d-d86756459699", - "Details": "details", - "StartTime": "2013-08-19T20:53:29.930Z", - "Progress": 100, - "EndTime": "2013-08-19T20:54:02Z", - "Cause": "At 2013-08-19T20:53:25Z a user request created an AutoScalingGroup changing the desired capacity from 0 to 1. At 2013-08-19T20:53:29Z an instance was started in response to a difference between desired and actual capacity, increasing the capacity from 0 to 1.", - "StatusCode": "Successful", - "AutoScalingGroupARN": "arn:aws:autoscaling:us-east-1:123456789012:autoScalingGroup:12345678-1234-1234-1234-123456789012:autoScalingGroupName/my-auto-scaling-group" - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Activities", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.autoscaling#DescribeScalingActivitiesType": { - "type": "structure", - "members": { - "ActivityIds": { - "target": "com.amazonaws.autoscaling#ActivityIds", - "traits": { - "smithy.api#documentation": "

The activity IDs of the desired scaling activities. If you omit this property, all\n activities for the past six weeks are described. If unknown activities are requested,\n they are ignored with no error. If you specify an Auto Scaling group, the results are limited to\n that group.

\n

Array Members: Maximum number of 50 IDs.

" - } - }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

" - } - }, - "IncludeDeletedGroups": { - "target": "com.amazonaws.autoscaling#IncludeDeletedGroups", - "traits": { - "smithy.api#documentation": "

Indicates whether to include scaling activity from deleted Auto Scaling groups.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.autoscaling#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 100 and the maximum value is 100.

" - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" - } - } - } - }, - "com.amazonaws.autoscaling#DescribeScalingProcessTypes": { - "type": "operation", - "input": { - "target": "smithy.api#Unit" - }, - "output": { - "target": "com.amazonaws.autoscaling#ProcessesType" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the scaling process types for use with the ResumeProcesses\n and SuspendProcesses APIs.

", - "smithy.api#examples": [ - { - "title": "To describe the Auto Scaling process types", - "documentation": "This example describes the Auto Scaling process types.", - "output": { - "Processes": [ + "target": "com.amazonaws.autoscaling#DescribeAccountLimits" + }, { - "ProcessName": "AZRebalance" + "target": "com.amazonaws.autoscaling#DescribeAdjustmentTypes" }, { - "ProcessName": "AddToLoadBalancer" + "target": "com.amazonaws.autoscaling#DescribeAutoScalingGroups" }, { - "ProcessName": "AlarmNotification" + "target": "com.amazonaws.autoscaling#DescribeAutoScalingInstances" }, { - "ProcessName": "HealthCheck" + "target": "com.amazonaws.autoscaling#DescribeAutoScalingNotificationTypes" }, { - "ProcessName": "Launch" + "target": "com.amazonaws.autoscaling#DescribeInstanceRefreshes" }, { - "ProcessName": "ReplaceUnhealthy" + "target": "com.amazonaws.autoscaling#DescribeLaunchConfigurations" }, { - "ProcessName": "ScheduledActions" + "target": "com.amazonaws.autoscaling#DescribeLifecycleHooks" }, { - "ProcessName": "Terminate" - } - ] - } - } - ], - "smithy.test#smokeTests": [ - { - "id": "DescribeScalingProcessTypesSuccess", - "params": {}, - "vendorParams": { - "region": "us-west-2" - }, - "vendorParamsShape": "aws.test#AwsVendorParams", - "expect": { - "success": {} - } - } - ] - } - }, - "com.amazonaws.autoscaling#DescribeScheduledActions": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DescribeScheduledActionsType" - }, - "output": { - "target": "com.amazonaws.autoscaling#ScheduledActionsType" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#InvalidNextToken" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about the scheduled actions that haven't run or that have not reached\n their end time.

\n

To describe the scaling activities for scheduled actions that have already run, call\n the DescribeScalingActivities API.

", - "smithy.api#examples": [ - { - "title": "To describe scheduled actions", - "documentation": "This example describes the scheduled actions for the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group" - }, - "output": { - "ScheduledUpdateGroupActions": [ - { - "MinSize": 2, - "DesiredCapacity": 4, - "AutoScalingGroupName": "my-auto-scaling-group", - "MaxSize": 6, - "Recurrence": "30 0 1 12 0", - "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-auto-scaling-group:scheduledActionName/my-scheduled-action", - "ScheduledActionName": "my-scheduled-action", - "StartTime": "2016-12-01T00:30:00Z", - "Time": "2016-12-01T00:30:00Z" - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ScheduledUpdateGroupActions", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.autoscaling#DescribeScheduledActionsType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

" - } - }, - "ScheduledActionNames": { - "target": "com.amazonaws.autoscaling#ScheduledActionNames", - "traits": { - "smithy.api#documentation": "

The names of one or more scheduled actions. If you omit this property, all scheduled\n actions are described. If you specify an unknown scheduled action, it is ignored with no\n error.

\n

Array Members: Maximum number of 50 actions.

" - } - }, - "StartTime": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The earliest scheduled start time to return. If scheduled action names are provided,\n this property is ignored.

" - } - }, - "EndTime": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The latest scheduled start time to return. If scheduled action names are provided,\n this property is ignored.

" - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.autoscaling#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.

" - } - } - } - }, - "com.amazonaws.autoscaling#DescribeTags": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DescribeTagsType" - }, - "output": { - "target": "com.amazonaws.autoscaling#TagsType" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#InvalidNextToken" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the specified tags.

\n

You can use filters to limit the results. For example, you can query for the tags for\n a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at\n least one of the specified values for it to be included in the results.

\n

You can also specify multiple filters. The result includes information for a\n particular tag only if it matches all the filters. If there's no match, no special\n message is returned.

\n

For more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To describe tags", - "documentation": "This example describes the tags for the specified Auto Scaling group.", - "input": { - "Filters": [ + "target": "com.amazonaws.autoscaling#DescribeLifecycleHookTypes" + }, { - "Values": ["my-auto-scaling-group"], - "Name": "auto-scaling-group" - } - ] - }, - "output": { - "Tags": [ - { - "ResourceType": "auto-scaling-group", - "ResourceId": "my-auto-scaling-group", - "PropagateAtLaunch": true, - "Value": "Research", - "Key": "Dept" - }, - { - "ResourceType": "auto-scaling-group", - "ResourceId": "my-auto-scaling-group", - "PropagateAtLaunch": true, - "Value": "WebServer", - "Key": "Role" - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Tags", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.autoscaling#DescribeTagsType": { - "type": "structure", - "members": { - "Filters": { - "target": "com.amazonaws.autoscaling#Filters", - "traits": { - "smithy.api#documentation": "

One or more filters to scope the tags to return. The maximum number of filters per\n filter type (for example, auto-scaling-group) is 1000.

" - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.autoscaling#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.

" - } - } - } - }, - "com.amazonaws.autoscaling#DescribeTerminationPolicyTypes": { - "type": "operation", - "input": { - "target": "smithy.api#Unit" - }, - "output": { - "target": "com.amazonaws.autoscaling#DescribeTerminationPolicyTypesAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the termination policies supported by Amazon EC2 Auto Scaling.

\n

For more information, see Configure\n termination policies for Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To describe termination policy types", - "documentation": "This example describes the available termination policy types.", - "output": { - "TerminationPolicyTypes": [ - "ClosestToNextInstanceHour", - "Default", - "NewestInstance", - "OldestInstance", - "OldestLaunchConfiguration" - ] - } - } - ] - } - }, - "com.amazonaws.autoscaling#DescribeTerminationPolicyTypesAnswer": { - "type": "structure", - "members": { - "TerminationPolicyTypes": { - "target": "com.amazonaws.autoscaling#TerminationPolicies", - "traits": { - "smithy.api#documentation": "

The termination policies supported by Amazon EC2 Auto Scaling: OldestInstance,\n OldestLaunchConfiguration, NewestInstance,\n ClosestToNextInstanceHour, Default,\n OldestLaunchTemplate, and AllocationStrategy.

" - } - } - } - }, - "com.amazonaws.autoscaling#DescribeTrafficSources": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DescribeTrafficSourcesRequest" - }, - "output": { - "target": "com.amazonaws.autoscaling#DescribeTrafficSourcesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#InvalidNextToken" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about the traffic sources for the specified Auto Scaling group.

\n

You can optionally provide a traffic source type. If you provide a traffic source\n type, then the results only include that traffic source type.

\n

If you do not provide a traffic source type, then the results include all the traffic\n sources for the specified Auto Scaling group.

", - "smithy.api#examples": [ - { - "title": "To describe the target groups for an Auto Scaling group", - "documentation": "This example describes the target groups attached to the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group" - }, - "output": { - "TrafficSources": [ + "target": "com.amazonaws.autoscaling#DescribeLoadBalancers" + }, { - "Identifier": "arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-0e2f2665eEXAMPLE", - "State": "InService", - "Type": "vpc-lattice" - } - ], - "NextToken": "" - } - } - ], - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.autoscaling#DescribeTrafficSourcesRequest": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "TrafficSourceType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The traffic source type that you want to describe.

\n

The following lists the valid values:

\n " - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.autoscaling#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of items to return with this call. The maximum value is\n 50.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.autoscaling#DescribeTrafficSourcesResponse": { - "type": "structure", - "members": { - "TrafficSources": { - "target": "com.amazonaws.autoscaling#TrafficSourceStates", - "traits": { - "smithy.api#documentation": "

Information about the traffic sources.

" - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

This string indicates that the response contains more items than can be returned in a\n single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.autoscaling#DescribeWarmPool": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DescribeWarmPoolType" - }, - "output": { - "target": "com.amazonaws.autoscaling#DescribeWarmPoolAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#InvalidNextToken" - }, - { - "target": "com.amazonaws.autoscaling#LimitExceededFault" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about a warm pool and its instances.

\n

For more information, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Instances", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.autoscaling#DescribeWarmPoolAnswer": { - "type": "structure", - "members": { - "WarmPoolConfiguration": { - "target": "com.amazonaws.autoscaling#WarmPoolConfiguration", - "traits": { - "smithy.api#documentation": "

The warm pool configuration details.

" - } - }, - "Instances": { - "target": "com.amazonaws.autoscaling#Instances", - "traits": { - "smithy.api#documentation": "

The instances that are currently in the warm pool.

" - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

This string indicates that the response contains more items than can be returned in a\n single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" - } - } - } - }, - "com.amazonaws.autoscaling#DescribeWarmPoolType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "MaxRecords": { - "target": "com.amazonaws.autoscaling#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of instances to return with this call. The maximum value is\n 50.

" - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token for the next set of instances to return. (You received this token from a\n previous call.)

" - } - } - } - }, - "com.amazonaws.autoscaling#DesiredConfiguration": { - "type": "structure", - "members": { - "LaunchTemplate": { - "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", - "traits": { - "smithy.api#documentation": "

Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling\n uses to launch Amazon EC2 instances. For more information about launch templates, see Launch\n templates in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "MixedInstancesPolicy": { - "target": "com.amazonaws.autoscaling#MixedInstancesPolicy", - "traits": { - "smithy.api#documentation": "

Use this structure to launch multiple instance types and On-Demand Instances and Spot\n Instances within a single Auto Scaling group.

\n

A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch\n instances and help optimize your costs. For more information, see Auto Scaling\n groups with multiple instance types and purchase options in the\n Amazon EC2 Auto Scaling User Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the desired configuration for an instance refresh.

\n

If you specify a desired configuration, you must specify either a\n LaunchTemplate or a MixedInstancesPolicy.

" - } - }, - "com.amazonaws.autoscaling#DetachInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DetachInstancesQuery" - }, - "output": { - "target": "com.amazonaws.autoscaling#DetachInstancesAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Removes one or more instances from the specified Auto Scaling group.

\n

After the instances are detached, you can manage them independent of the Auto Scaling\n group.

\n

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are detached.

\n

If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are\n deregistered from the load balancer. If there are target groups attached to the Auto Scaling\n group, the instances are deregistered from the target groups.

\n

For more information, see Detach\n or attach instances in the Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To detach an instance from an Auto Scaling group", - "documentation": "This example detaches the specified instance from the specified Auto Scaling group.", - "input": { - "InstanceIds": ["i-93633f9b"], - "AutoScalingGroupName": "my-auto-scaling-group", - "ShouldDecrementDesiredCapacity": true - }, - "output": { - "Activities": [ + "target": "com.amazonaws.autoscaling#DescribeLoadBalancerTargetGroups" + }, { - "Description": "Detaching EC2 instance: i-93633f9b", - "AutoScalingGroupName": "my-auto-scaling-group", - "ActivityId": "5091cb52-547a-47ce-a236-c9ccbc2cb2c9", - "Details": "details", - "StartTime": "2015-04-12T15:02:16.179Z", - "Progress": 50, - "Cause": "At 2015-04-12T15:02:16Z instance i-93633f9b was detached in response to a user request, shrinking the capacity from 2 to 1.", - "StatusCode": "InProgress" - } - ] - } - } - ] - } - }, - "com.amazonaws.autoscaling#DetachInstancesAnswer": { - "type": "structure", - "members": { - "Activities": { - "target": "com.amazonaws.autoscaling#Activities", - "traits": { - "smithy.api#documentation": "

The activities related to detaching the instances from the Auto Scaling group.

" - } - } - } - }, - "com.amazonaws.autoscaling#DetachInstancesQuery": { - "type": "structure", - "members": { - "InstanceIds": { - "target": "com.amazonaws.autoscaling#InstanceIds", - "traits": { - "smithy.api#documentation": "

The IDs of the instances. You can specify up to 20 instances.

" - } - }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "ShouldDecrementDesiredCapacity": { - "target": "com.amazonaws.autoscaling#ShouldDecrementDesiredCapacity", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Indicates whether the Auto Scaling group decrements the desired capacity value by the number\n of instances detached.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#DetachLoadBalancerTargetGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DetachLoadBalancerTargetGroupsType" - }, - "output": { - "target": "com.amazonaws.autoscaling#DetachLoadBalancerTargetGroupsResultType" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "\n

This API operation is superseded by DetachTrafficSources, which\n can detach multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DetachLoadBalancerTargetGroups. You can\n use both the original DetachLoadBalancerTargetGroups API operation and\n DetachTrafficSources on the same Auto Scaling group.

\n \n

Detaches one or more target groups from the specified Auto Scaling group.

\n

When you detach a target group, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the target group using the DescribeLoadBalancerTargetGroups API call. The instances remain\n running.

\n \n

You can use this operation to detach target groups that were attached by using\n AttachLoadBalancerTargetGroups, but not for target groups that\n were attached by using AttachTrafficSources.

\n ", - "smithy.api#examples": [ - { - "title": "To detach a target group from an Auto Scaling group", - "documentation": "This example detaches the specified target group from the specified Auto Scaling group", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "TargetGroupARNs": [ - "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" - ] - } - } - ] - } - }, - "com.amazonaws.autoscaling#DetachLoadBalancerTargetGroupsResultType": { - "type": "structure", - "members": {} - }, - "com.amazonaws.autoscaling#DetachLoadBalancerTargetGroupsType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "TargetGroupARNs": { - "target": "com.amazonaws.autoscaling#TargetGroupARNs", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target\n groups.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#DetachLoadBalancers": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DetachLoadBalancersType" - }, - "output": { - "target": "com.amazonaws.autoscaling#DetachLoadBalancersResultType" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "\n

This API operation is superseded by DetachTrafficSources, which\n can detach multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DetachLoadBalancers. You can use both\n the original DetachLoadBalancers API operation and\n DetachTrafficSources on the same Auto Scaling group.

\n \n

Detaches one or more Classic Load Balancers from the specified Auto Scaling group.

\n

This operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or\n Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API instead.

\n

When you detach a load balancer, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the load balancer using the DescribeLoadBalancers API call. The instances remain running.

", - "smithy.api#examples": [ - { - "title": "To detach a load balancer from an Auto Scaling group", - "documentation": "This example detaches the specified load balancer from the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "LoadBalancerNames": ["my-load-balancer"] - } - } - ] - } - }, - "com.amazonaws.autoscaling#DetachLoadBalancersResultType": { - "type": "structure", - "members": {} - }, - "com.amazonaws.autoscaling#DetachLoadBalancersType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "LoadBalancerNames": { - "target": "com.amazonaws.autoscaling#LoadBalancerNames", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The names of the load balancers. You can specify up to 10 load balancers.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#DetachTrafficSources": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DetachTrafficSourcesType" - }, - "output": { - "target": "com.amazonaws.autoscaling#DetachTrafficSourcesResultType" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Detaches one or more traffic sources from the specified Auto Scaling group.

\n

When you detach a traffic source, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the traffic source using the DescribeTrafficSources API call. The instances continue to run.

", - "smithy.api#examples": [ - { - "title": "To detach a target group from an Auto Scaling group", - "documentation": "This example detaches the specified target group from the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "TrafficSources": [ + "target": "com.amazonaws.autoscaling#DescribeMetricCollectionTypes" + }, { - "Identifier": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" - } - ] - }, - "output": {} - } - ] - } - }, - "com.amazonaws.autoscaling#DetachTrafficSourcesResultType": { - "type": "structure", - "members": {} - }, - "com.amazonaws.autoscaling#DetachTrafficSourcesType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "TrafficSources": { - "target": "com.amazonaws.autoscaling#TrafficSources", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The unique identifiers of one or more traffic sources. You can specify up to 10\n traffic sources.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#DisableMetricsCollection": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#DisableMetricsCollectionQuery" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Disables group metrics collection for the specified Auto Scaling group.

", - "smithy.api#examples": [ - { - "title": "To disable metrics collection for an Auto Scaling group", - "documentation": "This example disables collecting data for the GroupDesiredCapacity metric for the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "Metrics": ["GroupDesiredCapacity"] - } - } - ] - } - }, - "com.amazonaws.autoscaling#DisableMetricsCollectionQuery": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "Metrics": { - "target": "com.amazonaws.autoscaling#Metrics", - "traits": { - "smithy.api#documentation": "

Identifies the metrics to disable.

\n

You can specify one or more of the following metrics:

\n \n

If you omit this property, all metrics are disabled.

\n

For more information, see Amazon CloudWatch metrics for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" - } - } - } - }, - "com.amazonaws.autoscaling#DisableScaleIn": { - "type": "boolean" - }, - "com.amazonaws.autoscaling#Ebs": { - "type": "structure", - "members": { - "SnapshotId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The snapshot ID of the volume to use.

\n

You must specify either a VolumeSize or a SnapshotId.

" - } - }, - "VolumeSize": { - "target": "com.amazonaws.autoscaling#BlockDeviceEbsVolumeSize", - "traits": { - "smithy.api#documentation": "

The volume size, in GiBs. The following are the supported volumes sizes for each\n volume type:

\n \n

You must specify either a SnapshotId or a VolumeSize. If you\n specify both SnapshotId and VolumeSize, the volume size must\n be equal or greater than the size of the snapshot.

" - } - }, - "VolumeType": { - "target": "com.amazonaws.autoscaling#BlockDeviceEbsVolumeType", - "traits": { - "smithy.api#documentation": "

The volume type. For more information, see Amazon EBS volume types in the\n Amazon EBS User Guide.

\n

Valid values: standard | io1 | gp2 |\n st1 | sc1 | gp3\n

" - } - }, - "DeleteOnTermination": { - "target": "com.amazonaws.autoscaling#BlockDeviceEbsDeleteOnTermination", - "traits": { - "smithy.api#documentation": "

Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the\n default value is true.

" - } - }, - "Iops": { - "target": "com.amazonaws.autoscaling#BlockDeviceEbsIops", - "traits": { - "smithy.api#documentation": "

The number of input/output (I/O) operations per second (IOPS) to provision for the\n volume. For gp3 and io1 volumes, this represents the number of\n IOPS that are provisioned for the volume. For gp2 volumes, this represents\n the baseline performance of the volume and the rate at which the volume accumulates I/O\n credits for bursting.

\n

The following are the supported values for each volume type:

\n \n

For io1 volumes, we guarantee 64,000 IOPS only for Instances built on the Amazon Web Services Nitro System. Other instance families\n guarantee performance up to 32,000 IOPS.

\n

\n Iops is supported when the volume type is gp3 or\n io1 and required only when the volume type is io1. (Not\n used with standard, gp2, st1, or sc1\n volumes.)

" - } - }, - "Encrypted": { - "target": "com.amazonaws.autoscaling#BlockDeviceEbsEncrypted", - "traits": { - "smithy.api#documentation": "

Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be\n attached to instances that support Amazon EBS encryption. For more information, see Requirements for Amazon EBS encryption in the Amazon EBS User Guide. If your AMI uses encrypted volumes, you\n can also only launch it on supported instance types.

\n \n

If you are creating a volume from a snapshot, you cannot create an unencrypted\n volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using\n a launch configuration.

\n

If you enable encryption by default, the EBS volumes that you create are always\n encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key,\n regardless of whether the snapshot was encrypted.

\n

For more information, see Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the\n Amazon EC2 Auto Scaling User Guide.

\n " - } - }, - "Throughput": { - "target": "com.amazonaws.autoscaling#BlockDeviceEbsThroughput", - "traits": { - "smithy.api#documentation": "

The throughput (MiBps) to provision for a gp3 volume.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes information used to set up an Amazon EBS volume specified in a block device\n mapping.

" - } - }, - "com.amazonaws.autoscaling#EbsOptimized": { - "type": "boolean" - }, - "com.amazonaws.autoscaling#EnableMetricsCollection": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#EnableMetricsCollectionQuery" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Enables group metrics collection for the specified Auto Scaling group.

\n

You can use these metrics to track changes in an Auto Scaling group and to set alarms on\n threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch\n console. For more information, see Monitor\n CloudWatch metrics for your Auto Scaling groups and instances in the\n Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To enable metrics collection for an Auto Scaling group", - "documentation": "This example enables data collection for the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "Granularity": "1Minute" - } - } - ] - } - }, - "com.amazonaws.autoscaling#EnableMetricsCollectionQuery": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "Metrics": { - "target": "com.amazonaws.autoscaling#Metrics", - "traits": { - "smithy.api#documentation": "

Identifies the metrics to enable.

\n

You can specify one or more of the following metrics:

\n \n

If you specify Granularity and don't specify any metrics, all metrics are\n enabled.

\n

For more information, see Amazon CloudWatch metrics for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "Granularity": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is\n 1Minute.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#EnabledMetric": { - "type": "structure", - "members": { - "Metric": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

One of the following metrics:

\n \n

For more information, see Amazon CloudWatch metrics for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "Granularity": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The granularity of the metric. The only valid value is 1Minute.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an enabled Auto Scaling group metric.

" - } - }, - "com.amazonaws.autoscaling#EnabledMetrics": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#EnabledMetric" - } - }, - "com.amazonaws.autoscaling#EnterStandby": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#EnterStandbyQuery" - }, - "output": { - "target": "com.amazonaws.autoscaling#EnterStandbyAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Moves the specified instances into the standby state.

\n

If you choose to decrement the desired capacity of the Auto Scaling group, the instances can\n enter standby as long as the desired capacity of the Auto Scaling group after the instances are\n placed into standby is equal to or greater than the minimum capacity of the\n group.

\n

If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group\n launches new instances to replace the instances on standby.

\n

For more information, see Temporarily removing\n instances from your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To move instances into standby mode", - "documentation": "This example puts the specified instance into standby mode.", + "target": "com.amazonaws.autoscaling#DescribeNotificationConfigurations" + }, + { + "target": "com.amazonaws.autoscaling#DescribePolicies" + }, + { + "target": "com.amazonaws.autoscaling#DescribeScalingActivities" + }, + { + "target": "com.amazonaws.autoscaling#DescribeScalingProcessTypes" + }, + { + "target": "com.amazonaws.autoscaling#DescribeScheduledActions" + }, + { + "target": "com.amazonaws.autoscaling#DescribeTags" + }, + { + "target": "com.amazonaws.autoscaling#DescribeTerminationPolicyTypes" + }, + { + "target": "com.amazonaws.autoscaling#DescribeTrafficSources" + }, + { + "target": "com.amazonaws.autoscaling#DescribeWarmPool" + }, + { + "target": "com.amazonaws.autoscaling#DetachInstances" + }, + { + "target": "com.amazonaws.autoscaling#DetachLoadBalancers" + }, + { + "target": "com.amazonaws.autoscaling#DetachLoadBalancerTargetGroups" + }, + { + "target": "com.amazonaws.autoscaling#DetachTrafficSources" + }, + { + "target": "com.amazonaws.autoscaling#DisableMetricsCollection" + }, + { + "target": "com.amazonaws.autoscaling#EnableMetricsCollection" + }, + { + "target": "com.amazonaws.autoscaling#EnterStandby" + }, + { + "target": "com.amazonaws.autoscaling#ExecutePolicy" + }, + { + "target": "com.amazonaws.autoscaling#ExitStandby" + }, + { + "target": "com.amazonaws.autoscaling#GetPredictiveScalingForecast" + }, + { + "target": "com.amazonaws.autoscaling#PutLifecycleHook" + }, + { + "target": "com.amazonaws.autoscaling#PutNotificationConfiguration" + }, + { + "target": "com.amazonaws.autoscaling#PutScalingPolicy" + }, + { + "target": "com.amazonaws.autoscaling#PutScheduledUpdateGroupAction" + }, + { + "target": "com.amazonaws.autoscaling#PutWarmPool" + }, + { + "target": "com.amazonaws.autoscaling#RecordLifecycleActionHeartbeat" + }, + { + "target": "com.amazonaws.autoscaling#ResumeProcesses" + }, + { + "target": "com.amazonaws.autoscaling#RollbackInstanceRefresh" + }, + { + "target": "com.amazonaws.autoscaling#SetDesiredCapacity" + }, + { + "target": "com.amazonaws.autoscaling#SetInstanceHealth" + }, + { + "target": "com.amazonaws.autoscaling#SetInstanceProtection" + }, + { + "target": "com.amazonaws.autoscaling#StartInstanceRefresh" + }, + { + "target": "com.amazonaws.autoscaling#SuspendProcesses" + }, + { + "target": "com.amazonaws.autoscaling#TerminateInstanceInAutoScalingGroup" + }, + { + "target": "com.amazonaws.autoscaling#UpdateAutoScalingGroup" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Auto Scaling", + "arnNamespace": "autoscaling", + "cloudFormationName": "AutoScaling", + "cloudTrailEventSource": "autoscaling.amazonaws.com", + "docId": "autoscaling-2011-01-01", + "endpointPrefix": "autoscaling" + }, + "aws.auth#sigv4": { + "name": "autoscaling" + }, + "aws.protocols#awsQuery": {}, + "smithy.api#documentation": "Amazon EC2 Auto Scaling\n

Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances\n based on user-defined scaling policies, scheduled actions, and health checks.

\n

For more information, see the Amazon EC2 Auto Scaling User Guide and the Amazon EC2 Auto Scaling API Reference.

", + "smithy.api#title": "Auto Scaling", + "smithy.api#xmlNamespace": { + "uri": "http://autoscaling.amazonaws.com/doc/2011-01-01/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://autoscaling-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + } + ], + "endpoint": { + "url": "https://autoscaling.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://autoscaling-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://autoscaling.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://autoscaling.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://autoscaling.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://autoscaling.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://autoscaling.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://autoscaling-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://autoscaling-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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling-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://autoscaling-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://autoscaling.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://autoscaling.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://autoscaling.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://autoscaling-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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling.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://autoscaling-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://autoscaling.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://autoscaling-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.autoscaling#AvailabilityZones": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" + } + }, + "com.amazonaws.autoscaling#BareMetal": { + "type": "enum", + "members": { + "INCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "included" + } + }, + "EXCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "excluded" + } + }, + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + } + } + }, + "com.amazonaws.autoscaling#BaselineEbsBandwidthMbpsRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.autoscaling#NullablePositiveInteger", + "traits": { + "smithy.api#documentation": "

The minimum value in Mbps.

" + } + }, + "Max": { + "target": "com.amazonaws.autoscaling#NullablePositiveInteger", + "traits": { + "smithy.api#documentation": "

The maximum value in Mbps.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the minimum and maximum for the BaselineEbsBandwidthMbps object\n when you specify InstanceRequirements for an Auto Scaling group.

" + } + }, + "com.amazonaws.autoscaling#BatchDeleteScheduledAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#BatchDeleteScheduledActionType" + }, + "output": { + "target": "com.amazonaws.autoscaling#BatchDeleteScheduledActionAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes one or more scheduled actions for the specified Auto Scaling group.

" + } + }, + "com.amazonaws.autoscaling#BatchDeleteScheduledActionAnswer": { + "type": "structure", + "members": { + "FailedScheduledActions": { + "target": "com.amazonaws.autoscaling#FailedScheduledUpdateGroupActionRequests", + "traits": { + "smithy.api#documentation": "

The names of the scheduled actions that could not be deleted, including an error\n message.

" + } + } + } + }, + "com.amazonaws.autoscaling#BatchDeleteScheduledActionType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "ScheduledActionNames": { + "target": "com.amazonaws.autoscaling#ScheduledActionNames", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The names of the scheduled actions to delete. The maximum number allowed is 50.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#BatchPutScheduledUpdateGroupAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#BatchPutScheduledUpdateGroupActionType" + }, + "output": { + "target": "com.amazonaws.autoscaling#BatchPutScheduledUpdateGroupActionAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#AlreadyExistsFault" + }, + { + "target": "com.amazonaws.autoscaling#LimitExceededFault" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates one or more scheduled scaling actions for an Auto Scaling group.

" + } + }, + "com.amazonaws.autoscaling#BatchPutScheduledUpdateGroupActionAnswer": { + "type": "structure", + "members": { + "FailedScheduledUpdateGroupActions": { + "target": "com.amazonaws.autoscaling#FailedScheduledUpdateGroupActionRequests", + "traits": { + "smithy.api#documentation": "

The names of the scheduled actions that could not be created or updated, including an\n error message.

" + } + } + } + }, + "com.amazonaws.autoscaling#BatchPutScheduledUpdateGroupActionType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "ScheduledUpdateGroupActions": { + "target": "com.amazonaws.autoscaling#ScheduledUpdateGroupActionRequests", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

One or more scheduled actions. The maximum number allowed is 50.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#BlockDeviceEbsDeleteOnTermination": { + "type": "boolean" + }, + "com.amazonaws.autoscaling#BlockDeviceEbsEncrypted": { + "type": "boolean" + }, + "com.amazonaws.autoscaling#BlockDeviceEbsIops": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 100, + "max": 20000 + } + } + }, + "com.amazonaws.autoscaling#BlockDeviceEbsThroughput": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 125, + "max": 1000 + } + } + }, + "com.amazonaws.autoscaling#BlockDeviceEbsVolumeSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 16384 + } + } + }, + "com.amazonaws.autoscaling#BlockDeviceEbsVolumeType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.autoscaling#BlockDeviceMapping": { + "type": "structure", + "members": { + "VirtualName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the instance store volume (virtual device) to attach to an instance at\n launch. The name must be in the form ephemeralX where\n X is a number starting from zero (0), for example,\n ephemeral0.

" + } + }, + "DeviceName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The device name assigned to the volume (for example, /dev/sdh or\n xvdh). For more information, see Device naming on Linux\n instances in the Amazon EC2 User Guide for Linux Instances.

\n \n

To define a block device mapping, set the device name and exactly one of the\n following properties: Ebs, NoDevice, or\n VirtualName.

\n ", + "smithy.api#required": {} + } + }, + "Ebs": { + "target": "com.amazonaws.autoscaling#Ebs", + "traits": { + "smithy.api#documentation": "

Information to attach an EBS volume to an instance at launch.

" + } + }, + "NoDevice": { + "target": "com.amazonaws.autoscaling#NoDevice", + "traits": { + "smithy.api#documentation": "

Setting this value to true prevents a volume that is included in the\n block device mapping of the AMI from being mapped to the specified device name at\n launch.

\n

If NoDevice is true for the root device, instances might\n fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches replacement instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a block device mapping.

" + } + }, + "com.amazonaws.autoscaling#BlockDeviceMappings": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#BlockDeviceMapping" + } + }, + "com.amazonaws.autoscaling#BurstablePerformance": { + "type": "enum", + "members": { + "INCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "included" + } + }, + "EXCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "excluded" + } + }, + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + } + } + }, + "com.amazonaws.autoscaling#CancelInstanceRefresh": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#CancelInstanceRefreshType" + }, + "output": { + "target": "com.amazonaws.autoscaling#CancelInstanceRefreshAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ActiveInstanceRefreshNotFoundFault" + }, + { + "target": "com.amazonaws.autoscaling#LimitExceededFault" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels an instance refresh or rollback that is in progress. If an instance refresh or\n rollback is not in progress, an ActiveInstanceRefreshNotFound error\n occurs.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group\n after you make configuration changes.

\n

When you cancel an instance refresh, this does not roll back any changes that it made.\n Use the RollbackInstanceRefresh API to roll back instead.

", + "smithy.api#examples": [ + { + "title": "To cancel an instance refresh", + "documentation": "This example cancels an instance refresh operation in progress.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "InstanceRefreshId": "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b" + } + } + ] + } + }, + "com.amazonaws.autoscaling#CancelInstanceRefreshAnswer": { + "type": "structure", + "members": { + "InstanceRefreshId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The instance refresh ID associated with the request. This is the unique ID assigned to\n the instance refresh when it was started.

" + } + } + } + }, + "com.amazonaws.autoscaling#CancelInstanceRefreshType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#CapacityForecast": { + "type": "structure", + "members": { + "Timestamps": { + "target": "com.amazonaws.autoscaling#PredictiveScalingForecastTimestamps", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The timestamps for the data points, in UTC format.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.autoscaling#PredictiveScalingForecastValues", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The values of the data points.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A GetPredictiveScalingForecast call returns the capacity forecast for a\n predictive scaling policy. This structure includes the data points for that capacity\n forecast, along with the timestamps of those data points.

" + } + }, + "com.amazonaws.autoscaling#CapacityRebalanceEnabled": { + "type": "boolean" + }, + "com.amazonaws.autoscaling#CheckpointDelay": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 172800 + } + } + }, + "com.amazonaws.autoscaling#CheckpointPercentages": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#NonZeroIntPercent" + } + }, + "com.amazonaws.autoscaling#ClassicLinkVPCSecurityGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" + } + }, + "com.amazonaws.autoscaling#CompleteLifecycleAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#CompleteLifecycleActionType" + }, + "output": { + "target": "com.amazonaws.autoscaling#CompleteLifecycleActionAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Completes the lifecycle action for the specified token or instance with the specified\n result.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.

    \n
    2. \n
  2. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.

    \n
    3. \n
  3. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    4. \n
  4. \n

    Create the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.

    \n
    5. \n
  5. \n

    If you need more time, record the lifecycle action heartbeat to keep the\n instance in a wait state.

    \n
    6. \n
  6. \n

    \n If you finish before the timeout period ends, send a\n callback by using the CompleteLifecycleAction API\n call.\n

    \n
    7. \n
\n

For more information, see Complete a lifecycle\n action in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To complete the lifecycle action", + "documentation": "This example notifies Auto Scaling that the specified lifecycle action is complete so that it can finish launching or terminating the instance.", + "input": { + "LifecycleHookName": "my-lifecycle-hook", + "AutoScalingGroupName": "my-auto-scaling-group", + "LifecycleActionToken": "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635", + "LifecycleActionResult": "CONTINUE" + } + } + ] + } + }, + "com.amazonaws.autoscaling#CompleteLifecycleActionAnswer": { + "type": "structure", + "members": {} + }, + "com.amazonaws.autoscaling#CompleteLifecycleActionType": { + "type": "structure", + "members": { + "LifecycleHookName": { + "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the lifecycle hook.

", + "smithy.api#required": {} + } + }, + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "LifecycleActionToken": { + "target": "com.amazonaws.autoscaling#LifecycleActionToken", + "traits": { + "smithy.api#documentation": "

A universally unique identifier (UUID) that identifies a specific lifecycle action\n associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you\n specified when you created the lifecycle hook.

" + } + }, + "LifecycleActionResult": { + "target": "com.amazonaws.autoscaling#LifecycleActionResult", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The action for the group to take. You can specify either CONTINUE or\n ABANDON.

", + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", + "traits": { + "smithy.api#documentation": "

The ID of the instance.

" + } + } + } + }, + "com.amazonaws.autoscaling#Context": { + "type": "string" + }, + "com.amazonaws.autoscaling#Cooldown": { + "type": "integer" + }, + "com.amazonaws.autoscaling#CpuManufacturer": { + "type": "enum", + "members": { + "INTEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "intel" + } + }, + "AMD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amd" + } + }, + "AMAZON_WEB_SERVICES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "amazon-web-services" + } + } + } + }, + "com.amazonaws.autoscaling#CpuManufacturers": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#CpuManufacturer" + } + }, + "com.amazonaws.autoscaling#CreateAutoScalingGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#CreateAutoScalingGroupType" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#AlreadyExistsFault" + }, + { + "target": "com.amazonaws.autoscaling#LimitExceededFault" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + }, + { + "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" + } + ], + "traits": { + "smithy.api#documentation": "

\n We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n

\n

Creates an Auto Scaling group with the specified name and attributes.

\n

If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit,\n call the DescribeAccountLimits API. For information about updating\n this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

If you're new to Amazon EC2 Auto Scaling, see the introductory tutorials in Get started\n with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

Every Auto Scaling group has three size properties (DesiredCapacity,\n MaxSize, and MinSize). Usually, you set these sizes based\n on a specific number of instances. However, if you configure a mixed instances policy\n that defines weights for the instance types, you must specify these sizes with the same\n units that you use for weighting instances.

", + "smithy.api#examples": [ + { + "title": "To create an Auto Scaling group with an attached target group", + "documentation": "This example creates an Auto Scaling group and attaches the specified target group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LaunchTemplate": { + "LaunchTemplateName": "my-template-for-auto-scaling", + "Version": "$Default" + }, + "MinSize": 1, + "MaxSize": 3, + "TargetGroupARNs": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + ], + "HealthCheckType": "ELB", + "HealthCheckGracePeriod": 300, + "VPCZoneIdentifier": "subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE" + } + }, + { + "title": "To create an Auto Scaling group with a mixed instances policy", + "documentation": "This example creates an Auto Scaling group with a mixed instances policy. It specifies the c5.large, c5a.large, and c6g.large instance types and defines a different launch template for the c6g.large instance type.", + "input": { + "AutoScalingGroupName": "my-asg", + "MixedInstancesPolicy": { + "LaunchTemplate": { + "LaunchTemplateSpecification": { + "LaunchTemplateName": "my-launch-template-for-x86", + "Version": "$Default" + }, + "Overrides": [ + { + "InstanceType": "c6g.large", + "LaunchTemplateSpecification": { + "LaunchTemplateName": "my-launch-template-for-arm", + "Version": "$Default" + } + }, + { + "InstanceType": "c5.large" + }, + { + "InstanceType": "c5a.large" + } + ] + }, + "InstancesDistribution": { + "OnDemandBaseCapacity": 1, + "OnDemandPercentageAboveBaseCapacity": 50, + "SpotAllocationStrategy": "price-capacity-optimized" + } + }, + "MinSize": 1, + "MaxSize": 5, + "DesiredCapacity": 3, + "VPCZoneIdentifier": "subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE" + } + }, + { + "title": "To create an Auto Scaling group using attribute-based instance type selection", + "documentation": "This example creates an Auto Scaling group using attribute-based instance type selection. It requires the instance types to have a minimum of four vCPUs and a maximum of eight vCPUs, a minimum of 16,384 MiB of memory, and an Intel manufactured CPU.", + "input": { + "AutoScalingGroupName": "my-asg", + "MixedInstancesPolicy": { + "LaunchTemplate": { + "LaunchTemplateSpecification": { + "LaunchTemplateName": "my-template-for-auto-scaling", + "Version": "$Default" + }, + "Overrides": [ + { + "InstanceRequirements": { + "VCpuCount": { + "Min": 4, + "Max": 8 + }, + "MemoryMiB": { + "Min": 16384 + }, + "CpuManufacturers": [ + "intel" + ] + } + } + ] + }, + "InstancesDistribution": { + "OnDemandPercentageAboveBaseCapacity": 50, + "SpotAllocationStrategy": "price-capacity-optimized" + } + }, + "MinSize": 0, + "MaxSize": 100, + "DesiredCapacity": 4, + "DesiredCapacityType": "units", + "VPCZoneIdentifier": "subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE" + } + }, + { + "title": "To create an Auto Scaling group", + "documentation": "This example creates an Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LaunchTemplate": { + "LaunchTemplateName": "my-template-for-auto-scaling", + "Version": "$Default" + }, + "MinSize": 1, + "MaxSize": 3, + "MaxInstanceLifetime": 2592000, + "DefaultInstanceWarmup": 120, + "VPCZoneIdentifier": "subnet-057fa0918fEXAMPLE" + } + } + ] + } + }, + "com.amazonaws.autoscaling#CreateAutoScalingGroupType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group. This name must be unique per Region per account.

\n

The name can contain any ASCII character 33 to 126 including most punctuation\n characters, digits, and upper and lowercased letters.

\n \n

You cannot use a colon (:) in the name.

\n ", + "smithy.api#required": {} + } + }, + "LaunchConfigurationName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the launch configuration to use to launch instances.

\n

Conditional: You must specify either a launch template (LaunchTemplate or\n MixedInstancesPolicy) or a launch configuration\n (LaunchConfigurationName or InstanceId).

" + } + }, + "LaunchTemplate": { + "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", + "traits": { + "smithy.api#documentation": "

Information used to specify the launch template and version to use to launch\n instances.

\n

Conditional: You must specify either a launch template (LaunchTemplate or\n MixedInstancesPolicy) or a launch configuration\n (LaunchConfigurationName or InstanceId).

\n \n

The launch template that is specified must be configured for use with an Auto Scaling\n group. For more information, see Create a launch\n template for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n " + } + }, + "MixedInstancesPolicy": { + "target": "com.amazonaws.autoscaling#MixedInstancesPolicy", + "traits": { + "smithy.api#documentation": "

The mixed instances policy. For more information, see Auto Scaling\n groups with multiple instance types and purchase options in the\n Amazon EC2 Auto Scaling User Guide.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", + "traits": { + "smithy.api#documentation": "

The ID of the instance used to base the launch configuration on. If specified, Amazon\n EC2 Auto Scaling uses the configuration values from the specified instance to create a\n new launch configuration. To get the instance ID, use the Amazon EC2 DescribeInstances API operation. For more information, see Create an Auto Scaling group using parameters from an existing instance in the\n Amazon EC2 Auto Scaling User Guide.

" + } + }, + "MinSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The minimum size of the group.

", + "smithy.api#required": {} + } + }, + "MaxSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The maximum size of the group.

\n \n

With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to\n go above MaxSize to meet your capacity requirements. In this event,\n Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance\n weight (weights that define how many units each instance contributes to the desired\n capacity of the group).

\n ", + "smithy.api#required": {} + } + }, + "DesiredCapacity": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", + "traits": { + "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group at the time of its\n creation and the capacity it attempts to maintain. It can scale beyond this capacity if\n you configure auto scaling. This number must be greater than or equal to the minimum\n size of the group and less than or equal to the maximum size of the group. If you do not\n specify a desired capacity, the default is the minimum size of the group.

" + } + }, + "DefaultCooldown": { + "target": "com.amazonaws.autoscaling#Cooldown", + "traits": { + "smithy.api#documentation": "

\n Only needed if you use simple scaling policies.\n

\n

The amount of time, in seconds, between one scaling activity ending and another one\n starting due to simple scaling policies. For more information, see Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

Default: 300 seconds

" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.autoscaling#AvailabilityZones", + "traits": { + "smithy.api#documentation": "

A list of Availability Zones where instances in the Auto Scaling group can be created. Used\n for launching into the default VPC subnet in each Availability Zone when not using the\n VPCZoneIdentifier property, or for attaching a network interface when\n an existing network interface ID is specified in a launch template.

" + } + }, + "LoadBalancerNames": { + "target": "com.amazonaws.autoscaling#LoadBalancerNames", + "traits": { + "smithy.api#documentation": "

A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers,\n specify the TargetGroupARNs property instead.

" + } + }, + "TargetGroupARNs": { + "target": "com.amazonaws.autoscaling#TargetGroupARNs", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling\n group. Instances are registered as targets with the target groups. The target groups\n receive incoming traffic and route requests to one or more registered targets. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

" + } + }, + "HealthCheckType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", + "traits": { + "smithy.api#documentation": "

A comma-separated value string of one or more health check types.

\n

The valid values are EC2, EBS, ELB, and\n VPC_LATTICE. EC2 is the default health check and cannot be\n disabled. For more information, see Health checks\n for instances in an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n

Only specify EC2 if you must clear a value that was previously\n set.

" + } + }, + "HealthCheckGracePeriod": { + "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n health check. This is useful if your instances do not immediately pass their health\n checks after they enter the InService state. For more information, see\n Set the health check\n grace period for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n

Default: 0 seconds

" + } + }, + "PlacementGroup": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the placement group into which to launch your instances. For more\n information, see Placement groups in the\n Amazon EC2 User Guide for Linux Instances.

\n \n

A cluster placement group is a logical grouping of instances\n within a single Availability Zone. You cannot specify multiple Availability Zones\n and a cluster placement group.

\n " + } + }, + "VPCZoneIdentifier": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen5000", + "traits": { + "smithy.api#documentation": "

A comma-separated list of subnet IDs for a virtual private cloud (VPC) where instances\n in the Auto Scaling group can be created. If you specify VPCZoneIdentifier with\n AvailabilityZones, the subnets that you specify must reside in those\n Availability Zones.

" + } + }, + "TerminationPolicies": { + "target": "com.amazonaws.autoscaling#TerminationPolicies", + "traits": { + "smithy.api#documentation": "

A policy or a list of policies that are used to select the instance to terminate.\n These policies are executed in the order that you list them. For more information, see\n Configure\n termination policies for Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.

\n

Valid values: Default | AllocationStrategy |\n ClosestToNextInstanceHour | NewestInstance |\n OldestInstance | OldestLaunchConfiguration |\n OldestLaunchTemplate |\n arn:aws:lambda:region:account-id:function:my-function:my-alias\n

" + } + }, + "NewInstancesProtectedFromScaleIn": { + "target": "com.amazonaws.autoscaling#InstanceProtected", + "traits": { + "smithy.api#documentation": "

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in. For more information about preventing instances from terminating on\n scale in, see Use\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.

" + } + }, + "CapacityRebalance": { + "target": "com.amazonaws.autoscaling#CapacityRebalanceEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is\n disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot\n Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of\n interruption. After launching a new instance, it then terminates an old instance. For\n more information, see Use Capacity\n Rebalancing to handle Amazon EC2 Spot Interruptions in the in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "LifecycleHookSpecificationList": { + "target": "com.amazonaws.autoscaling#LifecycleHookSpecifications", + "traits": { + "smithy.api#documentation": "

One or more lifecycle hooks to add to the Auto Scaling group before instances are\n launched.

" + } + }, + "Tags": { + "target": "com.amazonaws.autoscaling#Tags", + "traits": { + "smithy.api#documentation": "

One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2\n instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS\n volumes, specify the tags in a launch template but use caution. If the launch template\n specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling\n overrides the value of that instance tag with the value specified by the Auto Scaling group. For\n more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "ServiceLinkedRoleARN": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other Amazon Web Services service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role\n named AWSServiceRoleForAutoScaling, which it creates if it does not exist.\n For more information, see Service-linked\n roles in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "MaxInstanceLifetime": { + "target": "com.amazonaws.autoscaling#MaxInstanceLifetime", + "traits": { + "smithy.api#documentation": "

The maximum amount of time, in seconds, that an instance can be in service. The\n default is null. If specified, the value must be either 0 or a number equal to or\n greater than 86,400 seconds (1 day). For more information, see Replace Auto Scaling instances based on maximum instance lifetime in the\n Amazon EC2 Auto Scaling User Guide.

" + } + }, + "Context": { + "target": "com.amazonaws.autoscaling#Context", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } + }, + "DesiredCapacityType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only. For more information, see Create a mixed instances group using attribute-based instance type\n selection in the Amazon EC2 Auto Scaling User Guide.

\n

By default, Amazon EC2 Auto Scaling specifies units, which translates into number of\n instances.

\n

Valid values: units | vcpu | memory-mib\n

" + } + }, + "DefaultInstanceWarmup": { + "target": "com.amazonaws.autoscaling#DefaultInstanceWarmup", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, until a new instance is considered to have finished\n initializing and resource consumption to become stable after it enters the\n InService state.

\n

During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an\n instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the\n warm-up period before aggregating the metrics for new instances with existing instances\n in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage\n data. For more information, see Set\n the default instance warmup for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n \n

To manage various warm-up settings at the group level, we recommend that you set\n the default instance warmup, even if it is set to 0 seconds. To\n remove a value that you previously set, include the property but specify\n -1 for the value. However, we strongly recommend keeping the\n default instance warmup enabled by specifying a value of 0 or other\n nominal value.

\n \n

Default: None

" + } + }, + "TrafficSources": { + "target": "com.amazonaws.autoscaling#TrafficSources", + "traits": { + "smithy.api#documentation": "

The list of traffic sources to attach to this Auto Scaling group. You can use any of the\n following as traffic sources for an Auto Scaling group: Classic Load Balancer, Application Load Balancer, Gateway Load Balancer, Network Load Balancer, and\n VPC Lattice.

" + } + }, + "InstanceMaintenancePolicy": { + "target": "com.amazonaws.autoscaling#InstanceMaintenancePolicy", + "traits": { + "smithy.api#documentation": "

An instance maintenance policy. For more information, see Set instance maintenance policy in the\n Amazon EC2 Auto Scaling User Guide.

" + } + } + } + }, + "com.amazonaws.autoscaling#CreateLaunchConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#CreateLaunchConfigurationType" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#AlreadyExistsFault" + }, + { + "target": "com.amazonaws.autoscaling#LimitExceededFault" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a launch configuration.

\n

If you exceed your maximum limit of launch configurations, the call fails. To query\n this limit, call the DescribeAccountLimits API. For information about\n updating this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

For more information, see Launch\n configurations in the Amazon EC2 Auto Scaling User Guide.

\n \n

Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a\n launch template or a launch configuration. We strongly recommend that you do not use\n launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2.\n For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.

\n ", + "smithy.api#examples": [ + { + "title": "To create a launch configuration", + "documentation": "This example creates a launch configuration.", + "input": { + "LaunchConfigurationName": "my-launch-config", + "ImageId": "ami-12345678", + "SecurityGroups": [ + "sg-eb2af88e" + ], + "InstanceType": "m3.medium", + "IamInstanceProfile": "my-iam-role" + } + } + ] + } + }, + "com.amazonaws.autoscaling#CreateLaunchConfigurationType": { + "type": "structure", + "members": { + "LaunchConfigurationName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the launch configuration. This name must be unique per Region per\n account.

", + "smithy.api#required": {} + } + }, + "ImageId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) that was assigned during registration. For\n more information, see Find a Linux AMI in the\n Amazon EC2 User Guide for Linux Instances.

\n

If you specify InstanceId, an ImageId is not\n required.

" + } + }, + "KeyName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the key pair. For more information, see Amazon EC2 key pairs and Amazon EC2\n instances in the Amazon EC2 User Guide for Linux Instances.

" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.autoscaling#SecurityGroups", + "traits": { + "smithy.api#documentation": "

A list that contains the security group IDs to assign to the instances in the Auto Scaling\n group. For more information, see Control traffic to your Amazon Web Services\n resources using security groups in the Amazon Virtual Private\n Cloud User Guide.

" + } + }, + "ClassicLinkVPCId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

Available for backward compatibility.

" + } + }, + "ClassicLinkVPCSecurityGroups": { + "target": "com.amazonaws.autoscaling#ClassicLinkVPCSecurityGroups", + "traits": { + "smithy.api#documentation": "

Available for backward compatibility.

" + } + }, + "UserData": { + "target": "com.amazonaws.autoscaling#XmlStringUserData", + "traits": { + "smithy.api#documentation": "

The user data to make available to the launched EC2 instances. For more information,\n see Instance metadata and user data (Linux) and Instance metadata and\n user data (Windows). If you are using a command line tool, base64-encoding\n is performed for you, and you can load the text from a file. Otherwise, you must provide\n base64-encoded text. User data is limited to 16 KB.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", + "traits": { + "smithy.api#documentation": "

The ID of the instance to use to create the launch configuration. The new launch\n configuration derives attributes from the instance, except for the block device\n mapping.

\n

To create a launch configuration with a block device mapping or override any other\n instance attributes, specify them as part of the same request.

\n

For more information, see Create a launch\n configuration in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

Specifies the instance type of the EC2 instance. For information about available\n instance types, see Available\n instance types in the Amazon EC2 User Guide for Linux Instances.

\n

If you specify InstanceId, an InstanceType is not\n required.

" + } + }, + "KernelId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The ID of the kernel associated with the AMI.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide for Linux Instances.

\n " + } + }, + "RamdiskId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The ID of the RAM disk to select.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide for Linux Instances.

\n " + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.autoscaling#BlockDeviceMappings", + "traits": { + "smithy.api#documentation": "

The block device mapping entries that define the block devices to attach to the\n instances at launch. By default, the block devices specified in the block device mapping\n for the AMI are used. For more information, see Block device\n mappings in the Amazon EC2 User Guide for Linux Instances.

" + } + }, + "InstanceMonitoring": { + "target": "com.amazonaws.autoscaling#InstanceMonitoring", + "traits": { + "smithy.api#documentation": "

Controls whether instances in this group are launched with detailed\n (true) or basic (false) monitoring.

\n

The default value is true (enabled).

\n \n

When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and\n your account is charged a fee. When you disable detailed monitoring, CloudWatch generates\n metrics every 5 minutes. For more information, see Configure\n monitoring for Auto Scaling instances in the\n Amazon EC2 Auto Scaling User Guide.

\n " + } + }, + "SpotPrice": { + "target": "com.amazonaws.autoscaling#SpotPrice", + "traits": { + "smithy.api#documentation": "

The maximum hourly price to be paid for any Spot Instance launched to fulfill the\n request. Spot Instances are launched when the price you specify exceeds the current Spot\n price. For more information, see Request Spot\n Instances for fault-tolerant and flexible applications in the\n Amazon EC2 Auto Scaling User Guide.

\n

Valid Range: Minimum value of 0.001

\n \n

When you change your maximum price by creating a new launch configuration, running\n instances will continue to run as long as the maximum price for those running\n instances is higher than the current Spot price.

\n " + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen1600", + "traits": { + "smithy.api#documentation": "

The name or the Amazon Resource Name (ARN) of the instance profile associated with the\n IAM role for the instance. The instance profile contains the IAM role. For more\n information, see IAM role for applications that run\n on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.autoscaling#EbsOptimized", + "traits": { + "smithy.api#documentation": "

Specifies whether the launch configuration is optimized for EBS I/O\n (true) or not (false). The optimization provides dedicated\n throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O\n performance. This optimization is not available with all instance types. Additional fees\n are incurred when you enable EBS optimization for an instance type that is not\n EBS-optimized by default. For more information, see Amazon EBS-optimized instances\n in the Amazon EC2 User Guide for Linux Instances.

\n

The default value is false.

" + } + }, + "AssociatePublicIpAddress": { + "target": "com.amazonaws.autoscaling#AssociatePublicIpAddress", + "traits": { + "smithy.api#documentation": "

Specifies whether to assign a public IPv4 address to the group's instances. If the\n instance is launched into a default subnet, the default is to assign a public IPv4\n address, unless you disabled the option to assign a public IPv4 address on the subnet.\n If the instance is launched into a nondefault subnet, the default is not to assign a\n public IPv4 address, unless you enabled the option to assign a public IPv4 address on\n the subnet.

\n

If you specify true, each instance in the Auto Scaling group receives a unique\n public IPv4 address. For more information, see Provide network connectivity for\n your Auto Scaling instances using Amazon VPC in the\n Amazon EC2 Auto Scaling User Guide.

\n

If you specify this property, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.

" + } + }, + "PlacementTenancy": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", + "traits": { + "smithy.api#documentation": "

The tenancy of the instance, either default or dedicated. An\n instance with dedicated tenancy runs on isolated, single-tenant hardware\n and can only be launched into a VPC. To launch dedicated instances into a shared tenancy\n VPC (a VPC with the instance placement tenancy attribute set to default),\n you must set the value of this property to dedicated.

\n

If you specify PlacementTenancy, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.

\n

Valid values: default | dedicated\n

" + } + }, + "MetadataOptions": { + "target": "com.amazonaws.autoscaling#InstanceMetadataOptions", + "traits": { + "smithy.api#documentation": "

The metadata options for the instances. For more information, see Configure the instance metadata options in the\n Amazon EC2 Auto Scaling User Guide.

" + } + } + } + }, + "com.amazonaws.autoscaling#CreateOrUpdateTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#CreateOrUpdateTagsType" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#AlreadyExistsFault" + }, + { + "target": "com.amazonaws.autoscaling#LimitExceededFault" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + }, + { + "target": "com.amazonaws.autoscaling#ResourceInUseFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates tags for the specified Auto Scaling group.

\n

When you specify a tag with a key that already exists, the operation overwrites the\n previous tag definition, and you do not get an error message.

\n

For more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To create or update tags for an Auto Scaling group", + "documentation": "This example adds two tags to the specified Auto Scaling group.", + "input": { + "Tags": [ + { + "ResourceId": "my-auto-scaling-group", + "ResourceType": "auto-scaling-group", + "Key": "Role", + "Value": "WebServer", + "PropagateAtLaunch": true + }, + { + "ResourceId": "my-auto-scaling-group", + "ResourceType": "auto-scaling-group", + "Key": "Dept", + "Value": "Research", + "PropagateAtLaunch": true + } + ] + } + } + ] + } + }, + "com.amazonaws.autoscaling#CreateOrUpdateTagsType": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.autoscaling#Tags", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

One or more tags.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#CustomizedMetricSpecification": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.autoscaling#MetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric. To get the exact metric name, namespace, and dimensions,\n inspect the Metric object\n that is returned by a call to ListMetrics.

" + } + }, + "Namespace": { + "target": "com.amazonaws.autoscaling#MetricNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the metric.

" + } + }, + "Dimensions": { + "target": "com.amazonaws.autoscaling#MetricDimensions", + "traits": { + "smithy.api#documentation": "

The dimensions of the metric.

\n

Conditional: If you published your metric with dimensions, you must specify the same\n dimensions in your scaling policy.

" + } + }, + "Statistic": { + "target": "com.amazonaws.autoscaling#MetricStatistic", + "traits": { + "smithy.api#documentation": "

The statistic of the metric.

" + } + }, + "Unit": { + "target": "com.amazonaws.autoscaling#MetricUnit", + "traits": { + "smithy.api#documentation": "

The unit of the metric. For a complete list of the units that CloudWatch supports, see the\n MetricDatum\n data type in the Amazon CloudWatch API Reference.

" + } + }, + "Metrics": { + "target": "com.amazonaws.autoscaling#TargetTrackingMetricDataQueries", + "traits": { + "smithy.api#documentation": "

The metrics to include in the target tracking scaling policy, as a metric data query.\n This can include both raw metric and metric math expressions.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use\n with Amazon EC2 Auto Scaling.

\n

To create your customized metric specification:

\n \n

For more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts.

\n \n

Each individual service provides information about the metrics, namespace, and\n dimensions they use. For more information, see Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.

\n " + } + }, + "com.amazonaws.autoscaling#DefaultInstanceWarmup": { + "type": "integer" + }, + "com.amazonaws.autoscaling#DeleteAutoScalingGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DeleteAutoScalingGroupType" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + }, + { + "target": "com.amazonaws.autoscaling#ResourceInUseFault" + }, + { + "target": "com.amazonaws.autoscaling#ScalingActivityInProgressFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified Auto Scaling group.

\n

If the group has instances or scaling activities in progress, you must specify the\n option to force the deletion in order for it to succeed. The force delete operation will\n also terminate the EC2 instances. If the group has a warm pool, the force delete option\n also deletes the warm pool.

\n

To remove instances from the Auto Scaling group before deleting it, call the DetachInstances API with the list of instances and the option to\n decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement\n instances.

\n

To terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity\n of the Auto Scaling group to\n zero.

\n

If the group has scaling policies, deleting the group deletes the policies, the\n underlying alarm actions, and any alarm that no longer has an associated action.

\n

For more information, see Delete your Auto Scaling\n infrastructure in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To delete an Auto Scaling group", + "documentation": "This example deletes the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + } + }, + { + "title": "To delete an Auto Scaling group and all its instances", + "documentation": "This example deletes the specified Auto Scaling group and all its instances.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "ForceDelete": true + } + } + ] + } + }, + "com.amazonaws.autoscaling#DeleteAutoScalingGroupType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "ForceDelete": { + "target": "com.amazonaws.autoscaling#ForceDelete", + "traits": { + "smithy.api#documentation": "

Specifies that the group is to be deleted along with all instances associated with the\n group, without waiting for all instances to be terminated. This action also deletes any\n outstanding lifecycle actions associated with the group.

" + } + } + } + }, + "com.amazonaws.autoscaling#DeleteLaunchConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#LaunchConfigurationNameType" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + }, + { + "target": "com.amazonaws.autoscaling#ResourceInUseFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified launch configuration.

\n

The launch configuration must not be attached to an Auto Scaling group. When this call\n completes, the launch configuration is no longer available for use.

", + "smithy.api#examples": [ + { + "title": "To delete a launch configuration", + "documentation": "This example deletes the specified launch configuration.", + "input": { + "LaunchConfigurationName": "my-launch-config" + } + } + ] + } + }, + "com.amazonaws.autoscaling#DeleteLifecycleHook": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DeleteLifecycleHookType" + }, + "output": { + "target": "com.amazonaws.autoscaling#DeleteLifecycleHookAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified lifecycle hook.

\n

If there are any outstanding lifecycle actions, they are completed first\n (ABANDON for launching instances, CONTINUE for terminating\n instances).

", + "smithy.api#examples": [ + { + "title": "To delete a lifecycle hook", + "documentation": "This example deletes the specified lifecycle hook.", + "input": { + "LifecycleHookName": "my-lifecycle-hook", + "AutoScalingGroupName": "my-auto-scaling-group" + } + } + ] + } + }, + "com.amazonaws.autoscaling#DeleteLifecycleHookAnswer": { + "type": "structure", + "members": {} + }, + "com.amazonaws.autoscaling#DeleteLifecycleHookType": { + "type": "structure", + "members": { + "LifecycleHookName": { + "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the lifecycle hook.

", + "smithy.api#required": {} + } + }, + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#DeleteNotificationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DeleteNotificationConfigurationType" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified notification.

", + "smithy.api#examples": [ + { + "title": "To delete an Auto Scaling notification", + "documentation": "This example deletes the specified notification from the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic" + } + } + ] + } + }, + "com.amazonaws.autoscaling#DeleteNotificationConfigurationType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "TopicARN": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SNS topic.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#DeletePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DeletePolicyType" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + }, + { + "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified scaling policy.

\n

Deleting either a step scaling policy or a simple scaling policy deletes the\n underlying alarm action, but does not delete the alarm, even if it no longer has an\n associated action.

\n

For more information, see Delete a scaling\n policy in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To delete an Auto Scaling policy", + "documentation": "This example deletes the specified Auto Scaling policy.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyName": "my-step-scale-out-policy" + } + } + ] + } + }, + "com.amazonaws.autoscaling#DeletePolicyType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the Auto Scaling group.

" + } + }, + "PolicyName": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the policy.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#DeleteScheduledAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DeleteScheduledActionType" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified scheduled action.

", + "smithy.api#examples": [ + { + "title": "To delete a scheduled action from an Auto Scaling group", + "documentation": "This example deletes the specified scheduled action from the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "ScheduledActionName": "my-scheduled-action" + } + } + ] + } + }, + "com.amazonaws.autoscaling#DeleteScheduledActionType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "ScheduledActionName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the action to delete.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#DeleteTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DeleteTagsType" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + }, + { + "target": "com.amazonaws.autoscaling#ResourceInUseFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified tags.

", + "smithy.api#examples": [ + { + "title": "To delete a tag from an Auto Scaling group", + "documentation": "This example deletes the specified tag from the specified Auto Scaling group.", + "input": { + "Tags": [ + { + "ResourceId": "my-auto-scaling-group", + "ResourceType": "auto-scaling-group", + "Key": "Dept", + "Value": "Research" + } + ] + } + } + ] + } + }, + "com.amazonaws.autoscaling#DeleteTagsType": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.autoscaling#Tags", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

One or more tags.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#DeleteWarmPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DeleteWarmPoolType" + }, + "output": { + "target": "com.amazonaws.autoscaling#DeleteWarmPoolAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#LimitExceededFault" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + }, + { + "target": "com.amazonaws.autoscaling#ResourceInUseFault" + }, + { + "target": "com.amazonaws.autoscaling#ScalingActivityInProgressFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the warm pool for the specified Auto Scaling group.

\n

For more information, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "com.amazonaws.autoscaling#DeleteWarmPoolAnswer": { + "type": "structure", + "members": {} + }, + "com.amazonaws.autoscaling#DeleteWarmPoolType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "ForceDelete": { + "target": "com.amazonaws.autoscaling#ForceDelete", + "traits": { + "smithy.api#documentation": "

Specifies that the warm pool is to be deleted along with all of its associated\n instances, without waiting for all instances to be terminated. This parameter also\n deletes any outstanding lifecycle actions associated with the warm pool\n instances.

" + } + } + } + }, + "com.amazonaws.autoscaling#DescribeAccountLimits": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.autoscaling#DescribeAccountLimitsAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the current Amazon EC2 Auto Scaling resource quotas for your account.

\n

When you establish an Amazon Web Services account, the account has initial quotas on the maximum\n number of Auto Scaling groups and launch configurations that you can create in a given Region.\n For more information, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To describe your Auto Scaling account limits", + "documentation": "This example describes the Amazon EC2 Auto Scaling service quotas for your account.", + "output": { + "MaxNumberOfAutoScalingGroups": 20, + "MaxNumberOfLaunchConfigurations": 100, + "NumberOfAutoScalingGroups": 3, + "NumberOfLaunchConfigurations": 5 + } + } + ] + } + }, + "com.amazonaws.autoscaling#DescribeAccountLimitsAnswer": { + "type": "structure", + "members": { + "MaxNumberOfAutoScalingGroups": { + "target": "com.amazonaws.autoscaling#MaxNumberOfAutoScalingGroups", + "traits": { + "smithy.api#documentation": "

The maximum number of groups allowed for your account. The default is 200 groups per\n Region.

" + } + }, + "MaxNumberOfLaunchConfigurations": { + "target": "com.amazonaws.autoscaling#MaxNumberOfLaunchConfigurations", + "traits": { + "smithy.api#documentation": "

The maximum number of launch configurations allowed for your account. The default is\n 200 launch configurations per Region.

" + } + }, + "NumberOfAutoScalingGroups": { + "target": "com.amazonaws.autoscaling#NumberOfAutoScalingGroups", + "traits": { + "smithy.api#documentation": "

The current number of groups for your account.

" + } + }, + "NumberOfLaunchConfigurations": { + "target": "com.amazonaws.autoscaling#NumberOfLaunchConfigurations", + "traits": { + "smithy.api#documentation": "

The current number of launch configurations for your account.

" + } + } + } + }, + "com.amazonaws.autoscaling#DescribeAdjustmentTypes": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.autoscaling#DescribeAdjustmentTypesAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the available adjustment types for step scaling and simple scaling\n policies.

\n

The following adjustment types are supported:

\n ", + "smithy.api#examples": [ + { + "title": "To describe the Amazon EC2 Auto Scaling adjustment types", + "documentation": "This example describes the available adjustment types.", + "output": { + "AdjustmentTypes": [ + { + "AdjustmentType": "ChangeInCapacity" + }, + { + "AdjustmentType": "ExactCapcity" + }, + { + "AdjustmentType": "PercentChangeInCapacity" + } + ] + } + } + ] + } + }, + "com.amazonaws.autoscaling#DescribeAdjustmentTypesAnswer": { + "type": "structure", + "members": { + "AdjustmentTypes": { + "target": "com.amazonaws.autoscaling#AdjustmentTypes", + "traits": { + "smithy.api#documentation": "

The policy adjustment types.

" + } + } + } + }, + "com.amazonaws.autoscaling#DescribeAutoScalingGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupNamesType" + }, + "output": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupsType" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#InvalidNextToken" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about the Auto Scaling groups in the account and Region.

\n

If you specify Auto Scaling group names, the output includes information for only the\n specified Auto Scaling groups. If you specify filters, the output includes information for only\n those Auto Scaling groups that meet the filter criteria. If you do not specify group names or\n filters, the output includes information for all Auto Scaling groups.

\n

This operation also returns information about instances in Auto Scaling groups. To retrieve\n information about the instances in a warm pool, you must call the DescribeWarmPool API.

", + "smithy.api#examples": [ + { + "title": "To describe an Auto Scaling group", + "documentation": "This example describes the specified Auto Scaling group.", + "input": { + "AutoScalingGroupNames": [ + "my-auto-scaling-group" + ] + }, + "output": { + "AutoScalingGroups": [ + { + "AutoScalingGroupName": "my-auto-scaling-group", + "AutoScalingGroupARN": "arn:aws:autoscaling:us-west-1:123456789012:autoScalingGroup:12345678-1234-1234-1234-123456789012:autoScalingGroupName/my-auto-scaling-group", + "LaunchConfigurationName": "my-launch-config", + "MinSize": 1, + "MaxSize": 5, + "DesiredCapacity": 2, + "DefaultCooldown": 300, + "AvailabilityZones": [ + "us-west-2a", + "us-west-2b", + "us-west-2c" + ], + "LoadBalancerNames": [], + "TargetGroupARNs": [], + "HealthCheckType": "EC2", + "HealthCheckGracePeriod": 300, + "Instances": [ + { + "ProtectedFromScaleIn": false, + "AvailabilityZone": "us-west-2c", + "LaunchConfigurationName": "my-launch-config", + "InstanceId": "i-05b4f7d5be44822a6", + "InstanceType": "t3.micro", + "HealthStatus": "Healthy", + "LifecycleState": "InService" + }, + { + "ProtectedFromScaleIn": false, + "AvailabilityZone": "us-west-2b", + "LaunchConfigurationName": "my-launch-config", + "InstanceId": "i-0c20ac468fa3049e8", + "InstanceType": "t3.micro", + "HealthStatus": "Healthy", + "LifecycleState": "InService" + } + ], + "CreatedTime": "2023-03-09T22:15:11.611Z", + "SuspendedProcesses": [], + "VPCZoneIdentifier": "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782", + "EnabledMetrics": [], + "Tags": [], + "TerminationPolicies": [ + "Default" + ], + "NewInstancesProtectedFromScaleIn": false, + "ServiceLinkedRoleARN": "arn:aws:iam::123456789012:role/aws-service-role/autoscaling.amazonaws.com/AWSServiceRoleForAutoScaling", + "TrafficSources": [] + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AutoScalingGroups", + "pageSize": "MaxRecords" + }, + "smithy.waiters#waitable": { + "GroupExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(AutoScalingGroups) > `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "length(AutoScalingGroups) > `0`", + "expected": "false", + "comparator": "booleanEquals" + } + } + } + ], + "minDelay": 5 + }, + "GroupInService": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "contains(AutoScalingGroups[].[length(Instances[?LifecycleState=='InService']) >= MinSize][], `false`)", + "expected": "false", + "comparator": "booleanEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "contains(AutoScalingGroups[].[length(Instances[?LifecycleState=='InService']) >= MinSize][], `false`)", + "expected": "true", + "comparator": "booleanEquals" + } + } + } + ], + "minDelay": 15 + }, + "GroupNotExists": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "length(AutoScalingGroups) > `0`", + "expected": "false", + "comparator": "booleanEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "length(AutoScalingGroups) > `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + } + ], + "minDelay": 15 + } + } + } + }, + "com.amazonaws.autoscaling#DescribeAutoScalingInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DescribeAutoScalingInstancesType" + }, + "output": { + "target": "com.amazonaws.autoscaling#AutoScalingInstancesType" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#InvalidNextToken" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about the Auto Scaling instances in the account and Region.

", + "smithy.api#examples": [ + { + "title": "To describe one or more Auto Scaling instances", + "documentation": "This example describes the specified Auto Scaling instance.", + "input": { + "InstanceIds": [ + "i-05b4f7d5be44822a6" + ] + }, + "output": { + "AutoScalingInstances": [ + { + "ProtectedFromScaleIn": false, + "AvailabilityZone": "us-west-2c", + "LaunchConfigurationName": "my-launch-config", + "InstanceId": "i-05b4f7d5be44822a6", + "InstanceType": "t3.micro", + "AutoScalingGroupName": "my-auto-scaling-group", + "HealthStatus": "HEALTHY", + "LifecycleState": "InService" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AutoScalingInstances", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.autoscaling#DescribeAutoScalingInstancesType": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.autoscaling#InstanceIds", + "traits": { + "smithy.api#documentation": "

The IDs of the instances. If you omit this property, all Auto Scaling instances are described.\n If you specify an ID that does not exist, it is ignored with no error.

\n

Array Members: Maximum number of 50 items.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.autoscaling#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 50.

" + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" + } + } + } + }, + "com.amazonaws.autoscaling#DescribeAutoScalingNotificationTypes": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.autoscaling#DescribeAutoScalingNotificationTypesAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the notification types that are supported by Amazon EC2 Auto Scaling.

", + "smithy.api#examples": [ + { + "title": "To describe the Auto Scaling notification types", + "documentation": "This example describes the available notification types.", + "output": { + "AutoScalingNotificationTypes": [ + "autoscaling:EC2_INSTANCE_LAUNCH", + "autoscaling:EC2_INSTANCE_LAUNCH_ERROR", + "autoscaling:EC2_INSTANCE_TERMINATE", + "autoscaling:EC2_INSTANCE_TERMINATE_ERROR", + "autoscaling:TEST_NOTIFICATION" + ] + } + } + ] + } + }, + "com.amazonaws.autoscaling#DescribeAutoScalingNotificationTypesAnswer": { + "type": "structure", + "members": { + "AutoScalingNotificationTypes": { + "target": "com.amazonaws.autoscaling#AutoScalingNotificationTypes", + "traits": { + "smithy.api#documentation": "

The notification types.

" + } + } + } + }, + "com.amazonaws.autoscaling#DescribeInstanceRefreshes": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DescribeInstanceRefreshesType" + }, + "output": { + "target": "com.amazonaws.autoscaling#DescribeInstanceRefreshesAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#InvalidNextToken" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about the instance refreshes for the specified Auto Scaling group from the\n previous six weeks.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group\n after you make configuration changes.

\n

To help you determine the status of an instance refresh, Amazon EC2 Auto Scaling returns information\n about the instance refreshes you previously initiated, including their status, start\n time, end time, the percentage of the instance refresh that is complete, and the number\n of instances remaining to update before the instance refresh is complete. If a rollback\n is initiated while an instance refresh is in progress, Amazon EC2 Auto Scaling also returns information\n about the rollback of the instance refresh.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.autoscaling#DescribeInstanceRefreshesAnswer": { + "type": "structure", + "members": { + "InstanceRefreshes": { + "target": "com.amazonaws.autoscaling#InstanceRefreshes", + "traits": { + "smithy.api#documentation": "

The instance refreshes for the specified group, sorted by creation timestamp in\n descending order.

" + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" + } + } + } + }, + "com.amazonaws.autoscaling#DescribeInstanceRefreshesType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "InstanceRefreshIds": { + "target": "com.amazonaws.autoscaling#InstanceRefreshIds", + "traits": { + "smithy.api#documentation": "

One or more instance refresh IDs.

" + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.autoscaling#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.

" + } + } + } + }, + "com.amazonaws.autoscaling#DescribeLaunchConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#LaunchConfigurationNamesType" + }, + "output": { + "target": "com.amazonaws.autoscaling#LaunchConfigurationsType" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#InvalidNextToken" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about the launch configurations in the account and Region.

", + "smithy.api#examples": [ + { + "title": "To describe Auto Scaling launch configurations", + "documentation": "This example describes the specified launch configuration.", + "input": { + "LaunchConfigurationNames": [ + "my-launch-config" + ] + }, + "output": { + "LaunchConfigurations": [ + { + "EbsOptimized": false, + "LaunchConfigurationARN": "arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config", + "InstanceMonitoring": { + "Enabled": true + }, + "ImageId": "ami-043a5034", + "CreatedTime": "2014-05-07T17:39:28.599Z", + "BlockDeviceMappings": [], + "SecurityGroups": [ + "sg-67ef0308" + ], + "LaunchConfigurationName": "my-launch-config", + "InstanceType": "t1.micro", + "AssociatePublicIpAddress": true + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "LaunchConfigurations", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.autoscaling#DescribeLifecycleHookTypes": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.autoscaling#DescribeLifecycleHookTypesAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the available types of lifecycle hooks.

\n

The following hook types are supported:

\n ", + "smithy.api#examples": [ + { + "title": "To describe the available types of lifecycle hooks", + "documentation": "This example describes the available lifecycle hook types.", + "output": { + "LifecycleHookTypes": [ + "autoscaling:EC2_INSTANCE_LAUNCHING", + "autoscaling:EC2_INSTANCE_TERMINATING" + ] + } + } + ] + } + }, + "com.amazonaws.autoscaling#DescribeLifecycleHookTypesAnswer": { + "type": "structure", + "members": { + "LifecycleHookTypes": { + "target": "com.amazonaws.autoscaling#AutoScalingNotificationTypes", + "traits": { + "smithy.api#documentation": "

The lifecycle hook types.

" + } + } + } + }, + "com.amazonaws.autoscaling#DescribeLifecycleHooks": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DescribeLifecycleHooksType" + }, + "output": { + "target": "com.amazonaws.autoscaling#DescribeLifecycleHooksAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about the lifecycle hooks for the specified Auto Scaling group.

", + "smithy.api#examples": [ + { + "title": "To describe your lifecycle hooks", + "documentation": "This example describes the lifecycle hooks for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "LifecycleHooks": [ + { + "GlobalTimeout": 172800, + "HeartbeatTimeout": 3600, + "RoleARN": "arn:aws:iam::123456789012:role/my-auto-scaling-role", + "AutoScalingGroupName": "my-auto-scaling-group", + "LifecycleHookName": "my-lifecycle-hook", + "DefaultResult": "ABANDON", + "NotificationTargetARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic", + "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING" + } + ] + } + } + ] + } + }, + "com.amazonaws.autoscaling#DescribeLifecycleHooksAnswer": { + "type": "structure", + "members": { + "LifecycleHooks": { + "target": "com.amazonaws.autoscaling#LifecycleHooks", + "traits": { + "smithy.api#documentation": "

The lifecycle hooks for the specified group.

" + } + } + } + }, + "com.amazonaws.autoscaling#DescribeLifecycleHooksType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "LifecycleHookNames": { + "target": "com.amazonaws.autoscaling#LifecycleHookNames", + "traits": { + "smithy.api#documentation": "

The names of one or more lifecycle hooks. If you omit this property, all lifecycle\n hooks are described.

" + } + } + } + }, + "com.amazonaws.autoscaling#DescribeLoadBalancerTargetGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DescribeLoadBalancerTargetGroupsRequest" + }, + "output": { + "target": "com.amazonaws.autoscaling#DescribeLoadBalancerTargetGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#InvalidNextToken" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "\n

This API operation is superseded by DescribeTrafficSources,\n which can describe multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DescribeLoadBalancerTargetGroups. You\n can use both the original DescribeLoadBalancerTargetGroups API\n operation and DescribeTrafficSources on the same Auto Scaling group.

\n \n

Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.

\n

To determine the attachment status of the target group, use the State\n element in the response. When you attach a target group to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the target group. If\n Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the target group is in the InService state, Amazon EC2 Auto Scaling can terminate and\n replace any instances that are reported as unhealthy. If no registered instances pass\n the health checks, the target group doesn't enter the InService state.

\n

Target groups also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your target group state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.

\n

For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n \n

You can use this operation to describe target groups that were attached by using\n AttachLoadBalancerTargetGroups, but not for target groups that\n were attached by using AttachTrafficSources.

\n ", + "smithy.api#examples": [ + { + "title": "To describe the target groups for an Auto Scaling group", + "documentation": "This example describes the target groups attached to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "LoadBalancerTargetGroups": [ + { + "LoadBalancerTargetGroupARN": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "State": "Added" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.autoscaling#DescribeLoadBalancerTargetGroupsRequest": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.autoscaling#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 100 and the maximum value is 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.autoscaling#DescribeLoadBalancerTargetGroupsResponse": { + "type": "structure", + "members": { + "LoadBalancerTargetGroups": { + "target": "com.amazonaws.autoscaling#LoadBalancerTargetGroupStates", + "traits": { + "smithy.api#documentation": "

Information about the target groups.

" + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.autoscaling#DescribeLoadBalancers": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DescribeLoadBalancersRequest" + }, + "output": { + "target": "com.amazonaws.autoscaling#DescribeLoadBalancersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#InvalidNextToken" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "\n

This API operation is superseded by DescribeTrafficSources,\n which can describe multiple traffic sources types. We recommend using\n DescribeTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DescribeLoadBalancers. You can use both\n the original DescribeLoadBalancers API operation and\n DescribeTrafficSources on the same Auto Scaling group.

\n \n

Gets information about the load balancers for the specified Auto Scaling group.

\n

This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the\n DescribeLoadBalancerTargetGroups API instead.

\n

To determine the attachment status of the load balancer, use the State\n element in the response. When you attach a load balancer to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the load balancer.\n If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the load balancer is in the InService state, Amazon EC2 Auto Scaling can terminate\n and replace any instances that are reported as unhealthy. If no registered instances\n pass the health checks, the load balancer doesn't enter the InService\n state.

\n

Load balancers also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your load balancer state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.

\n

For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To describe the load balancers for an Auto Scaling group", + "documentation": "This example describes the load balancers attached to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "LoadBalancers": [ + { + "State": "Added", + "LoadBalancerName": "my-load-balancer" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.autoscaling#DescribeLoadBalancersRequest": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.autoscaling#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 100 and the maximum value is 100.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.autoscaling#DescribeLoadBalancersResponse": { + "type": "structure", + "members": { + "LoadBalancers": { + "target": "com.amazonaws.autoscaling#LoadBalancerStates", + "traits": { + "smithy.api#documentation": "

The load balancers.

" + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.autoscaling#DescribeMetricCollectionTypes": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.autoscaling#DescribeMetricCollectionTypesAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.

", + "smithy.api#examples": [ + { + "title": "To describe the Auto Scaling metric collection types", + "documentation": "This example describes the available metric collection types.", + "output": { + "Metrics": [ + { + "Metric": "GroupMinSize" + }, + { + "Metric": "GroupMaxSize" + }, + { + "Metric": "GroupDesiredCapacity" + }, + { + "Metric": "GroupInServiceInstances" + }, + { + "Metric": "GroupPendingInstances" + }, + { + "Metric": "GroupTerminatingInstances" + }, + { + "Metric": "GroupStandbyInstances" + }, + { + "Metric": "GroupTotalInstances" + } + ], + "Granularities": [ + { + "Granularity": "1Minute" + } + ] + } + } + ] + } + }, + "com.amazonaws.autoscaling#DescribeMetricCollectionTypesAnswer": { + "type": "structure", + "members": { + "Metrics": { + "target": "com.amazonaws.autoscaling#MetricCollectionTypes", + "traits": { + "smithy.api#documentation": "

The metrics.

" + } + }, + "Granularities": { + "target": "com.amazonaws.autoscaling#MetricGranularityTypes", + "traits": { + "smithy.api#documentation": "

The granularities for the metrics.

" + } + } + } + }, + "com.amazonaws.autoscaling#DescribeNotificationConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DescribeNotificationConfigurationsType" + }, + "output": { + "target": "com.amazonaws.autoscaling#DescribeNotificationConfigurationsAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#InvalidNextToken" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about the Amazon SNS notifications that are configured for one or more\n Auto Scaling groups.

", + "smithy.api#examples": [ + { + "title": "To describe Auto Scaling notification configurations", + "documentation": "This example describes the notification configurations for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupNames": [ + "my-auto-scaling-group" + ] + }, + "output": { + "NotificationConfigurations": [ + { + "AutoScalingGroupName": "my-auto-scaling-group", + "NotificationType": "autoscaling:TEST_NOTIFICATION", + "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic-2" + }, + { + "AutoScalingGroupName": "my-auto-scaling-group", + "NotificationType": "autoscaling:TEST_NOTIFICATION", + "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "NotificationConfigurations", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.autoscaling#DescribeNotificationConfigurationsAnswer": { + "type": "structure", + "members": { + "NotificationConfigurations": { + "target": "com.amazonaws.autoscaling#NotificationConfigurations", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The notification configurations.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" + } + } + } + }, + "com.amazonaws.autoscaling#DescribeNotificationConfigurationsType": { + "type": "structure", + "members": { + "AutoScalingGroupNames": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupNames", + "traits": { + "smithy.api#documentation": "

The name of the Auto Scaling group.

" + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.autoscaling#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.

" + } + } + } + }, + "com.amazonaws.autoscaling#DescribePolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DescribePoliciesType" + }, + "output": { + "target": "com.amazonaws.autoscaling#PoliciesType" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#InvalidNextToken" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + }, + { + "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about the scaling policies in the account and Region.

", + "smithy.api#examples": [ + { + "title": "To describe scaling policies", + "documentation": "This example describes the policies for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "ScalingPolicies": [ + { + "PolicyName": "ScaleIn", + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn", + "AdjustmentType": "ChangeInCapacity", + "Alarms": [], + "ScalingAdjustment": -1 + }, + { + "PolicyName": "ScalePercentChange", + "MinAdjustmentStep": 2, + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2b435159-cf77-4e89-8c0e-d63b497baad7:autoScalingGroupName/my-auto-scaling-group:policyName/ScalePercentChange", + "Cooldown": 60, + "AdjustmentType": "PercentChangeInCapacity", + "Alarms": [], + "ScalingAdjustment": 25 + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ScalingPolicies", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.autoscaling#DescribePoliciesType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the Auto Scaling group.

" + } + }, + "PolicyNames": { + "target": "com.amazonaws.autoscaling#PolicyNames", + "traits": { + "smithy.api#documentation": "

The names of one or more policies. If you omit this property, all policies are\n described. If a group name is provided, the results are limited to that group. If you\n specify an unknown policy name, it is ignored with no error.

\n

Array Members: Maximum number of 50 items.

" + } + }, + "PolicyTypes": { + "target": "com.amazonaws.autoscaling#PolicyTypes", + "traits": { + "smithy.api#documentation": "

One or more policy types. The valid values are SimpleScaling,\n StepScaling, TargetTrackingScaling, and\n PredictiveScaling.

" + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.autoscaling#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of items to be returned with each call. The default value is\n 50 and the maximum value is 100.

" + } + } + } + }, + "com.amazonaws.autoscaling#DescribeScalingActivities": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DescribeScalingActivitiesType" + }, + "output": { + "target": "com.amazonaws.autoscaling#ActivitiesType" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#InvalidNextToken" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about the scaling activities in the account and Region.

\n

When scaling events occur, you see a record of the scaling activity in the scaling\n activities. For more information, see Verify a scaling\n activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

\n

If the scaling event succeeds, the value of the StatusCode element in the\n response is Successful. If an attempt to launch instances failed, the\n StatusCode value is Failed or Cancelled and\n the StatusMessage element in the response indicates the cause of the\n failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To describe the scaling activities for an Auto Scaling group", + "documentation": "This example describes the scaling activities for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "Activities": [ + { + "Description": "Launching a new EC2 instance: i-4ba0837f", + "AutoScalingGroupName": "my-auto-scaling-group", + "ActivityId": "f9f2d65b-f1f2-43e7-b46d-d86756459699", + "Details": "details", + "StartTime": "2013-08-19T20:53:29.930Z", + "Progress": 100, + "EndTime": "2013-08-19T20:54:02Z", + "Cause": "At 2013-08-19T20:53:25Z a user request created an AutoScalingGroup changing the desired capacity from 0 to 1. At 2013-08-19T20:53:29Z an instance was started in response to a difference between desired and actual capacity, increasing the capacity from 0 to 1.", + "StatusCode": "Successful", + "AutoScalingGroupARN": "arn:aws:autoscaling:us-east-1:123456789012:autoScalingGroup:12345678-1234-1234-1234-123456789012:autoScalingGroupName/my-auto-scaling-group" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Activities", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.autoscaling#DescribeScalingActivitiesType": { + "type": "structure", + "members": { + "ActivityIds": { + "target": "com.amazonaws.autoscaling#ActivityIds", + "traits": { + "smithy.api#documentation": "

The activity IDs of the desired scaling activities. If you omit this property, all\n activities for the past six weeks are described. If unknown activities are requested,\n they are ignored with no error. If you specify an Auto Scaling group, the results are limited to\n that group.

\n

Array Members: Maximum number of 50 IDs.

" + } + }, + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the Auto Scaling group.

" + } + }, + "IncludeDeletedGroups": { + "target": "com.amazonaws.autoscaling#IncludeDeletedGroups", + "traits": { + "smithy.api#documentation": "

Indicates whether to include scaling activity from deleted Auto Scaling groups.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.autoscaling#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 100 and the maximum value is 100.

" + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" + } + } + } + }, + "com.amazonaws.autoscaling#DescribeScalingProcessTypes": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.autoscaling#ProcessesType" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the scaling process types for use with the ResumeProcesses\n and SuspendProcesses APIs.

", + "smithy.api#examples": [ + { + "title": "To describe the Auto Scaling process types", + "documentation": "This example describes the Auto Scaling process types.", + "output": { + "Processes": [ + { + "ProcessName": "AZRebalance" + }, + { + "ProcessName": "AddToLoadBalancer" + }, + { + "ProcessName": "AlarmNotification" + }, + { + "ProcessName": "HealthCheck" + }, + { + "ProcessName": "Launch" + }, + { + "ProcessName": "ReplaceUnhealthy" + }, + { + "ProcessName": "ScheduledActions" + }, + { + "ProcessName": "Terminate" + } + ] + } + } + ], + "smithy.test#smokeTests": [ + { + "id": "DescribeScalingProcessTypesSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] + } + }, + "com.amazonaws.autoscaling#DescribeScheduledActions": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DescribeScheduledActionsType" + }, + "output": { + "target": "com.amazonaws.autoscaling#ScheduledActionsType" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#InvalidNextToken" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about the scheduled actions that haven't run or that have not reached\n their end time.

\n

To describe the scaling activities for scheduled actions that have already run, call\n the DescribeScalingActivities API.

", + "smithy.api#examples": [ + { + "title": "To describe scheduled actions", + "documentation": "This example describes the scheduled actions for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "ScheduledUpdateGroupActions": [ + { + "MinSize": 2, + "DesiredCapacity": 4, + "AutoScalingGroupName": "my-auto-scaling-group", + "MaxSize": 6, + "Recurrence": "30 0 1 12 0", + "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-auto-scaling-group:scheduledActionName/my-scheduled-action", + "ScheduledActionName": "my-scheduled-action", + "StartTime": "2016-12-01T00:30:00Z", + "Time": "2016-12-01T00:30:00Z" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ScheduledUpdateGroupActions", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.autoscaling#DescribeScheduledActionsType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the Auto Scaling group.

" + } + }, + "ScheduledActionNames": { + "target": "com.amazonaws.autoscaling#ScheduledActionNames", + "traits": { + "smithy.api#documentation": "

The names of one or more scheduled actions. If you omit this property, all scheduled\n actions are described. If you specify an unknown scheduled action, it is ignored with no\n error.

\n

Array Members: Maximum number of 50 actions.

" + } + }, + "StartTime": { + "target": "com.amazonaws.autoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

The earliest scheduled start time to return. If scheduled action names are provided,\n this property is ignored.

" + } + }, + "EndTime": { + "target": "com.amazonaws.autoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

The latest scheduled start time to return. If scheduled action names are provided,\n this property is ignored.

" + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.autoscaling#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.

" + } + } + } + }, + "com.amazonaws.autoscaling#DescribeTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DescribeTagsType" + }, + "output": { + "target": "com.amazonaws.autoscaling#TagsType" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#InvalidNextToken" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the specified tags.

\n

You can use filters to limit the results. For example, you can query for the tags for\n a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at\n least one of the specified values for it to be included in the results.

\n

You can also specify multiple filters. The result includes information for a\n particular tag only if it matches all the filters. If there's no match, no special\n message is returned.

\n

For more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To describe tags", + "documentation": "This example describes the tags for the specified Auto Scaling group.", + "input": { + "Filters": [ + { + "Values": [ + "my-auto-scaling-group" + ], + "Name": "auto-scaling-group" + } + ] + }, + "output": { + "Tags": [ + { + "ResourceType": "auto-scaling-group", + "ResourceId": "my-auto-scaling-group", + "PropagateAtLaunch": true, + "Value": "Research", + "Key": "Dept" + }, + { + "ResourceType": "auto-scaling-group", + "ResourceId": "my-auto-scaling-group", + "PropagateAtLaunch": true, + "Value": "WebServer", + "Key": "Role" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Tags", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.autoscaling#DescribeTagsType": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.autoscaling#Filters", + "traits": { + "smithy.api#documentation": "

One or more filters to scope the tags to return. The maximum number of filters per\n filter type (for example, auto-scaling-group) is 1000.

" + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.autoscaling#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.

" + } + } + } + }, + "com.amazonaws.autoscaling#DescribeTerminationPolicyTypes": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.autoscaling#DescribeTerminationPolicyTypesAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the termination policies supported by Amazon EC2 Auto Scaling.

\n

For more information, see Configure\n termination policies for Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To describe termination policy types", + "documentation": "This example describes the available termination policy types.", + "output": { + "TerminationPolicyTypes": [ + "ClosestToNextInstanceHour", + "Default", + "NewestInstance", + "OldestInstance", + "OldestLaunchConfiguration" + ] + } + } + ] + } + }, + "com.amazonaws.autoscaling#DescribeTerminationPolicyTypesAnswer": { + "type": "structure", + "members": { + "TerminationPolicyTypes": { + "target": "com.amazonaws.autoscaling#TerminationPolicies", + "traits": { + "smithy.api#documentation": "

The termination policies supported by Amazon EC2 Auto Scaling: OldestInstance,\n OldestLaunchConfiguration, NewestInstance,\n ClosestToNextInstanceHour, Default,\n OldestLaunchTemplate, and AllocationStrategy.

" + } + } + } + }, + "com.amazonaws.autoscaling#DescribeTrafficSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DescribeTrafficSourcesRequest" + }, + "output": { + "target": "com.amazonaws.autoscaling#DescribeTrafficSourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#InvalidNextToken" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about the traffic sources for the specified Auto Scaling group.

\n

You can optionally provide a traffic source type. If you provide a traffic source\n type, then the results only include that traffic source type.

\n

If you do not provide a traffic source type, then the results include all the traffic\n sources for the specified Auto Scaling group.

", + "smithy.api#examples": [ + { + "title": "To describe the target groups for an Auto Scaling group", + "documentation": "This example describes the target groups attached to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "TrafficSources": [ + { + "Identifier": "arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-0e2f2665eEXAMPLE", + "State": "InService", + "Type": "vpc-lattice" + } + ], + "NextToken": "" + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.autoscaling#DescribeTrafficSourcesRequest": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "TrafficSourceType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The traffic source type that you want to describe.

\n

The following lists the valid values:

\n " + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.autoscaling#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return with this call. The maximum value is\n 50.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.autoscaling#DescribeTrafficSourcesResponse": { + "type": "structure", + "members": { + "TrafficSources": { + "target": "com.amazonaws.autoscaling#TrafficSourceStates", + "traits": { + "smithy.api#documentation": "

Information about the traffic sources.

" + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

This string indicates that the response contains more items than can be returned in a\n single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.autoscaling#DescribeWarmPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DescribeWarmPoolType" + }, + "output": { + "target": "com.amazonaws.autoscaling#DescribeWarmPoolAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#InvalidNextToken" + }, + { + "target": "com.amazonaws.autoscaling#LimitExceededFault" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a warm pool and its instances.

\n

For more information, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Instances", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.autoscaling#DescribeWarmPoolAnswer": { + "type": "structure", + "members": { + "WarmPoolConfiguration": { + "target": "com.amazonaws.autoscaling#WarmPoolConfiguration", + "traits": { + "smithy.api#documentation": "

The warm pool configuration details.

" + } + }, + "Instances": { + "target": "com.amazonaws.autoscaling#Instances", + "traits": { + "smithy.api#documentation": "

The instances that are currently in the warm pool.

" + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

This string indicates that the response contains more items than can be returned in a\n single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" + } + } + } + }, + "com.amazonaws.autoscaling#DescribeWarmPoolType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "MaxRecords": { + "target": "com.amazonaws.autoscaling#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of instances to return with this call. The maximum value is\n 50.

" + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token for the next set of instances to return. (You received this token from a\n previous call.)

" + } + } + } + }, + "com.amazonaws.autoscaling#DesiredConfiguration": { + "type": "structure", + "members": { + "LaunchTemplate": { + "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", + "traits": { + "smithy.api#documentation": "

Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling\n uses to launch Amazon EC2 instances. For more information about launch templates, see Launch\n templates in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "MixedInstancesPolicy": { + "target": "com.amazonaws.autoscaling#MixedInstancesPolicy", + "traits": { + "smithy.api#documentation": "

Use this structure to launch multiple instance types and On-Demand Instances and Spot\n Instances within a single Auto Scaling group.

\n

A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch\n instances and help optimize your costs. For more information, see Auto Scaling\n groups with multiple instance types and purchase options in the\n Amazon EC2 Auto Scaling User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the desired configuration for an instance refresh.

\n

If you specify a desired configuration, you must specify either a\n LaunchTemplate or a MixedInstancesPolicy.

" + } + }, + "com.amazonaws.autoscaling#DetachInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DetachInstancesQuery" + }, + "output": { + "target": "com.amazonaws.autoscaling#DetachInstancesAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Removes one or more instances from the specified Auto Scaling group.

\n

After the instances are detached, you can manage them independent of the Auto Scaling\n group.

\n

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are detached.

\n

If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are\n deregistered from the load balancer. If there are target groups attached to the Auto Scaling\n group, the instances are deregistered from the target groups.

\n

For more information, see Detach\n or attach instances in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To detach an instance from an Auto Scaling group", + "documentation": "This example detaches the specified instance from the specified Auto Scaling group.", + "input": { + "InstanceIds": [ + "i-93633f9b" + ], + "AutoScalingGroupName": "my-auto-scaling-group", + "ShouldDecrementDesiredCapacity": true + }, + "output": { + "Activities": [ + { + "Description": "Detaching EC2 instance: i-93633f9b", + "AutoScalingGroupName": "my-auto-scaling-group", + "ActivityId": "5091cb52-547a-47ce-a236-c9ccbc2cb2c9", + "Details": "details", + "StartTime": "2015-04-12T15:02:16.179Z", + "Progress": 50, + "Cause": "At 2015-04-12T15:02:16Z instance i-93633f9b was detached in response to a user request, shrinking the capacity from 2 to 1.", + "StatusCode": "InProgress" + } + ] + } + } + ] + } + }, + "com.amazonaws.autoscaling#DetachInstancesAnswer": { + "type": "structure", + "members": { + "Activities": { + "target": "com.amazonaws.autoscaling#Activities", + "traits": { + "smithy.api#documentation": "

The activities related to detaching the instances from the Auto Scaling group.

" + } + } + } + }, + "com.amazonaws.autoscaling#DetachInstancesQuery": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.autoscaling#InstanceIds", + "traits": { + "smithy.api#documentation": "

The IDs of the instances. You can specify up to 20 instances.

" + } + }, + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "ShouldDecrementDesiredCapacity": { + "target": "com.amazonaws.autoscaling#ShouldDecrementDesiredCapacity", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates whether the Auto Scaling group decrements the desired capacity value by the number\n of instances detached.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#DetachLoadBalancerTargetGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DetachLoadBalancerTargetGroupsType" + }, + "output": { + "target": "com.amazonaws.autoscaling#DetachLoadBalancerTargetGroupsResultType" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "\n

This API operation is superseded by DetachTrafficSources, which\n can detach multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DetachLoadBalancerTargetGroups. You can\n use both the original DetachLoadBalancerTargetGroups API operation and\n DetachTrafficSources on the same Auto Scaling group.

\n \n

Detaches one or more target groups from the specified Auto Scaling group.

\n

When you detach a target group, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the target group using the DescribeLoadBalancerTargetGroups API call. The instances remain\n running.

\n \n

You can use this operation to detach target groups that were attached by using\n AttachLoadBalancerTargetGroups, but not for target groups that\n were attached by using AttachTrafficSources.

\n ", + "smithy.api#examples": [ + { + "title": "To detach a target group from an Auto Scaling group", + "documentation": "This example detaches the specified target group from the specified Auto Scaling group", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "TargetGroupARNs": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + ] + } + } + ] + } + }, + "com.amazonaws.autoscaling#DetachLoadBalancerTargetGroupsResultType": { + "type": "structure", + "members": {} + }, + "com.amazonaws.autoscaling#DetachLoadBalancerTargetGroupsType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "TargetGroupARNs": { + "target": "com.amazonaws.autoscaling#TargetGroupARNs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target\n groups.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#DetachLoadBalancers": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DetachLoadBalancersType" + }, + "output": { + "target": "com.amazonaws.autoscaling#DetachLoadBalancersResultType" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "\n

This API operation is superseded by DetachTrafficSources, which\n can detach multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DetachLoadBalancers. You can use both\n the original DetachLoadBalancers API operation and\n DetachTrafficSources on the same Auto Scaling group.

\n \n

Detaches one or more Classic Load Balancers from the specified Auto Scaling group.

\n

This operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or\n Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API instead.

\n

When you detach a load balancer, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the load balancer using the DescribeLoadBalancers API call. The instances remain running.

", + "smithy.api#examples": [ + { + "title": "To detach a load balancer from an Auto Scaling group", + "documentation": "This example detaches the specified load balancer from the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LoadBalancerNames": [ + "my-load-balancer" + ] + } + } + ] + } + }, + "com.amazonaws.autoscaling#DetachLoadBalancersResultType": { + "type": "structure", + "members": {} + }, + "com.amazonaws.autoscaling#DetachLoadBalancersType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "LoadBalancerNames": { + "target": "com.amazonaws.autoscaling#LoadBalancerNames", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The names of the load balancers. You can specify up to 10 load balancers.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#DetachTrafficSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DetachTrafficSourcesType" + }, + "output": { + "target": "com.amazonaws.autoscaling#DetachTrafficSourcesResultType" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Detaches one or more traffic sources from the specified Auto Scaling group.

\n

When you detach a traffic source, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the traffic source using the DescribeTrafficSources API call. The instances continue to run.

", + "smithy.api#examples": [ + { + "title": "To detach a target group from an Auto Scaling group", + "documentation": "This example detaches the specified target group from the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "TrafficSources": [ + { + "Identifier": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + } + ] + }, + "output": {} + } + ] + } + }, + "com.amazonaws.autoscaling#DetachTrafficSourcesResultType": { + "type": "structure", + "members": {} + }, + "com.amazonaws.autoscaling#DetachTrafficSourcesType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "TrafficSources": { + "target": "com.amazonaws.autoscaling#TrafficSources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifiers of one or more traffic sources. You can specify up to 10\n traffic sources.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#DisableMetricsCollection": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#DisableMetricsCollectionQuery" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Disables group metrics collection for the specified Auto Scaling group.

", + "smithy.api#examples": [ + { + "title": "To disable metrics collection for an Auto Scaling group", + "documentation": "This example disables collecting data for the GroupDesiredCapacity metric for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "Metrics": [ + "GroupDesiredCapacity" + ] + } + } + ] + } + }, + "com.amazonaws.autoscaling#DisableMetricsCollectionQuery": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "Metrics": { + "target": "com.amazonaws.autoscaling#Metrics", + "traits": { + "smithy.api#documentation": "

Identifies the metrics to disable.

\n

You can specify one or more of the following metrics:

\n \n

If you omit this property, all metrics are disabled.

\n

For more information, see Amazon CloudWatch metrics for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" + } + } + } + }, + "com.amazonaws.autoscaling#DisableScaleIn": { + "type": "boolean" + }, + "com.amazonaws.autoscaling#Ebs": { + "type": "structure", + "members": { + "SnapshotId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The snapshot ID of the volume to use.

\n

You must specify either a VolumeSize or a SnapshotId.

" + } + }, + "VolumeSize": { + "target": "com.amazonaws.autoscaling#BlockDeviceEbsVolumeSize", + "traits": { + "smithy.api#documentation": "

The volume size, in GiBs. The following are the supported volumes sizes for each\n volume type:

\n \n

You must specify either a SnapshotId or a VolumeSize. If you\n specify both SnapshotId and VolumeSize, the volume size must\n be equal or greater than the size of the snapshot.

" + } + }, + "VolumeType": { + "target": "com.amazonaws.autoscaling#BlockDeviceEbsVolumeType", + "traits": { + "smithy.api#documentation": "

The volume type. For more information, see Amazon EBS volume types in the\n Amazon EBS User Guide.

\n

Valid values: standard | io1 | gp2 |\n st1 | sc1 | gp3\n

" + } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.autoscaling#BlockDeviceEbsDeleteOnTermination", + "traits": { + "smithy.api#documentation": "

Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the\n default value is true.

" + } + }, + "Iops": { + "target": "com.amazonaws.autoscaling#BlockDeviceEbsIops", + "traits": { + "smithy.api#documentation": "

The number of input/output (I/O) operations per second (IOPS) to provision for the\n volume. For gp3 and io1 volumes, this represents the number of\n IOPS that are provisioned for the volume. For gp2 volumes, this represents\n the baseline performance of the volume and the rate at which the volume accumulates I/O\n credits for bursting.

\n

The following are the supported values for each volume type:

\n \n

For io1 volumes, we guarantee 64,000 IOPS only for Instances built on the Amazon Web Services Nitro System. Other instance families\n guarantee performance up to 32,000 IOPS.

\n

\n Iops is supported when the volume type is gp3 or\n io1 and required only when the volume type is io1. (Not\n used with standard, gp2, st1, or sc1\n volumes.)

" + } + }, + "Encrypted": { + "target": "com.amazonaws.autoscaling#BlockDeviceEbsEncrypted", + "traits": { + "smithy.api#documentation": "

Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be\n attached to instances that support Amazon EBS encryption. For more information, see Requirements for Amazon EBS encryption in the Amazon EBS User Guide. If your AMI uses encrypted volumes, you\n can also only launch it on supported instance types.

\n \n

If you are creating a volume from a snapshot, you cannot create an unencrypted\n volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using\n a launch configuration.

\n

If you enable encryption by default, the EBS volumes that you create are always\n encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key,\n regardless of whether the snapshot was encrypted.

\n

For more information, see Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the\n Amazon EC2 Auto Scaling User Guide.

\n " + } + }, + "Throughput": { + "target": "com.amazonaws.autoscaling#BlockDeviceEbsThroughput", + "traits": { + "smithy.api#documentation": "

The throughput (MiBps) to provision for a gp3 volume.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes information used to set up an Amazon EBS volume specified in a block device\n mapping.

" + } + }, + "com.amazonaws.autoscaling#EbsOptimized": { + "type": "boolean" + }, + "com.amazonaws.autoscaling#EnableMetricsCollection": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#EnableMetricsCollectionQuery" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Enables group metrics collection for the specified Auto Scaling group.

\n

You can use these metrics to track changes in an Auto Scaling group and to set alarms on\n threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch\n console. For more information, see Monitor\n CloudWatch metrics for your Auto Scaling groups and instances in the\n Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To enable metrics collection for an Auto Scaling group", + "documentation": "This example enables data collection for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "Granularity": "1Minute" + } + } + ] + } + }, + "com.amazonaws.autoscaling#EnableMetricsCollectionQuery": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "Metrics": { + "target": "com.amazonaws.autoscaling#Metrics", + "traits": { + "smithy.api#documentation": "

Identifies the metrics to enable.

\n

You can specify one or more of the following metrics:

\n \n

If you specify Granularity and don't specify any metrics, all metrics are\n enabled.

\n

For more information, see Amazon CloudWatch metrics for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "Granularity": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is\n 1Minute.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#EnabledMetric": { + "type": "structure", + "members": { + "Metric": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

One of the following metrics:

\n \n

For more information, see Amazon CloudWatch metrics for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "Granularity": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The granularity of the metric. The only valid value is 1Minute.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an enabled Auto Scaling group metric.

" + } + }, + "com.amazonaws.autoscaling#EnabledMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#EnabledMetric" + } + }, + "com.amazonaws.autoscaling#EnterStandby": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#EnterStandbyQuery" + }, + "output": { + "target": "com.amazonaws.autoscaling#EnterStandbyAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Moves the specified instances into the standby state.

\n

If you choose to decrement the desired capacity of the Auto Scaling group, the instances can\n enter standby as long as the desired capacity of the Auto Scaling group after the instances are\n placed into standby is equal to or greater than the minimum capacity of the\n group.

\n

If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group\n launches new instances to replace the instances on standby.

\n

For more information, see Temporarily removing\n instances from your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To move instances into standby mode", + "documentation": "This example puts the specified instance into standby mode.", + "input": { + "InstanceIds": [ + "i-93633f9b" + ], + "AutoScalingGroupName": "my-auto-scaling-group", + "ShouldDecrementDesiredCapacity": true + }, + "output": { + "Activities": [ + { + "Description": "Moving EC2 instance to Standby: i-93633f9b", + "AutoScalingGroupName": "my-auto-scaling-group", + "ActivityId": "ffa056b4-6ed3-41ba-ae7c-249dfae6eba1", + "Details": "details", + "StartTime": "2015-04-12T15:10:23.640Z", + "Progress": 50, + "Cause": "At 2015-04-12T15:10:23Z instance i-93633f9b was moved to standby in response to a user request, shrinking the capacity from 2 to 1.", + "StatusCode": "InProgress" + } + ] + } + } + ] + } + }, + "com.amazonaws.autoscaling#EnterStandbyAnswer": { + "type": "structure", + "members": { + "Activities": { + "target": "com.amazonaws.autoscaling#Activities", + "traits": { + "smithy.api#documentation": "

The activities related to moving instances into Standby mode.

" + } + } + } + }, + "com.amazonaws.autoscaling#EnterStandbyQuery": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.autoscaling#InstanceIds", + "traits": { + "smithy.api#documentation": "

The IDs of the instances. You can specify up to 20 instances.

" + } + }, + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "ShouldDecrementDesiredCapacity": { + "target": "com.amazonaws.autoscaling#ShouldDecrementDesiredCapacity", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of\n instances moved to Standby mode.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#EstimatedInstanceWarmup": { + "type": "integer" + }, + "com.amazonaws.autoscaling#ExcludedInstance": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\.\\*\\-]+$" + } + }, + "com.amazonaws.autoscaling#ExcludedInstanceTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#ExcludedInstance" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 400 + } + } + }, + "com.amazonaws.autoscaling#ExecutePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#ExecutePolicyType" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + }, + { + "target": "com.amazonaws.autoscaling#ScalingActivityInProgressFault" + } + ], + "traits": { + "smithy.api#documentation": "

Executes the specified policy. This can be useful for testing the design of your\n scaling policy.

", + "smithy.api#examples": [ + { + "title": "To execute a scaling policy", + "documentation": "This example executes the specified policy.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyName": "my-step-scale-out-policy", + "BreachThreshold": 50.0, + "MetricValue": 59.0 + } + } + ] + } + }, + "com.amazonaws.autoscaling#ExecutePolicyType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the Auto Scaling group.

" + } + }, + "PolicyName": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name or ARN of the policy.

", + "smithy.api#required": {} + } + }, + "HonorCooldown": { + "target": "com.amazonaws.autoscaling#HonorCooldown", + "traits": { + "smithy.api#documentation": "

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing\n the policy.

\n

Valid only if the policy type is SimpleScaling. For more information, see\n Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "MetricValue": { + "target": "com.amazonaws.autoscaling#MetricScale", + "traits": { + "smithy.api#documentation": "

The metric value to compare to BreachThreshold. This enables you to\n execute a policy of type StepScaling and determine which step adjustment to\n use. For example, if the breach threshold is 50 and you want to use a step adjustment\n with a lower bound of 0 and an upper bound of 10, you can set the metric value to\n 59.

\n

If you specify a metric value that doesn't correspond to a step adjustment for the\n policy, the call returns an error.

\n

Required if the policy type is StepScaling and not supported\n otherwise.

" + } + }, + "BreachThreshold": { + "target": "com.amazonaws.autoscaling#MetricScale", + "traits": { + "smithy.api#documentation": "

The breach threshold for the alarm.

\n

Required if the policy type is StepScaling and not supported\n otherwise.

" + } + } + } + }, + "com.amazonaws.autoscaling#ExitStandby": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#ExitStandbyQuery" + }, + "output": { + "target": "com.amazonaws.autoscaling#ExitStandbyAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Moves the specified instances out of the standby state.

\n

After you put the instances back in service, the desired capacity is\n incremented.

\n

For more information, see Temporarily removing\n instances from your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To move instances out of standby mode", + "documentation": "This example moves the specified instance out of standby mode.", + "input": { + "InstanceIds": [ + "i-93633f9b" + ], + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "Activities": [ + { + "Description": "Moving EC2 instance out of Standby: i-93633f9b", + "AutoScalingGroupName": "my-auto-scaling-group", + "ActivityId": "142928e1-a2dc-453a-9b24-b85ad6735928", + "Details": "details", + "StartTime": "2015-04-12T15:14:29.886Z", + "Progress": 30, + "Cause": "At 2015-04-12T15:14:29Z instance i-93633f9b was moved out of standby in response to a user request, increasing the capacity from 1 to 2.", + "StatusCode": "PreInService" + } + ] + } + } + ] + } + }, + "com.amazonaws.autoscaling#ExitStandbyAnswer": { + "type": "structure", + "members": { + "Activities": { + "target": "com.amazonaws.autoscaling#Activities", + "traits": { + "smithy.api#documentation": "

The activities related to moving instances out of Standby mode.

" + } + } + } + }, + "com.amazonaws.autoscaling#ExitStandbyQuery": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.autoscaling#InstanceIds", + "traits": { + "smithy.api#documentation": "

The IDs of the instances. You can specify up to 20 instances.

" + } + }, + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#FailedScheduledUpdateGroupActionRequest": { + "type": "structure", + "members": { + "ScheduledActionName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the scheduled action.

", + "smithy.api#required": {} + } + }, + "ErrorCode": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", + "traits": { + "smithy.api#documentation": "

The error code.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The error message accompanying the error code.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a scheduled action that could not be created, updated, or deleted.

" + } + }, + "com.amazonaws.autoscaling#FailedScheduledUpdateGroupActionRequests": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#FailedScheduledUpdateGroupActionRequest" + } + }, + "com.amazonaws.autoscaling#Filter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The name of the filter.

\n

The valid values for Name depend on which API operation you're using with\n the filter (DescribeAutoScalingGroups or DescribeTags).

\n

\n DescribeAutoScalingGroups\n

\n

Valid values for Name include the following:

\n \n

\n DescribeTags\n

\n

Valid values for Name include the following:

\n " + } + }, + "Values": { + "target": "com.amazonaws.autoscaling#Values", + "traits": { + "smithy.api#documentation": "

One or more filter values. Filter values are case-sensitive.

\n

If you specify multiple values for a filter, the values are automatically logically\n joined with an OR, and the request returns all results that match any of\n the specified values. For example, specify \"tag:environment\" for the filter name and\n \"production,development\" for the filter values to find Auto Scaling groups with the tag\n \"environment=production\" or \"environment=development\".

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a filter that is used to return a more specific list of results from a\n describe operation.

\n

If you specify multiple filters, the filters are automatically logically joined with\n an AND, and the request returns only the results that match all of the\n specified filters.

\n

For more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "com.amazonaws.autoscaling#Filters": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#Filter" + } + }, + "com.amazonaws.autoscaling#ForceDelete": { + "type": "boolean" + }, + "com.amazonaws.autoscaling#GetPredictiveScalingForecast": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#GetPredictiveScalingForecastType" + }, + "output": { + "target": "com.amazonaws.autoscaling#GetPredictiveScalingForecastAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the forecast data for a predictive scaling policy.

\n

Load forecasts are predictions of the hourly load values using historical load data\n from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as\n predicted values for the minimum capacity that is needed on an hourly basis, based on\n the hourly load forecast.

\n

A minimum of 24 hours of data is required to create the initial forecasts. However,\n having a full 14 days of historical data results in more accurate forecasts.

\n

For more information, see Predictive\n scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "com.amazonaws.autoscaling#GetPredictiveScalingForecastAnswer": { + "type": "structure", + "members": { + "LoadForecast": { + "target": "com.amazonaws.autoscaling#LoadForecasts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The load forecast.

", + "smithy.api#required": {} + } + }, + "CapacityForecast": { + "target": "com.amazonaws.autoscaling#CapacityForecast", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The capacity forecast.

", + "smithy.api#required": {} + } + }, + "UpdateTime": { + "target": "com.amazonaws.autoscaling#TimestampType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The time the forecast was made.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#GetPredictiveScalingForecastType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "PolicyName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the policy.

", + "smithy.api#required": {} + } + }, + "StartTime": { + "target": "com.amazonaws.autoscaling#TimestampType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The inclusive start time of the time range for the forecast data to get. At most, the\n date and time can be one year before the current date and time.

", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.autoscaling#TimestampType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The exclusive end time of the time range for the forecast data to get. The maximum\n time duration between the start and end time is 30 days.

\n

Although this parameter can accept a date and time that is more than two days in the\n future, the availability of forecast data has limits. Amazon EC2 Auto Scaling only issues forecasts for\n periods of two days in advance.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#GlobalTimeout": { + "type": "integer" + }, + "com.amazonaws.autoscaling#HealthCheckGracePeriod": { + "type": "integer" + }, + "com.amazonaws.autoscaling#HeartbeatTimeout": { + "type": "integer" + }, + "com.amazonaws.autoscaling#HonorCooldown": { + "type": "boolean" + }, + "com.amazonaws.autoscaling#IncludeDeletedGroups": { + "type": "boolean" + }, + "com.amazonaws.autoscaling#Instance": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + }, + "InstanceType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The instance type of the EC2 instance.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Availability Zone in which the instance is running.

", + "smithy.api#required": {} + } + }, + "LifecycleState": { + "target": "com.amazonaws.autoscaling#LifecycleState", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A description of the current lifecycle state. The Quarantined state is\n not used. For more information, see Amazon EC2 Auto Scaling instance\n lifecycle in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#required": {} + } + }, + "HealthStatus": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The last reported health status of the instance. Healthy means that the\n instance is healthy and should remain in service. Unhealthy means that the\n instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.

", + "smithy.api#required": {} + } + }, + "LaunchConfigurationName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The launch configuration associated with the instance.

" + } + }, + "LaunchTemplate": { + "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", + "traits": { + "smithy.api#documentation": "

The launch template for the instance.

" + } + }, + "ProtectedFromScaleIn": { + "target": "com.amazonaws.autoscaling#InstanceProtected", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling\n in.

", + "smithy.api#required": {} + } + }, + "WeightedCapacity": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", + "traits": { + "smithy.api#documentation": "

The number of capacity units contributed by the instance based on its instance\n type.

\n

Valid Range: Minimum value of 1. Maximum value of 999.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an EC2 instance.

" + } + }, + "com.amazonaws.autoscaling#InstanceGeneration": { + "type": "enum", + "members": { + "CURRENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "current" + } + }, + "PREVIOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "previous" + } + } + } + }, + "com.amazonaws.autoscaling#InstanceGenerations": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#InstanceGeneration" + } + }, + "com.amazonaws.autoscaling#InstanceIds": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen19" + } + }, + "com.amazonaws.autoscaling#InstanceMaintenancePolicy": { + "type": "structure", + "members": { + "MinHealthyPercentage": { + "target": "com.amazonaws.autoscaling#IntPercentResettable", + "traits": { + "smithy.api#documentation": "

Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling\n group. It represents the minimum percentage of the group to keep in service, healthy,\n and ready to use to support your workload when replacing instances. Value range is 0 to\n 100. To clear a previously set value, specify a value of -1.

" + } + }, + "MaxHealthyPercentage": { + "target": "com.amazonaws.autoscaling#IntPercent100To200Resettable", + "traits": { + "smithy.api#documentation": "

Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling\n group. It represents the maximum percentage of the group that can be in service and\n healthy, or pending, to support your workload when replacing instances. Value range is\n 100 to 200. To clear a previously set value, specify a value of -1.

\n

Both MinHealthyPercentage and MaxHealthyPercentage must be\n specified, and the difference between them cannot be greater than 100. A large range\n increases the number of instances that can be replaced at the same time.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an instance maintenance policy.

\n

For more information, see Set instance maintenance policy in the\n Amazon EC2 Auto Scaling User Guide.

" + } + }, + "com.amazonaws.autoscaling#InstanceMetadataEndpointState": { + "type": "enum", + "members": { + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + }, + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + } + } + }, + "com.amazonaws.autoscaling#InstanceMetadataHttpPutResponseHopLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.autoscaling#InstanceMetadataHttpTokensState": { + "type": "enum", + "members": { + "Optional": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "optional" + } + }, + "Required": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + } + } + }, + "com.amazonaws.autoscaling#InstanceMetadataOptions": { + "type": "structure", + "members": { + "HttpTokens": { + "target": "com.amazonaws.autoscaling#InstanceMetadataHttpTokensState", + "traits": { + "smithy.api#documentation": "

The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.

\n

If the state is optional, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role\n credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid signed token, the version 2.0 role\n credentials are returned.

\n

If the state is required, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM role credentials\n always returns the version 2.0 credentials; the version 1.0 credentials are not\n available.

" + } + }, + "HttpPutResponseHopLimit": { + "target": "com.amazonaws.autoscaling#InstanceMetadataHttpPutResponseHopLimit", + "traits": { + "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1

" + } + }, + "HttpEndpoint": { + "target": "com.amazonaws.autoscaling#InstanceMetadataEndpointState", + "traits": { + "smithy.api#documentation": "

This parameter enables or disables the HTTP metadata endpoint on your instances. If\n the parameter is not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access\n your instance metadata.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The metadata options for the instances. For more information, see Configure the instance metadata options in the\n Amazon EC2 Auto Scaling User Guide.

" + } + }, + "com.amazonaws.autoscaling#InstanceMonitoring": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.autoscaling#MonitoringEnabled", + "traits": { + "smithy.api#documentation": "

If true, detailed monitoring is enabled. Otherwise, basic monitoring is\n enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes whether detailed monitoring is enabled for the Auto Scaling instances.

" + } + }, + "com.amazonaws.autoscaling#InstanceProtected": { + "type": "boolean" + }, + "com.amazonaws.autoscaling#InstanceRefresh": { + "type": "structure", + "members": { + "InstanceRefreshId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The instance refresh ID.

" + } + }, + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the Auto Scaling group.

" + } + }, + "Status": { + "target": "com.amazonaws.autoscaling#InstanceRefreshStatus", + "traits": { + "smithy.api#documentation": "

The current status for the instance refresh operation:

\n " + } + }, + "StatusReason": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", + "traits": { + "smithy.api#documentation": "

The explanation for the specific status assigned to this operation.

" + } + }, + "StartTime": { + "target": "com.amazonaws.autoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

The date and time at which the instance refresh began.

" + } + }, + "EndTime": { + "target": "com.amazonaws.autoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

The date and time at which the instance refresh ended.

" + } + }, + "PercentageComplete": { + "target": "com.amazonaws.autoscaling#IntPercent", + "traits": { + "smithy.api#documentation": "

The percentage of the instance refresh that is complete. For each instance\n replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the\n instance's health status changes to healthy and the specified warm-up time passes, the\n instance is considered updated and is added to the percentage complete.

\n \n

\n PercentageComplete does not include instances that are replaced\n during a rollback. This value gradually goes back down to zero during a\n rollback.

\n " + } + }, + "InstancesToUpdate": { + "target": "com.amazonaws.autoscaling#InstancesToUpdate", + "traits": { + "smithy.api#documentation": "

The number of instances remaining to update before the instance refresh is\n complete.

\n \n

If you roll back the instance refresh, InstancesToUpdate shows you\n the number of instances that were not yet updated by the instance refresh.\n Therefore, these instances don't need to be replaced as part of the rollback.

\n " + } + }, + "ProgressDetails": { + "target": "com.amazonaws.autoscaling#InstanceRefreshProgressDetails", + "traits": { + "smithy.api#documentation": "

Additional progress details for an Auto Scaling group that has a warm pool.

" + } + }, + "Preferences": { + "target": "com.amazonaws.autoscaling#RefreshPreferences", + "traits": { + "smithy.api#documentation": "

The preferences for an instance refresh.

" + } + }, + "DesiredConfiguration": { + "target": "com.amazonaws.autoscaling#DesiredConfiguration", + "traits": { + "smithy.api#documentation": "

Describes the desired configuration for the instance refresh.

" + } + }, + "RollbackDetails": { + "target": "com.amazonaws.autoscaling#RollbackDetails", + "traits": { + "smithy.api#documentation": "

The rollback details.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an instance refresh for an Auto Scaling group.

" + } + }, + "com.amazonaws.autoscaling#InstanceRefreshIds": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" + } + }, + "com.amazonaws.autoscaling#InstanceRefreshInProgressFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InstanceRefreshInProgress", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request failed because an active instance refresh already exists for the specified\n Auto Scaling group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.autoscaling#InstanceRefreshLivePoolProgress": { + "type": "structure", + "members": { + "PercentageComplete": { + "target": "com.amazonaws.autoscaling#IntPercent", + "traits": { + "smithy.api#documentation": "

The percentage of instances in the Auto Scaling group that have been replaced. For each\n instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time.\n When the instance's health status changes to healthy and the specified warm-up time\n passes, the instance is considered updated and is added to the percentage\n complete.

" + } + }, + "InstancesToUpdate": { + "target": "com.amazonaws.autoscaling#InstancesToUpdate", + "traits": { + "smithy.api#documentation": "

The number of instances remaining to update.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Reports progress on replacing instances that are in the Auto Scaling group.

" + } + }, + "com.amazonaws.autoscaling#InstanceRefreshProgressDetails": { + "type": "structure", + "members": { + "LivePoolProgress": { + "target": "com.amazonaws.autoscaling#InstanceRefreshLivePoolProgress", + "traits": { + "smithy.api#documentation": "

Reports progress on replacing instances that are in the Auto Scaling group.

" + } + }, + "WarmPoolProgress": { + "target": "com.amazonaws.autoscaling#InstanceRefreshWarmPoolProgress", + "traits": { + "smithy.api#documentation": "

Reports progress on replacing instances that are in the warm pool.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Reports progress on replacing instances in an Auto Scaling group that has a warm pool. This\n includes separate details for instances in the warm pool and instances in the Auto Scaling group\n (the live pool).

" + } + }, + "com.amazonaws.autoscaling#InstanceRefreshStatus": { + "type": "enum", + "members": { + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "InProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "Successful": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Successful" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "Cancelling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelling" + } + }, + "Cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelled" + } + }, + "RollbackInProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RollbackInProgress" + } + }, + "RollbackFailed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RollbackFailed" + } + }, + "RollbackSuccessful": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RollbackSuccessful" + } + } + } + }, + "com.amazonaws.autoscaling#InstanceRefreshWarmPoolProgress": { + "type": "structure", + "members": { + "PercentageComplete": { + "target": "com.amazonaws.autoscaling#IntPercent", + "traits": { + "smithy.api#documentation": "

The percentage of instances in the warm pool that have been replaced. For each\n instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time.\n When the instance's health status changes to healthy and the specified warm-up time\n passes, the instance is considered updated and is added to the percentage\n complete.

" + } + }, + "InstancesToUpdate": { + "target": "com.amazonaws.autoscaling#InstancesToUpdate", + "traits": { + "smithy.api#documentation": "

The number of instances remaining to update.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Reports progress on replacing instances that are in the warm pool.

" + } + }, + "com.amazonaws.autoscaling#InstanceRefreshes": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#InstanceRefresh" + } + }, + "com.amazonaws.autoscaling#InstanceRequirements": { + "type": "structure", + "members": { + "VCpuCount": { + "target": "com.amazonaws.autoscaling#VCpuCountRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The minimum and maximum number of vCPUs for an instance type.

", + "smithy.api#required": {} + } + }, + "MemoryMiB": { + "target": "com.amazonaws.autoscaling#MemoryMiBRequest", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The minimum and maximum instance memory size for an instance type, in MiB.

", + "smithy.api#required": {} + } + }, + "CpuManufacturers": { + "target": "com.amazonaws.autoscaling#CpuManufacturers", + "traits": { + "smithy.api#documentation": "

Lists which specific CPU manufacturers to include.

\n \n \n

Don't confuse the CPU hardware manufacturer with the CPU hardware architecture.\n Instances will be launched with a compatible CPU architecture based on the Amazon\n Machine Image (AMI) that you specify in your launch template.

\n \n

Default: Any manufacturer

" + } + }, + "MemoryGiBPerVCpu": { + "target": "com.amazonaws.autoscaling#MemoryGiBPerVCpuRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of memory per vCPU for an instance type, in GiB.

\n

Default: No minimum or maximum limits

" + } + }, + "ExcludedInstanceTypes": { + "target": "com.amazonaws.autoscaling#ExcludedInstanceTypes", + "traits": { + "smithy.api#documentation": "

The instance types to exclude. You can use strings with one or more wild cards,\n represented by an asterisk (*), to exclude an instance family, type, size,\n or generation. The following are examples: m5.8xlarge, c5*.*,\n m5a.*, r*, *3*.

\n

For example, if you specify c5*, you are excluding the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n\n instance types.

\n \n

If you specify ExcludedInstanceTypes, you can't specify\n AllowedInstanceTypes.

\n \n

Default: No excluded instance types

" + } + }, + "InstanceGenerations": { + "target": "com.amazonaws.autoscaling#InstanceGenerations", + "traits": { + "smithy.api#documentation": "

Indicates whether current or previous generation instance types are included.

\n \n

Default: Any current or previous generation

" + } + }, + "SpotMaxPricePercentageOverLowestPrice": { + "target": "com.amazonaws.autoscaling#NullablePositiveInteger", + "traits": { + "smithy.api#documentation": "

[Price protection] The price protection threshold for Spot Instances, as a percentage\n higher than an identified Spot price. The identified Spot price is the price of the\n lowest priced current generation C, M, or R instance type with your specified\n attributes. If no current generation C, M, or R instance type matches your attributes,\n then the identified price is from either the lowest priced current generation instance\n types or, failing that, the lowest priced previous generation instance types that match\n your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will\n exclude instance types whose price exceeds your specified threshold.

\n

The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

\n

If you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is based on the per-vCPU or\n per-memory price instead of the per instance price.

\n \n

Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If\n you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection\n to consistently select from a wide range of instance types. To indicate no price\n protection threshold for Spot Instances, meaning you want to consider all instance\n types that match your attributes, include one of these parameters and specify a high\n value, such as 999999.

\n " + } + }, + "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { + "target": "com.amazonaws.autoscaling#NullablePositiveInteger", + "traits": { + "smithy.api#documentation": "

[Price protection] The price protection threshold for Spot Instances, as a percentage\n of an identified On-Demand price. The identified On-Demand price is the price of the\n lowest priced current generation C, M, or R instance type with your specified\n attributes. If no current generation C, M, or R instance type matches your attributes,\n then the identified price is from either the lowest priced current generation instance\n types or, failing that, the lowest priced previous generation instance types that match\n your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will\n exclude instance types whose price exceeds your specified threshold.

\n

The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

\n

If you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is based on the per-vCPU or\n per-memory price instead of the per instance price.

\n \n

Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If\n you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection\n to consistently select from a wide range of instance types. To indicate no price\n protection threshold for Spot Instances, meaning you want to consider all instance\n types that match your attributes, include one of these parameters and specify a high\n value, such as 999999.

\n " + } + }, + "OnDemandMaxPricePercentageOverLowestPrice": { + "target": "com.amazonaws.autoscaling#NullablePositiveInteger", + "traits": { + "smithy.api#documentation": "

[Price protection] The price protection threshold for On-Demand Instances, as a\n percentage higher than an identified On-Demand price. The identified On-Demand price is\n the price of the lowest priced current generation C, M, or R instance type with your\n specified attributes. If no current generation C, M, or R instance type matches your\n attributes, then the identified price is from either the lowest priced current\n generation instance types or, failing that, the lowest priced previous generation\n instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with\n your attributes, we will exclude instance types whose price exceeds your specified\n threshold.

\n

The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

\n

To turn off price protection, specify a high value, such as 999999.

\n

If you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is applied based on the\n per-vCPU or per-memory price instead of the per instance price.

\n

Default: 20\n

" + } + }, + "BareMetal": { + "target": "com.amazonaws.autoscaling#BareMetal", + "traits": { + "smithy.api#documentation": "

Indicates whether bare metal instance types are included, excluded, or\n required.

\n

Default: excluded\n

" + } + }, + "BurstablePerformance": { + "target": "com.amazonaws.autoscaling#BurstablePerformance", + "traits": { + "smithy.api#documentation": "

Indicates whether burstable performance instance types are included, excluded, or\n required. For more information, see Burstable\n performance instances in the Amazon EC2 User Guide for Linux Instances.

\n

Default: excluded\n

" + } + }, + "RequireHibernateSupport": { + "target": "com.amazonaws.autoscaling#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Indicates whether instance types must provide On-Demand Instance hibernation\n support.

\n

Default: false\n

" + } + }, + "NetworkInterfaceCount": { + "target": "com.amazonaws.autoscaling#NetworkInterfaceCountRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of network interfaces for an instance type.

\n

Default: No minimum or maximum limits

" + } + }, + "LocalStorage": { + "target": "com.amazonaws.autoscaling#LocalStorage", + "traits": { + "smithy.api#documentation": "

Indicates whether instance types with instance store volumes are included, excluded,\n or required. For more information, see Amazon EC2 instance store in\n the Amazon EC2 User Guide for Linux Instances.

\n

Default: included\n

" + } + }, + "LocalStorageTypes": { + "target": "com.amazonaws.autoscaling#LocalStorageTypes", + "traits": { + "smithy.api#documentation": "

Indicates the type of local storage that is required.

\n \n

Default: Any local storage type

" + } + }, + "TotalLocalStorageGB": { + "target": "com.amazonaws.autoscaling#TotalLocalStorageGBRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum total local storage size for an instance type, in GB.

\n

Default: No minimum or maximum limits

" + } + }, + "BaselineEbsBandwidthMbps": { + "target": "com.amazonaws.autoscaling#BaselineEbsBandwidthMbpsRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum baseline bandwidth performance for an instance type, in Mbps.\n For more information, see Amazon EBS–optimized instances\n in the Amazon EC2 User Guide for Linux Instances.

\n

Default: No minimum or maximum limits

" + } + }, + "AcceleratorTypes": { + "target": "com.amazonaws.autoscaling#AcceleratorTypes", + "traits": { + "smithy.api#documentation": "

Lists the accelerator types that must be on an instance type.

\n \n

Default: Any accelerator type

" + } + }, + "AcceleratorCount": { + "target": "com.amazonaws.autoscaling#AcceleratorCountRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia\n chips) for an instance type.

\n

To exclude accelerator-enabled instance types, set Max to\n 0.

\n

Default: No minimum or maximum limits

" + } + }, + "AcceleratorManufacturers": { + "target": "com.amazonaws.autoscaling#AcceleratorManufacturers", + "traits": { + "smithy.api#documentation": "

Indicates whether instance types must have accelerators by specific\n manufacturers.

\n \n

Default: Any manufacturer

" + } + }, + "AcceleratorNames": { + "target": "com.amazonaws.autoscaling#AcceleratorNames", + "traits": { + "smithy.api#documentation": "

Lists the accelerators that must be on an instance type.

\n \n

Default: Any accelerator

" + } + }, + "AcceleratorTotalMemoryMiB": { + "target": "com.amazonaws.autoscaling#AcceleratorTotalMemoryMiBRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum total memory size for the accelerators on an instance type, in\n MiB.

\n

Default: No minimum or maximum limits

" + } + }, + "NetworkBandwidthGbps": { + "target": "com.amazonaws.autoscaling#NetworkBandwidthGbpsRequest", + "traits": { + "smithy.api#documentation": "

The minimum and maximum amount of network bandwidth, in gigabits per second\n (Gbps).

\n

Default: No minimum or maximum limits

" + } + }, + "AllowedInstanceTypes": { + "target": "com.amazonaws.autoscaling#AllowedInstanceTypes", + "traits": { + "smithy.api#documentation": "

The instance types to apply your specified attributes against. All other instance\n types are ignored, even if they match your specified attributes.

\n

You can use strings with one or more wild cards, represented by an asterisk\n (*), to allow an instance type, size, or generation. The following are\n examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.

\n

For example, if you specify c5*, Amazon EC2 Auto Scaling will allow the entire C5\n instance family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n\n instance types.

\n \n

If you specify AllowedInstanceTypes, you can't specify\n ExcludedInstanceTypes.

\n \n

Default: All instance types

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your\n specified requirements to identify instance types. Then, it uses your On-Demand and Spot\n allocation strategies to launch instances from these instance types.

\n

When you specify multiple attributes, you get instance types that satisfy all of the\n specified attributes. If you specify multiple values for an attribute, you get instance\n types that satisfy any of the specified values.

\n

To limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance\n types, you can use one of the following parameters, but not both in the same\n request:

\n \n \n

You must specify VCpuCount and MemoryMiB. All other\n attributes are optional. Any unspecified optional attribute is set to its\n default.

\n \n

For more information, see Create a mixed instances group using attribute-based instance type\n selection in the Amazon EC2 Auto Scaling User Guide. For help determining\n which instance types match your attributes before you apply them to your Auto Scaling group, see\n Preview instance types with specified attributes in the\n Amazon EC2 User Guide for Linux Instances.

" + } + }, + "com.amazonaws.autoscaling#InstanceReusePolicy": { + "type": "structure", + "members": { + "ReuseOnScaleIn": { + "target": "com.amazonaws.autoscaling#ReuseOnScaleIn", + "traits": { + "smithy.api#documentation": "

Specifies whether instances in the Auto Scaling group can be returned to the warm pool on\n scale in.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an instance reuse policy for a warm pool.

\n

For more information, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "com.amazonaws.autoscaling#Instances": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#Instance" + } + }, + "com.amazonaws.autoscaling#InstancesDistribution": { + "type": "structure", + "members": { + "OnDemandAllocationStrategy": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The allocation strategy to apply to your On-Demand Instances when they are launched.\n Possible instance types are determined by the launch template overrides that you\n specify.

\n

The following lists the valid values:

\n
\n
lowest-price
\n
\n

Uses price to determine which instance types are the highest priority,\n launching the lowest priced instance types within an Availability Zone\n first. This is the default value for Auto Scaling groups that specify InstanceRequirements.

\n
\n
prioritized
\n
\n

You set the order of instance types for the launch template overrides from\n highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling\n launches your highest priority instance types first. If all your On-Demand\n capacity cannot be fulfilled using your highest priority instance type, then\n Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance\n type, and so on. This is the default value for Auto Scaling groups that don't\n specify InstanceRequirements and cannot be used for groups\n that do.

\n
\n
" + } + }, + "OnDemandBaseCapacity": { + "target": "com.amazonaws.autoscaling#OnDemandBaseCapacity", + "traits": { + "smithy.api#documentation": "

The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand\n Instances. This base portion is launched first as your group scales.

\n

This number has the same unit of measurement as the group's desired capacity. If you\n change the default unit of measurement (number of instances) by specifying weighted\n capacity values in your launch template overrides list, or by changing the default\n desired capacity type setting of the group, you must specify this number using the same\n unit of measurement.

\n

Default: 0

" + } + }, + "OnDemandPercentageAboveBaseCapacity": { + "target": "com.amazonaws.autoscaling#OnDemandPercentageAboveBaseCapacity", + "traits": { + "smithy.api#documentation": "

Controls the percentages of On-Demand Instances and Spot Instances for your additional\n capacity beyond OnDemandBaseCapacity. Expressed as a number (for example,\n 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand\n Instances are used.

\n

Default: 100

" + } + }, + "SpotAllocationStrategy": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The allocation strategy to apply to your Spot Instances when they are launched.\n Possible instance types are determined by the launch template overrides that you\n specify.

\n

The following lists the valid values:

\n
\n
capacity-optimized
\n
\n

Requests Spot Instances using pools that are optimally chosen based on the\n available Spot capacity. This strategy has the lowest risk of interruption.\n To give certain instance types a higher chance of launching first, use\n capacity-optimized-prioritized.

\n
\n
capacity-optimized-prioritized
\n
\n

You set the order of instance types for the launch template overrides from\n highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors\n the instance type priorities on a best effort basis but optimizes for\n capacity first. Note that if the On-Demand allocation strategy is set to\n prioritized, the same priority is applied when fulfilling\n On-Demand capacity. This is not a valid value for Auto Scaling groups that specify\n InstanceRequirements.

\n
\n
lowest-price
\n
\n

Requests Spot Instances using the lowest priced pools within an\n Availability Zone, across the number of Spot pools that you specify for the\n SpotInstancePools property. To ensure that your desired\n capacity is met, you might receive Spot Instances from several pools. This\n is the default value, but it might lead to high interruption rates because\n this strategy only considers instance price and not available\n capacity.

\n
\n
price-capacity-optimized (recommended)
\n
\n

The price and capacity optimized allocation strategy looks at both price\n and capacity to select the Spot Instance pools that are the least likely to\n be interrupted and have the lowest possible price.

\n
\n
" + } + }, + "SpotInstancePools": { + "target": "com.amazonaws.autoscaling#SpotInstancePools", + "traits": { + "smithy.api#documentation": "

The number of Spot Instance pools across which to allocate your Spot Instances. The\n Spot pools are determined from the different instance types in the overrides. Valid only\n when the SpotAllocationStrategy is lowest-price. Value must be\n in the range of 1–20.

\n

Default: 2

" + } + }, + "SpotMaxPrice": { + "target": "com.amazonaws.autoscaling#MixedInstanceSpotPrice", + "traits": { + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. If\n your maximum price is lower than the Spot price for the instance types that you\n selected, your Spot Instances are not launched. We do not recommend specifying a maximum\n price because it can lead to increased interruptions. When Spot Instances launch, you\n pay the current Spot price. To remove a maximum price that you previously set, include\n the property but specify an empty string (\"\") for the value.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently\n than if you do not specify one.

\n \n

Valid Range: Minimum value of 0.001

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Use this structure to specify the distribution of On-Demand Instances and Spot\n Instances and the allocation strategies used to fulfill On-Demand and Spot capacities\n for a mixed instances policy.

" + } + }, + "com.amazonaws.autoscaling#InstancesToUpdate": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.autoscaling#IntPercent": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.autoscaling#IntPercent100To200": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 100, + "max": 200 + } + } + }, + "com.amazonaws.autoscaling#IntPercent100To200Resettable": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": -1, + "max": 200 + } + } + }, + "com.amazonaws.autoscaling#IntPercentResettable": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": -1, + "max": 100 + } + } + }, + "com.amazonaws.autoscaling#InvalidNextToken": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidNextToken", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The NextToken value is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.autoscaling#IrreversibleInstanceRefreshFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "IrreversibleInstanceRefresh", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request failed because a desired configuration was not found or an incompatible\n launch template (uses a Systems Manager parameter instead of an AMI ID) or launch\n template version ($Latest or $Default) is present on the Auto Scaling\n group.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.autoscaling#LaunchConfiguration": { + "type": "structure", + "members": { + "LaunchConfigurationName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the launch configuration.

", + "smithy.api#required": {} + } + }, + "LaunchConfigurationARN": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the launch configuration.

" + } + }, + "ImageId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more\n information, see Find a Linux AMI in the\n Amazon EC2 User Guide for Linux Instances.

", + "smithy.api#required": {} + } + }, + "KeyName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the key pair.

\n

For more information, see Amazon EC2 key pairs and Amazon EC2\n instances in the Amazon EC2 User Guide for Linux Instances.

" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.autoscaling#SecurityGroups", + "traits": { + "smithy.api#documentation": "

A list that contains the security groups to assign to the instances in the Auto Scaling group.\n For more information, see Control traffic to your Amazon Web Services\n resources using security groups in the Amazon Virtual Private\n Cloud User Guide.

" + } + }, + "ClassicLinkVPCId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

Available for backward compatibility.

" + } + }, + "ClassicLinkVPCSecurityGroups": { + "target": "com.amazonaws.autoscaling#ClassicLinkVPCSecurityGroups", + "traits": { + "smithy.api#documentation": "

Available for backward compatibility.

" + } + }, + "UserData": { + "target": "com.amazonaws.autoscaling#XmlStringUserData", + "traits": { + "smithy.api#documentation": "

The user data to make available to the launched EC2 instances. For more information,\n see Instance metadata and user data (Linux) and Instance metadata and\n user data (Windows). If you are using a command line tool, base64-encoding\n is performed for you, and you can load the text from a file. Otherwise, you must provide\n base64-encoded text. User data is limited to 16 KB.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance type for the instances. For information about available instance types,\n see Available\n instance types in the Amazon EC2 User Guide for Linux Instances.

", + "smithy.api#required": {} + } + }, + "KernelId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The ID of the kernel associated with the AMI.

" + } + }, + "RamdiskId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The ID of the RAM disk associated with the AMI.

" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.autoscaling#BlockDeviceMappings", + "traits": { + "smithy.api#documentation": "

The block device mapping entries that define the block devices to attach to the\n instances at launch. By default, the block devices specified in the block device mapping\n for the AMI are used. For more information, see Block device\n mappings in the Amazon EC2 User Guide for Linux Instances.

" + } + }, + "InstanceMonitoring": { + "target": "com.amazonaws.autoscaling#InstanceMonitoring", + "traits": { + "smithy.api#documentation": "

Controls whether instances in this group are launched with detailed\n (true) or basic (false) monitoring.

\n

For more information, see Configure\n monitoring for Auto Scaling instances in the\n Amazon EC2 Auto Scaling User Guide.

" + } + }, + "SpotPrice": { + "target": "com.amazonaws.autoscaling#SpotPrice", + "traits": { + "smithy.api#documentation": "

The maximum hourly price to be paid for any Spot Instance launched to fulfill the\n request. Spot Instances are launched when the price you specify exceeds the current Spot\n price. For more information, see Requesting Spot\n Instances for fault-tolerant and flexible applications in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen1600", + "traits": { + "smithy.api#documentation": "

The name or the Amazon Resource Name (ARN) of the instance profile associated with the\n IAM role for the instance. The instance profile contains the IAM role. For more\n information, see IAM role for applications that run\n on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.autoscaling#TimestampType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The creation date and time for the launch configuration.

", + "smithy.api#required": {} + } + }, + "EbsOptimized": { + "target": "com.amazonaws.autoscaling#EbsOptimized", + "traits": { + "smithy.api#documentation": "

Specifies whether the launch configuration is optimized for EBS I/O\n (true) or not (false). For more information, see Amazon EBS-optimized instances in the\n Amazon EC2 User Guide for Linux Instances.

" + } + }, + "AssociatePublicIpAddress": { + "target": "com.amazonaws.autoscaling#AssociatePublicIpAddress", + "traits": { + "smithy.api#documentation": "

Specifies whether to assign a public IPv4 address to the group's instances. If the\n instance is launched into a default subnet, the default is to assign a public IPv4\n address, unless you disabled the option to assign a public IPv4 address on the subnet.\n If the instance is launched into a nondefault subnet, the default is not to assign a\n public IPv4 address, unless you enabled the option to assign a public IPv4 address on\n the subnet. For more information, see Provide network connectivity for\n your Auto Scaling instances using Amazon VPC in the\n Amazon EC2 Auto Scaling User Guide.

" + } + }, + "PlacementTenancy": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", + "traits": { + "smithy.api#documentation": "

The tenancy of the instance, either default or dedicated. An\n instance with dedicated tenancy runs on isolated, single-tenant hardware\n and can only be launched into a VPC.

" + } + }, + "MetadataOptions": { + "target": "com.amazonaws.autoscaling#InstanceMetadataOptions", + "traits": { + "smithy.api#documentation": "

The metadata options for the instances. For more information, see Configure the instance metadata options in the\n Amazon EC2 Auto Scaling User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a launch configuration.

" + } + }, + "com.amazonaws.autoscaling#LaunchConfigurationNameType": { + "type": "structure", + "members": { + "LaunchConfigurationName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the launch configuration.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#LaunchConfigurationNames": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" + } + }, + "com.amazonaws.autoscaling#LaunchConfigurationNamesType": { + "type": "structure", + "members": { + "LaunchConfigurationNames": { + "target": "com.amazonaws.autoscaling#LaunchConfigurationNames", + "traits": { + "smithy.api#documentation": "

The launch configuration names. If you omit this property, all launch configurations\n are described.

\n

Array Members: Maximum number of 50 items.

" + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.autoscaling#MaxRecords", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.

" + } + } + } + }, + "com.amazonaws.autoscaling#LaunchConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#LaunchConfiguration" + } + }, + "com.amazonaws.autoscaling#LaunchConfigurationsType": { + "type": "structure", + "members": { + "LaunchConfigurations": { + "target": "com.amazonaws.autoscaling#LaunchConfigurations", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The launch configurations.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" + } + } + } + }, + "com.amazonaws.autoscaling#LaunchTemplate": { + "type": "structure", + "members": { + "LaunchTemplateSpecification": { + "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", + "traits": { + "smithy.api#documentation": "

The launch template.

" + } + }, + "Overrides": { + "target": "com.amazonaws.autoscaling#Overrides", + "traits": { + "smithy.api#documentation": "

Any properties that you specify override the same properties in the launch\n template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Use this structure to specify the launch templates and instance types (overrides) for\n a mixed instances policy.

" + } + }, + "com.amazonaws.autoscaling#LaunchTemplateName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\(\\)\\.\\-/_]+$" + } + }, + "com.amazonaws.autoscaling#LaunchTemplateOverrides": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The instance type, such as m3.xlarge. You must specify an instance type\n that is supported in your requested Region and Availability Zones. For more information,\n see Instance types in the Amazon EC2 User Guide for Linux Instances.

\n

You can specify up to 40 instance types per Auto Scaling group.

" + } + }, + "WeightedCapacity": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", + "traits": { + "smithy.api#documentation": "

If you provide a list of instance types to use, you can specify the number of capacity\n units provided by each instance type in terms of virtual CPUs, memory, storage,\n throughput, or other relative performance characteristic. When a Spot or On-Demand\n Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling\n launches instances until the desired capacity is totally fulfilled, even if this results\n in an overage. For example, if there are two units remaining to fulfill capacity, and\n Amazon EC2 Auto Scaling can only launch an instance with a WeightedCapacity of five units,\n the instance is launched, and the desired capacity is exceeded by three units. For more\n information, see Configure an Auto Scaling group to use instance weights in the\n Amazon EC2 Auto Scaling User Guide. Value must be in the range of 1–999.

\n

If you specify a value for WeightedCapacity for one instance type, you\n must specify a value for WeightedCapacity for all of them.

\n \n

Every Auto Scaling group has three size parameters (DesiredCapacity,\n MaxSize, and MinSize). Usually, you set these sizes\n based on a specific number of instances. However, if you configure a mixed instances\n policy that defines weights for the instance types, you must specify these sizes\n with the same units that you use for weighting instances.

\n " + } + }, + "LaunchTemplateSpecification": { + "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", + "traits": { + "smithy.api#documentation": "

Provides a launch template for the specified instance type or set of instance\n requirements. For example, some instance types might require a launch template with a\n different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in\n the LaunchTemplate definition. For more information, see Specifying a different launch template for an instance type in the\n Amazon EC2 Auto Scaling User Guide.

\n

You can specify up to 20 launch templates per Auto Scaling group. The launch templates\n specified in the overrides and in the LaunchTemplate definition count\n towards this limit.

" + } + }, + "InstanceRequirements": { + "target": "com.amazonaws.autoscaling#InstanceRequirements", + "traits": { + "smithy.api#documentation": "

The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify\n instance types. Then, it uses your On-Demand and Spot allocation strategies to launch\n instances from these instance types.

\n

You can specify up to four separate sets of instance requirements per Auto Scaling group. This\n is useful for provisioning instances from different Amazon Machine Images (AMIs) in the\n same Auto Scaling group. To do this, create the AMIs and create a new launch template for each\n AMI. Then, create a compatible set of instance requirements for each launch template.\n

\n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Use this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling group has a mixed\n instances policy:

\n \n

Specify the instance types that you want, or define your instance requirements instead\n and let Amazon EC2 Auto Scaling provision the available instance types that meet your requirements.\n This can provide Amazon EC2 Auto Scaling with a larger selection of instance types to choose from when\n fulfilling Spot and On-Demand capacities. You can view which instance types are matched\n before you apply the instance requirements to your Auto Scaling group.

\n

After you define your instance requirements, you don't have to keep updating these\n settings to get new EC2 instance types automatically. Amazon EC2 Auto Scaling uses the instance\n requirements of the Auto Scaling group to determine whether a new EC2 instance type can be\n used.

" + } + }, + "com.amazonaws.autoscaling#LaunchTemplateSpecification": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created\n using the Amazon EC2 CreateLaunchTemplate API.

\n

Conditional: You must specify either a LaunchTemplateId or a\n LaunchTemplateName.

" + } + }, + "LaunchTemplateName": { + "target": "com.amazonaws.autoscaling#LaunchTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created\n using the Amazon EC2 CreateLaunchTemplate API.

\n

Conditional: You must specify either a LaunchTemplateId or a\n LaunchTemplateName.

" + } + }, + "Version": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The version number, $Latest, or $Default. To get the version\n number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions\n can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is $Latest,\n Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If\n the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch\n template when launching instances. The default value is $Default.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling\n uses to launch Amazon EC2 instances. For more information about launch templates, see Launch\n templates in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "com.amazonaws.autoscaling#LifecycleActionResult": { + "type": "string" + }, + "com.amazonaws.autoscaling#LifecycleActionToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + } + } + }, + "com.amazonaws.autoscaling#LifecycleHook": { + "type": "structure", + "members": { + "LifecycleHookName": { + "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the lifecycle hook.

" + } + }, + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the Auto Scaling group for the lifecycle hook.

" + } + }, + "LifecycleTransition": { + "target": "com.amazonaws.autoscaling#LifecycleTransition", + "traits": { + "smithy.api#documentation": "

The lifecycle transition.

\n

Valid values: autoscaling:EC2_INSTANCE_LAUNCHING |\n autoscaling:EC2_INSTANCE_TERMINATING\n

" + } + }, + "NotificationTargetARN": { + "target": "com.amazonaws.autoscaling#NotificationTargetResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a\n wait state for the lifecycle hook.

" + } + }, + "RoleARN": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target (an Amazon SNS topic or an Amazon SQS queue).

" + } + }, + "NotificationMetadata": { + "target": "com.amazonaws.autoscaling#AnyPrintableAsciiStringMaxLen4000", + "traits": { + "smithy.api#documentation": "

Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the\n notification target.

" + } + }, + "HeartbeatTimeout": { + "target": "com.amazonaws.autoscaling#HeartbeatTimeout", + "traits": { + "smithy.api#documentation": "

The maximum time, in seconds, that can elapse before the lifecycle hook times out. If\n the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the\n DefaultResult property.

" + } + }, + "GlobalTimeout": { + "target": "com.amazonaws.autoscaling#GlobalTimeout", + "traits": { + "smithy.api#documentation": "

The maximum time, in seconds, that an instance can remain in a wait state. The maximum\n is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is\n smaller.

" + } + }, + "DefaultResult": { + "target": "com.amazonaws.autoscaling#LifecycleActionResult", + "traits": { + "smithy.api#documentation": "

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an\n unexpected failure occurs.

\n

Valid values: CONTINUE | ABANDON\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a lifecycle hook. A lifecycle hook lets you create solutions that are aware\n of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances\n when the corresponding lifecycle event\n occurs.

" + } + }, + "com.amazonaws.autoscaling#LifecycleHookNames": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.autoscaling#LifecycleHookSpecification": { + "type": "structure", + "members": { + "LifecycleHookName": { + "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the lifecycle hook.

", + "smithy.api#required": {} + } + }, + "LifecycleTransition": { + "target": "com.amazonaws.autoscaling#LifecycleTransition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The lifecycle transition. For Auto Scaling groups, there are two major lifecycle\n transitions.

\n ", + "smithy.api#required": {} + } + }, + "NotificationMetadata": { + "target": "com.amazonaws.autoscaling#AnyPrintableAsciiStringMaxLen4000", + "traits": { + "smithy.api#documentation": "

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to\n the notification target.

" + } + }, + "HeartbeatTimeout": { + "target": "com.amazonaws.autoscaling#HeartbeatTimeout", + "traits": { + "smithy.api#documentation": "

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The\n range is from 30 to 7200 seconds. The default value is\n 3600 seconds (1 hour).

" + } + }, + "DefaultResult": { + "target": "com.amazonaws.autoscaling#LifecycleActionResult", + "traits": { + "smithy.api#documentation": "

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an\n unexpected failure occurs. The default value is ABANDON.

\n

Valid values: CONTINUE | ABANDON\n

" + } + }, + "NotificationTargetARN": { + "target": "com.amazonaws.autoscaling#NotificationTargetResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends\n notifications to when an instance is in a wait state for the lifecycle hook. You can\n specify an Amazon SNS topic or an Amazon SQS queue.

" + } + }, + "RoleARN": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target. For information about creating this role, see Prepare to\n add a lifecycle hook to your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes information used to specify a lifecycle hook for an Auto Scaling\n group.

\n

For more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "com.amazonaws.autoscaling#LifecycleHookSpecifications": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#LifecycleHookSpecification" + } + }, + "com.amazonaws.autoscaling#LifecycleHooks": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#LifecycleHook" + } + }, + "com.amazonaws.autoscaling#LifecycleState": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "PENDING_WAIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending:Wait" + } + }, + "PENDING_PROCEED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending:Proceed" + } + }, + "QUARANTINED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Quarantined" + } + }, + "IN_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "TERMINATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terminating" + } + }, + "TERMINATING_WAIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terminating:Wait" + } + }, + "TERMINATING_PROCEED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terminating:Proceed" + } + }, + "TERMINATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terminated" + } + }, + "DETACHING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Detaching" + } + }, + "DETACHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Detached" + } + }, + "ENTERING_STANDBY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EnteringStandby" + } + }, + "STANDBY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Standby" + } + }, + "WARMED_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Warmed:Pending" + } + }, + "WARMED_PENDING_WAIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Warmed:Pending:Wait" + } + }, + "WARMED_PENDING_PROCEED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Warmed:Pending:Proceed" + } + }, + "WARMED_TERMINATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Warmed:Terminating" + } + }, + "WARMED_TERMINATING_WAIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Warmed:Terminating:Wait" + } + }, + "WARMED_TERMINATING_PROCEED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Warmed:Terminating:Proceed" + } + }, + "WARMED_TERMINATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Warmed:Terminated" + } + }, + "WARMED_STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Warmed:Stopped" + } + }, + "WARMED_RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Warmed:Running" + } + }, + "WARMED_HIBERNATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Warmed:Hibernated" + } + } + } + }, + "com.amazonaws.autoscaling#LifecycleTransition": { + "type": "string" + }, + "com.amazonaws.autoscaling#LimitExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "LimitExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You have already reached a limit for your Amazon EC2 Auto Scaling\n resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For\n more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API\n Reference.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.autoscaling#LoadBalancerNames": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" + } + }, + "com.amazonaws.autoscaling#LoadBalancerState": { + "type": "structure", + "members": { + "LoadBalancerName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the load balancer.

" + } + }, + "State": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

One of the following load balancer states:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of a Classic Load Balancer.

" + } + }, + "com.amazonaws.autoscaling#LoadBalancerStates": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#LoadBalancerState" + } + }, + "com.amazonaws.autoscaling#LoadBalancerTargetGroupState": { + "type": "structure", + "members": { + "LoadBalancerTargetGroupARN": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen511", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

" + } + }, + "State": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The state of the target group.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of a target group.

" + } + }, + "com.amazonaws.autoscaling#LoadBalancerTargetGroupStates": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#LoadBalancerTargetGroupState" + } + }, + "com.amazonaws.autoscaling#LoadForecast": { + "type": "structure", + "members": { + "Timestamps": { + "target": "com.amazonaws.autoscaling#PredictiveScalingForecastTimestamps", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The timestamps for the data points, in UTC format.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.autoscaling#PredictiveScalingForecastValues", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The values of the data points.

", + "smithy.api#required": {} + } + }, + "MetricSpecification": { + "target": "com.amazonaws.autoscaling#PredictiveScalingMetricSpecification", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The metric specification for the load forecast.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A GetPredictiveScalingForecast call returns the load forecast for a\n predictive scaling policy. This structure includes the data points for that load\n forecast, along with the timestamps of those data points and the metric specification.\n

" + } + }, + "com.amazonaws.autoscaling#LoadForecasts": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#LoadForecast" + } + }, + "com.amazonaws.autoscaling#LocalStorage": { + "type": "enum", + "members": { + "INCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "included" + } + }, + "EXCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "excluded" + } + }, + "REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "required" + } + } + } + }, + "com.amazonaws.autoscaling#LocalStorageType": { + "type": "enum", + "members": { + "HDD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hdd" + } + }, + "SSD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ssd" + } + } + } + }, + "com.amazonaws.autoscaling#LocalStorageTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#LocalStorageType" + } + }, + "com.amazonaws.autoscaling#MaxGroupPreparedCapacity": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": -1 + } + } + }, + "com.amazonaws.autoscaling#MaxInstanceLifetime": { + "type": "integer" + }, + "com.amazonaws.autoscaling#MaxNumberOfAutoScalingGroups": { + "type": "integer" + }, + "com.amazonaws.autoscaling#MaxNumberOfLaunchConfigurations": { + "type": "integer" + }, + "com.amazonaws.autoscaling#MaxRecords": { + "type": "integer" + }, + "com.amazonaws.autoscaling#MemoryGiBPerVCpuRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.autoscaling#NullablePositiveDouble", + "traits": { + "smithy.api#documentation": "

The memory minimum in GiB.

" + } + }, + "Max": { + "target": "com.amazonaws.autoscaling#NullablePositiveDouble", + "traits": { + "smithy.api#documentation": "

The memory maximum in GiB.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the minimum and maximum for the MemoryGiBPerVCpu object when\n you specify InstanceRequirements for an Auto Scaling group.

" + } + }, + "com.amazonaws.autoscaling#MemoryMiBRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.autoscaling#NullablePositiveInteger", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The memory minimum in MiB.

", + "smithy.api#required": {} + } + }, + "Max": { + "target": "com.amazonaws.autoscaling#NullablePositiveInteger", + "traits": { + "smithy.api#documentation": "

The memory maximum in MiB.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the minimum and maximum for the MemoryMiB object when you\n specify InstanceRequirements for an Auto Scaling group.

" + } + }, + "com.amazonaws.autoscaling#Metric": { + "type": "structure", + "members": { + "Namespace": { + "target": "com.amazonaws.autoscaling#MetricNamespace", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The namespace of the metric. For more information, see the table in Amazon Web Services\n services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.

", + "smithy.api#required": {} + } + }, + "MetricName": { + "target": "com.amazonaws.autoscaling#MetricName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the metric.

", + "smithy.api#required": {} + } + }, + "Dimensions": { + "target": "com.amazonaws.autoscaling#MetricDimensions", + "traits": { + "smithy.api#documentation": "

The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services\n documentation available from the table in Amazon Web Services\n services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.

\n

Conditional: If you published your metric with dimensions, you must specify the same\n dimensions in your scaling policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a specific metric.

" + } + }, + "com.amazonaws.autoscaling#MetricCollectionType": { + "type": "structure", + "members": { + "Metric": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

One of the following metrics:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a metric.

" + } + }, + "com.amazonaws.autoscaling#MetricCollectionTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#MetricCollectionType" + } + }, + "com.amazonaws.autoscaling#MetricDataQueries": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#MetricDataQuery" + } + }, + "com.amazonaws.autoscaling#MetricDataQuery": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A short name that identifies the object's results in the response. This name must be\n unique among all MetricDataQuery objects specified for a single scaling\n policy. If you are performing math expressions on this set of data, this name represents\n that data and can serve as a variable in the mathematical expression. The valid\n characters are letters, numbers, and underscores. The first character must be a\n lowercase letter.

", + "smithy.api#required": {} + } + }, + "Expression": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", + "traits": { + "smithy.api#documentation": "

The math expression to perform on the returned data, if this object is performing a\n math expression. This expression can use the Id of the other metrics to\n refer to those metrics, and can also use the Id of other expressions to use\n the result of those expressions.

\n

Conditional: Within each MetricDataQuery object, you must specify either\n Expression or MetricStat, but not both.

" + } + }, + "MetricStat": { + "target": "com.amazonaws.autoscaling#MetricStat", + "traits": { + "smithy.api#documentation": "

Information about the metric data to return.

\n

Conditional: Within each MetricDataQuery object, you must specify either\n Expression or MetricStat, but not both.

" + } + }, + "Label": { + "target": "com.amazonaws.autoscaling#XmlStringMetricLabel", + "traits": { + "smithy.api#documentation": "

A human-readable label for this metric or expression. This is especially useful if\n this is a math expression, so that you know what the value represents.

" + } + }, + "ReturnData": { + "target": "com.amazonaws.autoscaling#ReturnData", + "traits": { + "smithy.api#documentation": "

Indicates whether to return the timestamps and raw data values of this metric.

\n

If you use any math expressions, specify true for this value for only the\n final math expression that the metric specification is based on. You must specify\n false for ReturnData for all the other metrics and\n expressions used in the metric specification.

\n

If you are only retrieving metrics and not performing any math expressions, do not\n specify anything for ReturnData. This sets it to its default\n (true).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metric data to return. Also defines whether this call is returning data for one\n metric only, or whether it is performing a math expression on the values of returned\n metric statistics to create a new time series. A time series is a series of data points,\n each of which is associated with a timestamp.

\n

For more information and examples, see Advanced predictive scaling policy configurations using custom metrics in\n the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "com.amazonaws.autoscaling#MetricDimension": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.autoscaling#MetricDimensionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the dimension.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.autoscaling#MetricDimensionValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The value of the dimension.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the dimension of a metric.

" + } + }, + "com.amazonaws.autoscaling#MetricDimensionName": { + "type": "string" + }, + "com.amazonaws.autoscaling#MetricDimensionValue": { + "type": "string" + }, + "com.amazonaws.autoscaling#MetricDimensions": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#MetricDimension" + } + }, + "com.amazonaws.autoscaling#MetricGranularityType": { + "type": "structure", + "members": { + "Granularity": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The granularity. The only valid value is 1Minute.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a granularity of a metric.

" + } + }, + "com.amazonaws.autoscaling#MetricGranularityTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#MetricGranularityType" + } + }, + "com.amazonaws.autoscaling#MetricName": { + "type": "string" + }, + "com.amazonaws.autoscaling#MetricNamespace": { + "type": "string" + }, + "com.amazonaws.autoscaling#MetricScale": { + "type": "double" + }, + "com.amazonaws.autoscaling#MetricStat": { + "type": "structure", + "members": { + "Metric": { + "target": "com.amazonaws.autoscaling#Metric", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The CloudWatch metric to return, including the metric name, namespace, and dimensions. To\n get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.

", + "smithy.api#required": {} + } + }, + "Stat": { + "target": "com.amazonaws.autoscaling#XmlStringMetricStat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The statistic to return. It can include any CloudWatch statistic or extended statistic. For\n a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.

\n

The most commonly used metrics for predictive scaling are Average and\n Sum.

", + "smithy.api#required": {} + } + }, + "Unit": { + "target": "com.amazonaws.autoscaling#MetricUnit", + "traits": { + "smithy.api#documentation": "

The unit to use for the returned data points. For a complete list of the units that\n CloudWatch supports, see the MetricDatum\n data type in the Amazon CloudWatch API Reference.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This structure defines the CloudWatch metric to return, along with the statistic and\n unit.

\n

For more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts in the Amazon CloudWatch User Guide.

" + } + }, + "com.amazonaws.autoscaling#MetricStatistic": { + "type": "enum", + "members": { + "Average": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Average" + } + }, + "Minimum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Minimum" + } + }, + "Maximum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Maximum" + } + }, + "SampleCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SampleCount" + } + }, + "Sum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Sum" + } + } + } + }, + "com.amazonaws.autoscaling#MetricType": { + "type": "enum", + "members": { + "ASGAverageCPUUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASGAverageCPUUtilization" + } + }, + "ASGAverageNetworkIn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASGAverageNetworkIn" + } + }, + "ASGAverageNetworkOut": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASGAverageNetworkOut" + } + }, + "ALBRequestCountPerTarget": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALBRequestCountPerTarget" + } + } + } + }, + "com.amazonaws.autoscaling#MetricUnit": { + "type": "string" + }, + "com.amazonaws.autoscaling#Metrics": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" + } + }, + "com.amazonaws.autoscaling#MinAdjustmentMagnitude": { + "type": "integer" + }, + "com.amazonaws.autoscaling#MinAdjustmentStep": { + "type": "integer", + "traits": { + "smithy.api#deprecated": {} + } + }, + "com.amazonaws.autoscaling#MixedInstanceSpotPrice": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.autoscaling#MixedInstancesPolicy": { + "type": "structure", + "members": { + "LaunchTemplate": { + "target": "com.amazonaws.autoscaling#LaunchTemplate", + "traits": { + "smithy.api#documentation": "

One or more launch templates and the instance types (overrides) that are used to\n launch EC2 instances to fulfill On-Demand and Spot capacities.

" + } + }, + "InstancesDistribution": { + "target": "com.amazonaws.autoscaling#InstancesDistribution", + "traits": { + "smithy.api#documentation": "

The instances distribution.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Use this structure to launch multiple instance types and On-Demand Instances and Spot\n Instances within a single Auto Scaling group.

\n

A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch\n instances and help optimize your costs. For more information, see Auto Scaling\n groups with multiple instance types and purchase options in the\n Amazon EC2 Auto Scaling User Guide.

" + } + }, + "com.amazonaws.autoscaling#MonitoringEnabled": { + "type": "boolean" + }, + "com.amazonaws.autoscaling#NetworkBandwidthGbpsRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.autoscaling#NullablePositiveDouble", + "traits": { + "smithy.api#documentation": "

The minimum amount of network bandwidth, in gigabits per second (Gbps).

" + } + }, + "Max": { + "target": "com.amazonaws.autoscaling#NullablePositiveDouble", + "traits": { + "smithy.api#documentation": "

The maximum amount of network bandwidth, in gigabits per second (Gbps).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the minimum and maximum for the NetworkBandwidthGbps object\n when you specify InstanceRequirements for an Auto Scaling group.

\n \n

Setting the minimum bandwidth does not guarantee that your instance will achieve\n the minimum bandwidth. Amazon EC2 will identify instance types that support the specified\n minimum bandwidth, but the actual bandwidth of your instance might go below the\n specified minimum at times. For more information, see Available instance bandwidth in the\n Amazon EC2 User Guide for Linux Instances.

\n " + } + }, + "com.amazonaws.autoscaling#NetworkInterfaceCountRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.autoscaling#NullablePositiveInteger", + "traits": { + "smithy.api#documentation": "

The minimum number of network interfaces.

" + } + }, + "Max": { + "target": "com.amazonaws.autoscaling#NullablePositiveInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of network interfaces.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the minimum and maximum for the NetworkInterfaceCount object\n when you specify InstanceRequirements for an Auto Scaling group.

" + } + }, + "com.amazonaws.autoscaling#NoDevice": { + "type": "boolean" + }, + "com.amazonaws.autoscaling#NonZeroIntPercent": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.autoscaling#NotificationConfiguration": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the Auto Scaling group.

" + } + }, + "TopicARN": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SNS topic.

" + } + }, + "NotificationType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

One of the following event notification types:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a notification.

" + } + }, + "com.amazonaws.autoscaling#NotificationConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#NotificationConfiguration" + } + }, + "com.amazonaws.autoscaling#NotificationTargetResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.autoscaling#NullableBoolean": { + "type": "boolean" + }, + "com.amazonaws.autoscaling#NullablePositiveDouble": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.autoscaling#NullablePositiveInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.autoscaling#NumberOfAutoScalingGroups": { + "type": "integer" + }, + "com.amazonaws.autoscaling#NumberOfLaunchConfigurations": { + "type": "integer" + }, + "com.amazonaws.autoscaling#OnDemandBaseCapacity": { + "type": "integer" + }, + "com.amazonaws.autoscaling#OnDemandPercentageAboveBaseCapacity": { + "type": "integer" + }, + "com.amazonaws.autoscaling#Overrides": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#LaunchTemplateOverrides" + } + }, + "com.amazonaws.autoscaling#PoliciesType": { + "type": "structure", + "members": { + "ScalingPolicies": { + "target": "com.amazonaws.autoscaling#ScalingPolicies", + "traits": { + "smithy.api#documentation": "

The scaling policies.

" + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" + } + } + } + }, + "com.amazonaws.autoscaling#PolicyARNType": { + "type": "structure", + "members": { + "PolicyARN": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy.

" + } + }, + "Alarms": { + "target": "com.amazonaws.autoscaling#Alarms", + "traits": { + "smithy.api#documentation": "

The CloudWatch alarms created for the target tracking scaling policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the output of PutScalingPolicy.

" + } + }, + "com.amazonaws.autoscaling#PolicyIncrement": { + "type": "integer" + }, + "com.amazonaws.autoscaling#PolicyNames": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#ResourceName" + } + }, + "com.amazonaws.autoscaling#PolicyTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen64" + } + }, + "com.amazonaws.autoscaling#PredefinedLoadMetricType": { + "type": "enum", + "members": { + "ASGTotalCPUUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASGTotalCPUUtilization" + } + }, + "ASGTotalNetworkIn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASGTotalNetworkIn" + } + }, + "ASGTotalNetworkOut": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASGTotalNetworkOut" + } + }, + "ALBTargetGroupRequestCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALBTargetGroupRequestCount" + } + } + } + }, + "com.amazonaws.autoscaling#PredefinedMetricPairType": { + "type": "enum", + "members": { + "ASGCPUUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASGCPUUtilization" + } + }, + "ASGNetworkIn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASGNetworkIn" + } + }, + "ASGNetworkOut": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASGNetworkOut" + } + }, + "ALBRequestCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALBRequestCount" + } + } + } + }, + "com.amazonaws.autoscaling#PredefinedMetricSpecification": { + "type": "structure", + "members": { + "PredefinedMetricType": { + "target": "com.amazonaws.autoscaling#MetricType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The metric type. The following predefined metrics are available:

\n ", + "smithy.api#required": {} + } + }, + "ResourceLabel": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", + "traits": { + "smithy.api#documentation": "

A label that uniquely identifies a specific Application Load Balancer target group\n from which to determine the average request count served by your Auto Scaling group. You can't\n specify a resource label unless the target group is attached to the Auto Scaling group.

\n

You create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:

\n

\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

\n

Where:

\n \n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a predefined metric for a target tracking scaling policy to use with\n Amazon EC2 Auto Scaling.

" + } + }, + "com.amazonaws.autoscaling#PredefinedScalingMetricType": { + "type": "enum", + "members": { + "ASGAverageCPUUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASGAverageCPUUtilization" + } + }, + "ASGAverageNetworkIn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASGAverageNetworkIn" + } + }, + "ASGAverageNetworkOut": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASGAverageNetworkOut" + } + }, + "ALBRequestCountPerTarget": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALBRequestCountPerTarget" + } + } + } + }, + "com.amazonaws.autoscaling#PredictiveScalingConfiguration": { + "type": "structure", + "members": { + "MetricSpecifications": { + "target": "com.amazonaws.autoscaling#PredictiveScalingMetricSpecifications", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

This structure includes the metrics and target utilization to use for predictive\n scaling.

\n

This is an array, but we currently only support a single metric specification. That\n is, you can specify a target value and a single metric pair, or a target value and one\n scaling metric and one load metric.

", + "smithy.api#required": {} + } + }, + "Mode": { + "target": "com.amazonaws.autoscaling#PredictiveScalingMode", + "traits": { + "smithy.api#documentation": "

The predictive scaling mode. Defaults to ForecastOnly if not\n specified.

" + } + }, + "SchedulingBufferTime": { + "target": "com.amazonaws.autoscaling#PredictiveScalingSchedulingBufferTime", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, by which the instance launch time can be advanced. For\n example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch\n instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The\n intention is to give resources time to be provisioned. It can take a few minutes to\n launch an EC2 instance. The actual amount of time required depends on several factors,\n such as the size of the instance and whether there are startup scripts to complete.

\n

The value must be less than the forecast interval duration of 3600 seconds (60\n minutes). Defaults to 300 seconds if not specified.

" + } + }, + "MaxCapacityBreachBehavior": { + "target": "com.amazonaws.autoscaling#PredictiveScalingMaxCapacityBreachBehavior", + "traits": { + "smithy.api#documentation": "

Defines the behavior that should be applied if the forecast capacity approaches or\n exceeds the maximum capacity of the Auto Scaling group. Defaults to\n HonorMaxCapacity if not specified.

\n

The following are possible values:

\n \n \n

Use caution when allowing the maximum capacity to be automatically increased. This\n can lead to more instances being launched than intended if the increased maximum\n capacity is not monitored and managed. The increased maximum capacity then becomes\n the new normal maximum capacity for the Auto Scaling group until you manually update\n it. The maximum capacity does not automatically decrease back to the original\n maximum.

\n " + } + }, + "MaxCapacityBuffer": { + "target": "com.amazonaws.autoscaling#PredictiveScalingMaxCapacityBuffer", + "traits": { + "smithy.api#documentation": "

The size of the capacity buffer to use when the forecast capacity is close to or\n exceeds the maximum capacity. The value is specified as a percentage relative to the\n forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer,\n such that if the forecast capacity is 50, and the maximum capacity is 40, then the\n effective maximum capacity is 55.

\n

If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but\n not exceed forecast capacity.

\n

Required if the MaxCapacityBreachBehavior property is set to\n IncreaseMaxCapacity, and cannot be used otherwise.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a predictive scaling policy configuration to use with Amazon EC2 Auto Scaling.

" + } + }, + "com.amazonaws.autoscaling#PredictiveScalingCustomizedCapacityMetric": { + "type": "structure", + "members": { + "MetricDataQueries": { + "target": "com.amazonaws.autoscaling#MetricDataQueries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

One or more metric data queries to provide the data points for a capacity metric. Use\n multiple metric data queries only if you are performing a math expression on returned\n data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a customized capacity metric for a predictive scaling policy.

" + } + }, + "com.amazonaws.autoscaling#PredictiveScalingCustomizedLoadMetric": { + "type": "structure", + "members": { + "MetricDataQueries": { + "target": "com.amazonaws.autoscaling#MetricDataQueries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

One or more metric data queries to provide the data points for a load metric. Use\n multiple metric data queries only if you are performing a math expression on returned\n data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a custom load metric for a predictive scaling policy.

" + } + }, + "com.amazonaws.autoscaling#PredictiveScalingCustomizedScalingMetric": { + "type": "structure", + "members": { + "MetricDataQueries": { + "target": "com.amazonaws.autoscaling#MetricDataQueries", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

One or more metric data queries to provide the data points for a scaling metric. Use\n multiple metric data queries only if you are performing a math expression on returned\n data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a custom scaling metric for a predictive scaling policy.

" + } + }, + "com.amazonaws.autoscaling#PredictiveScalingForecastTimestamps": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#TimestampType" + } + }, + "com.amazonaws.autoscaling#PredictiveScalingForecastValues": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#MetricScale" + } + }, + "com.amazonaws.autoscaling#PredictiveScalingMaxCapacityBreachBehavior": { + "type": "enum", + "members": { + "HonorMaxCapacity": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HonorMaxCapacity" + } + }, + "IncreaseMaxCapacity": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IncreaseMaxCapacity" + } + } + } + }, + "com.amazonaws.autoscaling#PredictiveScalingMaxCapacityBuffer": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.autoscaling#PredictiveScalingMetricSpecification": { + "type": "structure", + "members": { + "TargetValue": { + "target": "com.amazonaws.autoscaling#MetricScale", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the target utilization.

\n \n

Some metrics are based on a count instead of a percentage, such as the request\n count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy\n specifies one of these metrics, specify the target utilization as the optimal\n average request or message count per instance during any one-minute interval.\n

\n ", + "smithy.api#required": {} + } + }, + "PredefinedMetricPairSpecification": { + "target": "com.amazonaws.autoscaling#PredictiveScalingPredefinedMetricPair", + "traits": { + "smithy.api#documentation": "

The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the\n appropriate scaling metric and load metric to use.

" + } + }, + "PredefinedScalingMetricSpecification": { + "target": "com.amazonaws.autoscaling#PredictiveScalingPredefinedScalingMetric", + "traits": { + "smithy.api#documentation": "

The predefined scaling metric specification.

" + } + }, + "PredefinedLoadMetricSpecification": { + "target": "com.amazonaws.autoscaling#PredictiveScalingPredefinedLoadMetric", + "traits": { + "smithy.api#documentation": "

The predefined load metric specification.

" + } + }, + "CustomizedScalingMetricSpecification": { + "target": "com.amazonaws.autoscaling#PredictiveScalingCustomizedScalingMetric", + "traits": { + "smithy.api#documentation": "

The customized scaling metric specification.

" + } + }, + "CustomizedLoadMetricSpecification": { + "target": "com.amazonaws.autoscaling#PredictiveScalingCustomizedLoadMetric", + "traits": { + "smithy.api#documentation": "

The customized load metric specification.

" + } + }, + "CustomizedCapacityMetricSpecification": { + "target": "com.amazonaws.autoscaling#PredictiveScalingCustomizedCapacityMetric", + "traits": { + "smithy.api#documentation": "

The customized capacity metric specification.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This structure specifies the metrics and target utilization settings for a predictive\n scaling policy.

\n

You must specify either a metric pair, or a load metric and a scaling metric\n individually. Specifying a metric pair instead of individual metrics provides a simpler\n way to configure metrics for a scaling policy. You choose the metric pair, and the\n policy automatically knows the correct sum and average statistics to use for the load\n metric and the scaling metric.

\n

Example

\n \n

For information about using custom metrics with predictive scaling, see Advanced predictive scaling policy configurations using custom metrics in\n the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "com.amazonaws.autoscaling#PredictiveScalingMetricSpecifications": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#PredictiveScalingMetricSpecification" + } + }, + "com.amazonaws.autoscaling#PredictiveScalingMode": { + "type": "enum", + "members": { + "ForecastAndScale": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ForecastAndScale" + } + }, + "ForecastOnly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ForecastOnly" + } + } + } + }, + "com.amazonaws.autoscaling#PredictiveScalingPredefinedLoadMetric": { + "type": "structure", + "members": { + "PredefinedMetricType": { + "target": "com.amazonaws.autoscaling#PredefinedLoadMetricType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The metric type.

", + "smithy.api#required": {} + } + }, + "ResourceLabel": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", + "traits": { + "smithy.api#documentation": "

A label that uniquely identifies a specific Application Load Balancer target group from which to determine\n the request count served by your Auto Scaling group. You can't specify a resource label unless\n the target group is attached to the Auto Scaling group.

\n

You create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:

\n

\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

\n

Where:

\n \n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a load metric for a predictive scaling policy.

\n

When returned in the output of DescribePolicies, it indicates that a\n predictive scaling policy uses individually specified load and scaling metrics instead\n of a metric pair.

" + } + }, + "com.amazonaws.autoscaling#PredictiveScalingPredefinedMetricPair": { + "type": "structure", + "members": { + "PredefinedMetricType": { + "target": "com.amazonaws.autoscaling#PredefinedMetricPairType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates which metrics to use. There are two different types of metrics for each\n metric type: one is a load metric and one is a scaling metric. For example, if the\n metric type is ASGCPUUtilization, the Auto Scaling group's total CPU metric is used\n as the load metric, and the average CPU metric is used for the scaling metric.

", + "smithy.api#required": {} + } + }, + "ResourceLabel": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", + "traits": { + "smithy.api#documentation": "

A label that uniquely identifies a specific Application Load Balancer target group from which to determine\n the total and average request count served by your Auto Scaling group. You can't specify a\n resource label unless the target group is attached to the Auto Scaling group.

\n

You create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:

\n

\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

\n

Where:

\n \n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a metric pair for a predictive scaling policy.

" + } + }, + "com.amazonaws.autoscaling#PredictiveScalingPredefinedScalingMetric": { + "type": "structure", + "members": { + "PredefinedMetricType": { + "target": "com.amazonaws.autoscaling#PredefinedScalingMetricType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The metric type.

", + "smithy.api#required": {} + } + }, + "ResourceLabel": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", + "traits": { + "smithy.api#documentation": "

A label that uniquely identifies a specific Application Load Balancer target group from which to determine\n the average request count served by your Auto Scaling group. You can't specify a resource label\n unless the target group is attached to the Auto Scaling group.

\n

You create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:

\n

\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

\n

Where:

\n \n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a scaling metric for a predictive scaling policy.

\n

When returned in the output of DescribePolicies, it indicates that a\n predictive scaling policy uses individually specified load and scaling metrics instead\n of a metric pair.

" + } + }, + "com.amazonaws.autoscaling#PredictiveScalingSchedulingBufferTime": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.autoscaling#ProcessNames": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" + } + }, + "com.amazonaws.autoscaling#ProcessType": { + "type": "structure", + "members": { + "ProcessName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

One of the following processes:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a process type.

\n

For more information, see Types\n of processes in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "com.amazonaws.autoscaling#Processes": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#ProcessType" + } + }, + "com.amazonaws.autoscaling#ProcessesType": { + "type": "structure", + "members": { + "Processes": { + "target": "com.amazonaws.autoscaling#Processes", + "traits": { + "smithy.api#documentation": "

The names of the process types.

" + } + } + } + }, + "com.amazonaws.autoscaling#Progress": { + "type": "integer" + }, + "com.amazonaws.autoscaling#PropagateAtLaunch": { + "type": "boolean" + }, + "com.amazonaws.autoscaling#ProtectedFromScaleIn": { + "type": "boolean" + }, + "com.amazonaws.autoscaling#PutLifecycleHook": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#PutLifecycleHookType" + }, + "output": { + "target": "com.amazonaws.autoscaling#PutLifecycleHookAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#LimitExceededFault" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a lifecycle hook for the specified Auto Scaling group.

\n

Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance\n lifecycle, and then perform a custom action on instances when the corresponding\n lifecycle event occurs.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.

    \n
    2. \n
  2. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.

    \n
    3. \n
  3. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    4. \n
  4. \n

    \n Create the lifecycle hook. Specify whether the hook is\n used when the instances launch or terminate.\n

    \n
    5. \n
  5. \n

    If you need more time, record the lifecycle action heartbeat to keep the\n instance in a wait state using the RecordLifecycleActionHeartbeat API call.

    \n
    6. \n
  6. \n

    If you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.

    \n
    7. \n
\n

For more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.

\n

If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling\n group, the call fails.

\n

You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle\n hook, you can delete it by calling the DeleteLifecycleHook API.

", + "smithy.api#examples": [ + { + "title": "To create a launch lifecycle hook", + "documentation": "This example creates a lifecycle hook for instance launch.", + "input": { + "LifecycleHookName": "my-launch-lifecycle-hook", + "HeartbeatTimeout": 300, + "AutoScalingGroupName": "my-auto-scaling-group", + "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING", + "DefaultResult": "CONTINUE" + } + } + ] + } + }, + "com.amazonaws.autoscaling#PutLifecycleHookAnswer": { + "type": "structure", + "members": {} + }, + "com.amazonaws.autoscaling#PutLifecycleHookType": { + "type": "structure", + "members": { + "LifecycleHookName": { + "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the lifecycle hook.

", + "smithy.api#required": {} + } + }, + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "LifecycleTransition": { + "target": "com.amazonaws.autoscaling#LifecycleTransition", + "traits": { + "smithy.api#documentation": "

The lifecycle transition. For Auto Scaling groups, there are two major lifecycle\n transitions.

\n \n

Required for new lifecycle hooks, but optional when updating existing hooks.

" + } + }, + "RoleARN": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target.

\n

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required\n for new lifecycle hooks, but optional when updating existing hooks.

" + } + }, + "NotificationTargetARN": { + "target": "com.amazonaws.autoscaling#NotificationTargetResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify\n you when an instance is in a wait state for the lifecycle hook. You can specify either\n an Amazon SNS topic or an Amazon SQS queue.

\n

If you specify an empty string, this overrides the current ARN.

\n

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and\n an email key-value pair format when sending notifications to an Amazon SNS topic.

\n

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test\n messages contain the following additional key-value pair: \"Event\":\n \"autoscaling:TEST_NOTIFICATION\".

" + } + }, + "NotificationMetadata": { + "target": "com.amazonaws.autoscaling#AnyPrintableAsciiStringMaxLen4000", + "traits": { + "smithy.api#documentation": "

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to\n the notification target.

" + } + }, + "HeartbeatTimeout": { + "target": "com.amazonaws.autoscaling#HeartbeatTimeout", + "traits": { + "smithy.api#documentation": "

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The\n range is from 30 to 7200 seconds. The default value is\n 3600 seconds (1 hour).

" + } + }, + "DefaultResult": { + "target": "com.amazonaws.autoscaling#LifecycleActionResult", + "traits": { + "smithy.api#documentation": "

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an\n unexpected failure occurs. The default value is ABANDON.

\n

Valid values: CONTINUE | ABANDON\n

" + } + } + } + }, + "com.amazonaws.autoscaling#PutNotificationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#PutNotificationConfigurationType" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#LimitExceededFault" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + }, + { + "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" + } + ], + "traits": { + "smithy.api#documentation": "

Configures an Auto Scaling group to send notifications when specified events take place.\n Subscribers to the specified topic can have messages delivered to an endpoint such as a\n web server or an email address.

\n

This configuration overwrites any existing configuration.

\n

For more information, see Amazon SNS\n notification options for Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.

\n

If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call\n fails.

", + "smithy.api#examples": [ + { + "title": "To add an Auto Scaling notification", + "documentation": "This example adds the specified notification to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic", + "NotificationTypes": [ + "autoscaling:TEST_NOTIFICATION" + ] + } + } + ] + } + }, + "com.amazonaws.autoscaling#PutNotificationConfigurationType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "TopicARN": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SNS topic.

", + "smithy.api#required": {} + } + }, + "NotificationTypes": { + "target": "com.amazonaws.autoscaling#AutoScalingNotificationTypes", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The type of event that causes the notification to be sent. To query the notification\n types supported by Amazon EC2 Auto Scaling, call the DescribeAutoScalingNotificationTypes API.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#PutScalingPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#PutScalingPolicyType" + }, + "output": { + "target": "com.amazonaws.autoscaling#PolicyARNType" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#LimitExceededFault" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + }, + { + "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to\n scale an Auto Scaling group based on configurable metrics. If no policies are defined, the\n dynamic scaling and predictive scaling features are not used.

\n

For more information about using dynamic scaling, see Target tracking\n scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.

\n

For more information about using predictive scaling, see Predictive\n scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy,\n you can delete it by calling the DeletePolicy API.

", + "smithy.api#examples": [ + { + "title": "To add a scaling policy to an Auto Scaling group", + "documentation": "This example adds the specified policy to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyName": "alb1000-target-tracking-scaling-policy", + "PolicyType": "TargetTrackingScaling", + "TargetTrackingConfiguration": { + "TargetValue": 1000.0, + "PredefinedMetricSpecification": { + "PredefinedMetricType": "ALBRequestCountPerTarget", + "ResourceLabel": "app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff" + } + } + }, + "output": { + "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:228f02c2-c665-4bfd-aaac-8b04080bea3c:autoScalingGroupName/my-auto-scaling-group:policyName/alb1000-target-tracking-scaling-policy", + "Alarms": [ + { + "AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e", + "AlarmName": "TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e" + }, + { + "AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2", + "AlarmName": "TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2" + } + ] + } + } + ] + } + }, + "com.amazonaws.autoscaling#PutScalingPolicyType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "PolicyName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the policy.

", + "smithy.api#required": {} + } + }, + "PolicyType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", + "traits": { + "smithy.api#documentation": "

One of the following policy types:

\n " + } + }, + "AdjustmentType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

Specifies how the scaling adjustment is interpreted (for example, an absolute number\n or a percentage). The valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.

\n

Required if the policy type is StepScaling or SimpleScaling.\n For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "MinAdjustmentStep": { + "target": "com.amazonaws.autoscaling#MinAdjustmentStep", + "traits": { + "smithy.api#documentation": "

Available for backward compatibility. Use MinAdjustmentMagnitude\n instead.

" + } + }, + "MinAdjustmentMagnitude": { + "target": "com.amazonaws.autoscaling#MinAdjustmentMagnitude", + "traits": { + "smithy.api#documentation": "

The minimum value to scale by when the adjustment type is\n PercentChangeInCapacity. For example, suppose that you create a step\n scaling policy to scale out an Auto Scaling group by 25 percent and you specify a\n MinAdjustmentMagnitude of 2. If the group has 4 instances and the\n scaling policy is performed, 25 percent of 4 is 1. However, because you specified a\n MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2\n instances.

\n

Valid only if the policy type is StepScaling or\n SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User\n Guide.

\n \n

Some Auto Scaling groups use instance weights. In this case, set the\n MinAdjustmentMagnitude to a value that is at least as large as your\n largest instance weight.

\n " + } + }, + "ScalingAdjustment": { + "target": "com.amazonaws.autoscaling#PolicyIncrement", + "traits": { + "smithy.api#documentation": "

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current capacity.\n For exact capacity, you must specify a non-negative value.

\n

Required if the policy type is SimpleScaling. (Not used with any other\n policy type.)

" + } + }, + "Cooldown": { + "target": "com.amazonaws.autoscaling#Cooldown", + "traits": { + "smithy.api#documentation": "

A cooldown period, in seconds, that applies to a specific simple scaling policy. When\n a cooldown period is specified here, it overrides the default cooldown.

\n

Valid only if the policy type is SimpleScaling. For more information, see\n Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

Default: None

" + } + }, + "MetricAggregationType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", + "traits": { + "smithy.api#documentation": "

The aggregation type for the CloudWatch metrics. The valid values are Minimum,\n Maximum, and Average. If the aggregation type is null, the\n value is treated as Average.

\n

Valid only if the policy type is StepScaling.

" + } + }, + "StepAdjustments": { + "target": "com.amazonaws.autoscaling#StepAdjustments", + "traits": { + "smithy.api#documentation": "

A set of adjustments that enable you to scale based on the size of the alarm\n breach.

\n

Required if the policy type is StepScaling. (Not used with any other\n policy type.)

" + } + }, + "EstimatedInstanceWarmup": { + "target": "com.amazonaws.autoscaling#EstimatedInstanceWarmup", + "traits": { + "smithy.api#documentation": "

\n Not needed if the default instance warmup is defined for the\n group.\n

\n

The estimated time, in seconds, until a newly launched instance can contribute to the\n CloudWatch metrics. This warm-up period applies to instances launched due to a specific target\n tracking or step scaling policy. When a warm-up period is specified here, it overrides\n the default instance warmup.

\n

Valid only if the policy type is TargetTrackingScaling or\n StepScaling.

\n \n

The default is to use the value for the default instance warmup defined for the\n group. If default instance warmup is null, then EstimatedInstanceWarmup\n falls back to the value of default cooldown.

\n " + } + }, + "TargetTrackingConfiguration": { + "target": "com.amazonaws.autoscaling#TargetTrackingConfiguration", + "traits": { + "smithy.api#documentation": "

A target tracking scaling policy. Provides support for predefined or custom\n metrics.

\n

The following predefined metrics are available:

\n \n

If you specify ALBRequestCountPerTarget for the metric, you must specify\n the ResourceLabel property with the\n PredefinedMetricSpecification.

\n

For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API\n Reference.

\n

Required if the policy type is TargetTrackingScaling.

" + } + }, + "Enabled": { + "target": "com.amazonaws.autoscaling#ScalingPolicyEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether the scaling policy is enabled or disabled. The default is enabled.\n For more information, see Disable a\n scaling policy for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

" + } + }, + "PredictiveScalingConfiguration": { + "target": "com.amazonaws.autoscaling#PredictiveScalingConfiguration", + "traits": { + "smithy.api#documentation": "

A predictive scaling policy. Provides support for predefined and custom\n metrics.

\n

Predefined metrics include CPU utilization, network in/out, and the Application Load\n Balancer request count.

\n

For more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API\n Reference.

\n

Required if the policy type is PredictiveScaling.

" + } + } + } + }, + "com.amazonaws.autoscaling#PutScheduledUpdateGroupAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#PutScheduledUpdateGroupActionType" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#AlreadyExistsFault" + }, + { + "target": "com.amazonaws.autoscaling#LimitExceededFault" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a scheduled scaling action for an Auto Scaling group.

\n

For more information, see Scheduled scaling in the\n Amazon EC2 Auto Scaling User Guide.

\n

You can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a\n scheduled action, you can delete it by calling the DeleteScheduledAction API.

\n

If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error\n message.

", + "smithy.api#examples": [ + { + "title": "To add a scheduled action to an Auto Scaling group", + "documentation": "This example adds the specified scheduled action to the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "ScheduledActionName": "my-scheduled-action", + "StartTime": "2014-05-12T08:00:00Z", + "EndTime": "2014-05-12T08:00:00Z", + "MinSize": 2, + "MaxSize": 6, + "DesiredCapacity": 4 + } + } + ] + } + }, + "com.amazonaws.autoscaling#PutScheduledUpdateGroupActionType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "ScheduledActionName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of this scaling action.

", + "smithy.api#required": {} + } + }, + "Time": { + "target": "com.amazonaws.autoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

This property is no longer used.

" + } + }, + "StartTime": { + "target": "com.amazonaws.autoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT\n only and in quotes (for example, \"2021-06-01T00:00:00Z\").

\n

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs\n the action at this time, and then performs the action based on the specified\n recurrence.

" + } + }, + "EndTime": { + "target": "com.amazonaws.autoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

The date and time for the recurring schedule to end, in UTC. For example,\n \"2021-06-01T00:00:00Z\".

" + } + }, + "Recurrence": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The recurring schedule for this action. This format consists of five fields separated\n by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value\n must be in quotes (for example, \"30 0 1 1,6,12 *\"). For more information\n about this format, see Crontab.

\n

When StartTime and EndTime are specified with\n Recurrence, they form the boundaries of when the recurring action\n starts and stops.

\n

Cron expressions use Universal Coordinated Time (UTC) by default.

" + } + }, + "MinSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", + "traits": { + "smithy.api#documentation": "

The minimum size of the Auto Scaling group.

" + } + }, + "MaxSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", + "traits": { + "smithy.api#documentation": "

The maximum size of the Auto Scaling group.

" + } + }, + "DesiredCapacity": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", + "traits": { + "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group after the scheduled\n action runs and the capacity it attempts to maintain. It can scale beyond this capacity\n if you add more scaling conditions.

\n \n

You must specify at least one of the following properties: MaxSize,\n MinSize, or DesiredCapacity.

\n " + } + }, + "TimeZone": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

Specifies the time zone for a cron expression. If a time zone is not provided, UTC is\n used by default.

\n

Valid values are the canonical names of the IANA time zones, derived from the IANA\n Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti). For\n more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

" + } + } + } + }, + "com.amazonaws.autoscaling#PutWarmPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#PutWarmPoolType" + }, + "output": { + "target": "com.amazonaws.autoscaling#PutWarmPoolAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#LimitExceededFault" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of\n pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your\n application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new\n desired capacity.

\n

This operation must be called from the Region in which the Auto Scaling group was\n created.

\n

You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the\n DeleteWarmPool API.

\n

For more information, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To create a warm pool for an Auto Scaling group", + "documentation": "This example creates a warm pool for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "MinSize": 30, + "PoolState": "Hibernated", + "InstanceReusePolicy": { + "ReuseOnScaleIn": true + } + } + } + ] + } + }, + "com.amazonaws.autoscaling#PutWarmPoolAnswer": { + "type": "structure", + "members": {} + }, + "com.amazonaws.autoscaling#PutWarmPoolType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "MaxGroupPreparedCapacity": { + "target": "com.amazonaws.autoscaling#MaxGroupPreparedCapacity", + "traits": { + "smithy.api#documentation": "

Specifies the maximum number of instances that are allowed to be in the warm pool or\n in any state except Terminated for the Auto Scaling group. This is an optional\n property. Specify it only if you do not want the warm pool size to be determined by the\n difference between the group's maximum capacity and its desired capacity.

\n \n

If a value for MaxGroupPreparedCapacity is not specified, Amazon EC2 Auto Scaling\n launches and maintains the difference between the group's maximum capacity and its\n desired capacity. If you specify a value for MaxGroupPreparedCapacity,\n Amazon EC2 Auto Scaling uses the difference between the MaxGroupPreparedCapacity and\n the desired capacity instead.

\n

The size of the warm pool is dynamic. Only when\n MaxGroupPreparedCapacity and MinSize are set to the\n same value does the warm pool have an absolute size.

\n \n

If the desired capacity of the Auto Scaling group is higher than the\n MaxGroupPreparedCapacity, the capacity of the warm pool is 0, unless\n you specify a value for MinSize. To remove a value that you previously set,\n include the property but specify -1 for the value.

" + } + }, + "MinSize": { + "target": "com.amazonaws.autoscaling#WarmPoolMinSize", + "traits": { + "smithy.api#documentation": "

Specifies the minimum number of instances to maintain in the warm pool. This helps you\n to ensure that there is always a certain number of warmed instances available to handle\n traffic spikes. Defaults to 0 if not specified.

" + } + }, + "PoolState": { + "target": "com.amazonaws.autoscaling#WarmPoolState", + "traits": { + "smithy.api#documentation": "

Sets the instance state to transition to after the lifecycle actions are complete.\n Default is Stopped.

" + } + }, + "InstanceReusePolicy": { + "target": "com.amazonaws.autoscaling#InstanceReusePolicy", + "traits": { + "smithy.api#documentation": "

Indicates whether instances in the Auto Scaling group can be returned to the warm pool on\n scale in. The default is to terminate instances in the Auto Scaling group when the group scales\n in.

" + } + } + } + }, + "com.amazonaws.autoscaling#RecordLifecycleActionHeartbeat": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#RecordLifecycleActionHeartbeatType" + }, + "output": { + "target": "com.amazonaws.autoscaling#RecordLifecycleActionHeartbeatAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Records a heartbeat for the lifecycle action associated with the specified token or\n instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.

    \n
    2. \n
  2. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.

    \n
    3. \n
  3. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    4. \n
  4. \n

    Create the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.

    \n
    5. \n
  5. \n

    \n If you need more time, record the lifecycle action\n heartbeat to keep the instance in a wait state.\n

    \n
    6. \n
  6. \n

    If you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.

    \n
    7. \n
\n

For more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To record a lifecycle action heartbeat", + "documentation": "This example records a lifecycle action heartbeat to keep the instance in a pending state.", + "input": { + "LifecycleHookName": "my-lifecycle-hook", + "AutoScalingGroupName": "my-auto-scaling-group", + "LifecycleActionToken": "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635" + } + } + ] + } + }, + "com.amazonaws.autoscaling#RecordLifecycleActionHeartbeatAnswer": { + "type": "structure", + "members": {} + }, + "com.amazonaws.autoscaling#RecordLifecycleActionHeartbeatType": { + "type": "structure", + "members": { + "LifecycleHookName": { + "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the lifecycle hook.

", + "smithy.api#required": {} + } + }, + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "LifecycleActionToken": { + "target": "com.amazonaws.autoscaling#LifecycleActionToken", + "traits": { + "smithy.api#documentation": "

A token that uniquely identifies a specific lifecycle action associated with an\n instance. Amazon EC2 Auto Scaling sends this token to the notification target that you specified when\n you created the lifecycle hook.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", + "traits": { + "smithy.api#documentation": "

The ID of the instance.

" + } + } + } + }, + "com.amazonaws.autoscaling#RefreshInstanceWarmup": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.autoscaling#RefreshPreferences": { + "type": "structure", + "members": { + "MinHealthyPercentage": { + "target": "com.amazonaws.autoscaling#IntPercent", + "traits": { + "smithy.api#documentation": "

Specifies the minimum percentage of the group to keep in service, healthy, and ready\n to use to support your workload to allow the operation to continue. The value is\n expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 0 to\n 100.

\n

If you do not specify this property, the default is 90 percent, or the percentage set\n in the instance maintenance policy for the Auto Scaling group, if defined.

" + } + }, + "InstanceWarmup": { + "target": "com.amazonaws.autoscaling#RefreshInstanceWarmup", + "traits": { + "smithy.api#documentation": "

A time period, in seconds, during which an instance refresh waits before moving on to\n replacing the next instance after a new instance enters the InService\n state.

\n

This property is not required for normal usage. Instead, use the\n DefaultInstanceWarmup property of the Auto Scaling group. The\n InstanceWarmup and DefaultInstanceWarmup properties work\n the same way. Only specify this property if you must override the\n DefaultInstanceWarmup property.

\n

If you do not specify this property, the instance warmup by default is the value of\n the DefaultInstanceWarmup property, if defined (which is recommended in all\n cases), or the HealthCheckGracePeriod property otherwise.

" + } + }, + "CheckpointPercentages": { + "target": "com.amazonaws.autoscaling#CheckpointPercentages", + "traits": { + "smithy.api#documentation": "

(Optional) Threshold values for each checkpoint in ascending order. Each number must\n be unique. To replace all instances in the Auto Scaling group, the last number in the array must\n be 100.

\n

For usage examples, see Add checkpoints to an instance refresh in the\n Amazon EC2 Auto Scaling User Guide.

" + } + }, + "CheckpointDelay": { + "target": "com.amazonaws.autoscaling#CheckpointDelay", + "traits": { + "smithy.api#documentation": "

(Optional) The amount of time, in seconds, to wait after a checkpoint before\n continuing. This property is optional, but if you specify a value for it, you must also\n specify a value for CheckpointPercentages. If you specify a value for\n CheckpointPercentages and not for CheckpointDelay, the\n CheckpointDelay defaults to 3600 (1 hour).

" + } + }, + "SkipMatching": { + "target": "com.amazonaws.autoscaling#SkipMatching", + "traits": { + "smithy.api#documentation": "

(Optional) Indicates whether skip matching is enabled. If enabled (true),\n then Amazon EC2 Auto Scaling skips replacing instances that match the desired configuration. If no\n desired configuration is specified, then it skips replacing instances that have the same\n launch template and instance types that the Auto Scaling group was using before the start of the\n instance refresh. The default is false.

\n

For more information, see Use an\n instance refresh with skip matching in the\n Amazon EC2 Auto Scaling User Guide.

" + } + }, + "AutoRollback": { + "target": "com.amazonaws.autoscaling#AutoRollback", + "traits": { + "smithy.api#documentation": "

(Optional) Indicates whether to roll back the Auto Scaling group to its previous configuration\n if the instance refresh fails or a CloudWatch alarm threshold is met. The default is\n false.

\n

A rollback is not supported in the following situations:

\n \n

For more information, see Undo changes with a\n rollback in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "ScaleInProtectedInstances": { + "target": "com.amazonaws.autoscaling#ScaleInProtectedInstances", + "traits": { + "smithy.api#documentation": "

Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances protected from scale in\n are found.

\n

The following lists the valid values:

\n
\n
Refresh
\n
\n

Amazon EC2 Auto Scaling replaces instances that are protected from scale in.

\n
\n
Ignore
\n
\n

Amazon EC2 Auto Scaling ignores instances that are protected from scale in and continues\n to replace instances that are not protected.

\n
\n
Wait (default)
\n
\n

Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. Otherwise,\n the instance refresh will fail.

\n
\n
" + } + }, + "StandbyInstances": { + "target": "com.amazonaws.autoscaling#StandbyInstances", + "traits": { + "smithy.api#documentation": "

Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances in Standby\n state are found.

\n

The following lists the valid values:

\n
\n
Terminate
\n
\n

Amazon EC2 Auto Scaling terminates instances that are in Standby.

\n
\n
Ignore
\n
\n

Amazon EC2 Auto Scaling ignores instances that are in Standby and continues\n to replace instances that are in the InService state.

\n
\n
Wait (default)
\n
\n

Amazon EC2 Auto Scaling waits one hour for you to return the instances to service.\n Otherwise, the instance refresh will fail.

\n
\n
" + } + }, + "AlarmSpecification": { + "target": "com.amazonaws.autoscaling#AlarmSpecification", + "traits": { + "smithy.api#documentation": "

(Optional) The CloudWatch alarm specification. CloudWatch alarms can be used to identify any\n issues and fail the operation if an alarm threshold is met.

" + } + }, + "MaxHealthyPercentage": { + "target": "com.amazonaws.autoscaling#IntPercent100To200", + "traits": { + "smithy.api#documentation": "

Specifies the maximum percentage of the group that can be in service and healthy, or\n pending, to support your workload when replacing instances. The value is expressed as a\n percentage of the desired capacity of the Auto Scaling group. Value range is 100 to 200.

\n

If you specify MaxHealthyPercentage, you must also specify\n MinHealthyPercentage, and the difference between them cannot be greater\n than 100. A larger range increases the number of instances that can be replaced at the\n same time.

\n

If you do not specify this property, the default is 100 percent, or the percentage set\n in the instance maintenance policy for the Auto Scaling group, if defined.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the preferences for an instance refresh.

" + } + }, + "com.amazonaws.autoscaling#RefreshStrategy": { + "type": "enum", + "members": { + "Rolling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Rolling" + } + } + } + }, + "com.amazonaws.autoscaling#ResourceContentionFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceContention", + "httpResponseCode": 500 + }, + "smithy.api#documentation": "

You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group,\n instance, or load balancer).

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.autoscaling#ResourceInUseFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceInUse", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The operation can't be performed because the resource is in use.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.autoscaling#ResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.autoscaling#ResumeProcesses": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#ScalingProcessQuery" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + }, + { + "target": "com.amazonaws.autoscaling#ResourceInUseFault" + } + ], + "traits": { + "smithy.api#documentation": "

Resumes the specified suspended auto scaling processes, or all suspended process, for\n the specified Auto Scaling group.

\n

For more information, see Suspend and resume\n Amazon EC2 Auto Scaling processes in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To resume Auto Scaling processes", + "documentation": "This example resumes the specified suspended scaling process for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "ScalingProcesses": [ + "AlarmNotification" + ] + } + } + ] + } + }, + "com.amazonaws.autoscaling#ReturnData": { + "type": "boolean" + }, + "com.amazonaws.autoscaling#ReuseOnScaleIn": { + "type": "boolean" + }, + "com.amazonaws.autoscaling#RollbackDetails": { + "type": "structure", + "members": { + "RollbackReason": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", + "traits": { + "smithy.api#documentation": "

The reason for this instance refresh rollback (for example, whether a manual or\n automatic rollback was initiated).

" + } + }, + "RollbackStartTime": { + "target": "com.amazonaws.autoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

The date and time at which the rollback began.

" + } + }, + "PercentageCompleteOnRollback": { + "target": "com.amazonaws.autoscaling#IntPercent", + "traits": { + "smithy.api#documentation": "

Indicates the value of PercentageComplete at the time the rollback\n started.

" + } + }, + "InstancesToUpdateOnRollback": { + "target": "com.amazonaws.autoscaling#InstancesToUpdate", + "traits": { + "smithy.api#documentation": "

Indicates the value of InstancesToUpdate at the time the rollback\n started.

" + } + }, + "ProgressDetailsOnRollback": { + "target": "com.amazonaws.autoscaling#InstanceRefreshProgressDetails", + "traits": { + "smithy.api#documentation": "

Reports progress on replacing instances in an Auto Scaling group that has a warm pool. This\n includes separate details for instances in the warm pool and instances in the Auto Scaling group\n (the live pool).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about an instance refresh rollback.

" + } + }, + "com.amazonaws.autoscaling#RollbackInstanceRefresh": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#RollbackInstanceRefreshType" + }, + "output": { + "target": "com.amazonaws.autoscaling#RollbackInstanceRefreshAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ActiveInstanceRefreshNotFoundFault" + }, + { + "target": "com.amazonaws.autoscaling#IrreversibleInstanceRefreshFault" + }, + { + "target": "com.amazonaws.autoscaling#LimitExceededFault" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels an instance refresh that is in progress and rolls back any changes that it\n made. Amazon EC2 Auto Scaling replaces any instances that were replaced during the instance refresh.\n This restores your Auto Scaling group to the configuration that it was using before the start of\n the instance refresh.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group\n after you make configuration changes.

\n

A rollback is not supported in the following situations:

\n \n

When you receive a successful response from this operation, Amazon EC2 Auto Scaling immediately\n begins replacing instances. You can check the status of this operation through the DescribeInstanceRefreshes API operation.

" + } + }, + "com.amazonaws.autoscaling#RollbackInstanceRefreshAnswer": { + "type": "structure", + "members": { + "InstanceRefreshId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The instance refresh ID associated with the request. This is the unique ID assigned to\n the instance refresh when it was started.

" + } + } + } + }, + "com.amazonaws.autoscaling#RollbackInstanceRefreshType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#ScaleInProtectedInstances": { + "type": "enum", + "members": { + "Refresh": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Refresh" + } + }, + "Ignore": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ignore" + } + }, + "Wait": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Wait" + } + } + } + }, + "com.amazonaws.autoscaling#ScalingActivityInProgressFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ScalingActivityInProgress", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The operation can't be performed because there are scaling activities in\n progress.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.autoscaling#ScalingActivityStatusCode": { + "type": "enum", + "members": { + "PendingSpotBidPlacement": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingSpotBidPlacement" + } + }, + "WaitingForSpotInstanceRequestId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WaitingForSpotInstanceRequestId" + } + }, + "WaitingForSpotInstanceId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WaitingForSpotInstanceId" + } + }, + "WaitingForInstanceId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WaitingForInstanceId" + } + }, + "PreInService": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PreInService" + } + }, + "InProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "WaitingForELBConnectionDraining": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WaitingForELBConnectionDraining" + } + }, + "MidLifecycleAction": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MidLifecycleAction" + } + }, + "WaitingForInstanceWarmup": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WaitingForInstanceWarmup" + } + }, + "Successful": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Successful" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "Cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelled" + } + }, + "WaitingForConnectionDraining": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WaitingForConnectionDraining" + } + } + } + }, + "com.amazonaws.autoscaling#ScalingPolicies": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#ScalingPolicy" + } + }, + "com.amazonaws.autoscaling#ScalingPolicy": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the Auto Scaling group.

" + } + }, + "PolicyName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the scaling policy.

" + } + }, + "PolicyARN": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy.

" + } + }, + "PolicyType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", + "traits": { + "smithy.api#documentation": "

One of the following policy types:

\n \n

For more information, see Target tracking\n scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "AdjustmentType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

Specifies how the scaling adjustment is interpreted (for example, an absolute number\n or a percentage). The valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.

" + } + }, + "MinAdjustmentStep": { + "target": "com.amazonaws.autoscaling#MinAdjustmentStep", + "traits": { + "smithy.api#documentation": "

Available for backward compatibility. Use MinAdjustmentMagnitude\n instead.

" + } + }, + "MinAdjustmentMagnitude": { + "target": "com.amazonaws.autoscaling#MinAdjustmentMagnitude", + "traits": { + "smithy.api#documentation": "

The minimum value to scale by when the adjustment type is\n PercentChangeInCapacity.

" + } + }, + "ScalingAdjustment": { + "target": "com.amazonaws.autoscaling#PolicyIncrement", + "traits": { + "smithy.api#documentation": "

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current\n capacity.

" + } + }, + "Cooldown": { + "target": "com.amazonaws.autoscaling#Cooldown", + "traits": { + "smithy.api#documentation": "

The duration of the policy's cooldown period, in seconds.

" + } + }, + "StepAdjustments": { + "target": "com.amazonaws.autoscaling#StepAdjustments", + "traits": { + "smithy.api#documentation": "

A set of adjustments that enable you to scale based on the size of the alarm\n breach.

" + } + }, + "MetricAggregationType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", + "traits": { + "smithy.api#documentation": "

The aggregation type for the CloudWatch metrics. The valid values are Minimum,\n Maximum, and Average.

" + } + }, + "EstimatedInstanceWarmup": { + "target": "com.amazonaws.autoscaling#EstimatedInstanceWarmup", + "traits": { + "smithy.api#documentation": "

The estimated time, in seconds, until a newly launched instance can contribute to the\n CloudWatch metrics.

" + } + }, + "Alarms": { + "target": "com.amazonaws.autoscaling#Alarms", + "traits": { + "smithy.api#documentation": "

The CloudWatch alarms related to the policy.

" + } + }, + "TargetTrackingConfiguration": { + "target": "com.amazonaws.autoscaling#TargetTrackingConfiguration", + "traits": { + "smithy.api#documentation": "

A target tracking scaling policy.

" + } + }, + "Enabled": { + "target": "com.amazonaws.autoscaling#ScalingPolicyEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether the policy is enabled (true) or disabled\n (false).

" + } + }, + "PredictiveScalingConfiguration": { + "target": "com.amazonaws.autoscaling#PredictiveScalingConfiguration", + "traits": { + "smithy.api#documentation": "

A predictive scaling policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a scaling policy.

" + } + }, + "com.amazonaws.autoscaling#ScalingPolicyEnabled": { + "type": "boolean" + }, + "com.amazonaws.autoscaling#ScalingProcessQuery": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "ScalingProcesses": { + "target": "com.amazonaws.autoscaling#ProcessNames", + "traits": { + "smithy.api#documentation": "

One or more of the following processes:

\n \n

If you omit this property, all processes are specified.

" + } + } + } + }, + "com.amazonaws.autoscaling#ScheduledActionNames": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" + } + }, + "com.amazonaws.autoscaling#ScheduledActionsType": { + "type": "structure", + "members": { + "ScheduledUpdateGroupActions": { + "target": "com.amazonaws.autoscaling#ScheduledUpdateGroupActions", + "traits": { + "smithy.api#documentation": "

The scheduled actions.

" + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" + } + } + } + }, + "com.amazonaws.autoscaling#ScheduledUpdateGroupAction": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the Auto Scaling group.

" + } + }, + "ScheduledActionName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the scheduled action.

" + } + }, + "ScheduledActionARN": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the scheduled action.

" + } + }, + "Time": { + "target": "com.amazonaws.autoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

This property is no longer used.

" + } + }, + "StartTime": { + "target": "com.amazonaws.autoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

The date and time in UTC for this action to start. For example,\n \"2019-06-01T00:00:00Z\".

" + } + }, + "EndTime": { + "target": "com.amazonaws.autoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

The date and time in UTC for the recurring schedule to end. For example,\n \"2019-06-01T00:00:00Z\".

" + } + }, + "Recurrence": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The recurring schedule for the action, in Unix cron syntax format.

\n

When StartTime and EndTime are specified with\n Recurrence, they form the boundaries of when the recurring action\n starts and stops.

" + } + }, + "MinSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", + "traits": { + "smithy.api#documentation": "

The minimum size of the Auto Scaling group.

" + } + }, + "MaxSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", + "traits": { + "smithy.api#documentation": "

The maximum size of the Auto Scaling group.

" + } + }, + "DesiredCapacity": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", + "traits": { + "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group after the scheduled\n action runs and the capacity it attempts to maintain.

" + } + }, + "TimeZone": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The time zone for the cron expression.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a scheduled scaling\n action.

" + } + }, + "com.amazonaws.autoscaling#ScheduledUpdateGroupActionRequest": { + "type": "structure", + "members": { + "ScheduledActionName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the scaling action.

", + "smithy.api#required": {} + } + }, + "StartTime": { + "target": "com.amazonaws.autoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT\n only and in quotes (for example, \"2019-06-01T00:00:00Z\").

\n

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs\n the action at this time, and then performs the action based on the specified\n recurrence.

\n

If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error\n message.

" + } + }, + "EndTime": { + "target": "com.amazonaws.autoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

The date and time for the recurring schedule to end, in UTC.

" + } + }, + "Recurrence": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The recurring schedule for the action, in Unix cron syntax format. This format\n consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month]\n [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, \"30 0 1\n 1,6,12 *\"). For more information about this format, see Crontab.

\n

When StartTime and EndTime are specified with\n Recurrence, they form the boundaries of when the recurring action\n starts and stops.

\n

Cron expressions use Universal Coordinated Time (UTC) by default.

" + } + }, + "MinSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", + "traits": { + "smithy.api#documentation": "

The minimum size of the Auto Scaling group.

" + } + }, + "MaxSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", + "traits": { + "smithy.api#documentation": "

The maximum size of the Auto Scaling group.

" + } + }, + "DesiredCapacity": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", + "traits": { + "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group after the scheduled\n action runs and the capacity it attempts to maintain.

" + } + }, + "TimeZone": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

Specifies the time zone for a cron expression. If a time zone is not provided, UTC is\n used by default.

\n

Valid values are the canonical names of the IANA time zones, derived from the IANA\n Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti). For\n more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes information used for one or more scheduled scaling action updates in a BatchPutScheduledUpdateGroupAction operation.

" + } + }, + "com.amazonaws.autoscaling#ScheduledUpdateGroupActionRequests": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#ScheduledUpdateGroupActionRequest" + } + }, + "com.amazonaws.autoscaling#ScheduledUpdateGroupActions": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#ScheduledUpdateGroupAction" + } + }, + "com.amazonaws.autoscaling#SecurityGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#XmlString" + } + }, + "com.amazonaws.autoscaling#ServiceLinkedRoleFailure": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ServiceLinkedRoleFailure", + "httpResponseCode": 500 + }, + "smithy.api#documentation": "

The service-linked role is not yet ready for use.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.autoscaling#SetDesiredCapacity": { + "type": "operation", "input": { - "InstanceIds": ["i-93633f9b"], - "AutoScalingGroupName": "my-auto-scaling-group", - "ShouldDecrementDesiredCapacity": true + "target": "com.amazonaws.autoscaling#SetDesiredCapacityType" }, "output": { - "Activities": [ + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + }, { - "Description": "Moving EC2 instance to Standby: i-93633f9b", - "AutoScalingGroupName": "my-auto-scaling-group", - "ActivityId": "ffa056b4-6ed3-41ba-ae7c-249dfae6eba1", - "Details": "details", - "StartTime": "2015-04-12T15:10:23.640Z", - "Progress": 50, - "Cause": "At 2015-04-12T15:10:23Z instance i-93633f9b was moved to standby in response to a user request, shrinking the capacity from 2 to 1.", - "StatusCode": "InProgress" + "target": "com.amazonaws.autoscaling#ScalingActivityInProgressFault" } - ] + ], + "traits": { + "smithy.api#documentation": "

Sets the size of the specified Auto Scaling group.

\n

If a scale-in activity occurs as a result of a new DesiredCapacity value\n that is lower than the current size of the group, the Auto Scaling group uses its termination\n policy to determine which instances to terminate.

\n

For more information, see Manual\n scaling in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To set the desired capacity for an Auto Scaling group", + "documentation": "This example sets the desired capacity for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "DesiredCapacity": 2, + "HonorCooldown": true + } + } + ] } - } - ] - } - }, - "com.amazonaws.autoscaling#EnterStandbyAnswer": { - "type": "structure", - "members": { - "Activities": { - "target": "com.amazonaws.autoscaling#Activities", - "traits": { - "smithy.api#documentation": "

The activities related to moving instances into Standby mode.

" - } - } - } - }, - "com.amazonaws.autoscaling#EnterStandbyQuery": { - "type": "structure", - "members": { - "InstanceIds": { - "target": "com.amazonaws.autoscaling#InstanceIds", - "traits": { - "smithy.api#documentation": "

The IDs of the instances. You can specify up to 20 instances.

" - } - }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "ShouldDecrementDesiredCapacity": { - "target": "com.amazonaws.autoscaling#ShouldDecrementDesiredCapacity", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of\n instances moved to Standby mode.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#EstimatedInstanceWarmup": { - "type": "integer" - }, - "com.amazonaws.autoscaling#ExcludedInstance": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 30 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\.\\*\\-]+$" - } - }, - "com.amazonaws.autoscaling#ExcludedInstanceTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#ExcludedInstance" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 400 - } - } - }, - "com.amazonaws.autoscaling#ExecutePolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#ExecutePolicyType" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - }, - { - "target": "com.amazonaws.autoscaling#ScalingActivityInProgressFault" - } - ], - "traits": { - "smithy.api#documentation": "

Executes the specified policy. This can be useful for testing the design of your\n scaling policy.

", - "smithy.api#examples": [ - { - "title": "To execute a scaling policy", - "documentation": "This example executes the specified policy.", + }, + "com.amazonaws.autoscaling#SetDesiredCapacityType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "DesiredCapacity": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group after this operation\n completes and the capacity it attempts to maintain.

", + "smithy.api#required": {} + } + }, + "HonorCooldown": { + "target": "com.amazonaws.autoscaling#HonorCooldown", + "traits": { + "smithy.api#documentation": "

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating\n a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does\n not honor the cooldown period during manual scaling activities.

" + } + } + } + }, + "com.amazonaws.autoscaling#SetInstanceHealth": { + "type": "operation", "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "PolicyName": "my-step-scale-out-policy", - "BreachThreshold": 50.0, - "MetricValue": 59.0 + "target": "com.amazonaws.autoscaling#SetInstanceHealthQuery" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the health status of the specified instance.

\n

For more information, see Set up a custom\n health check for your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To set the health status of an instance", + "documentation": "This example sets the health status of the specified instance to Unhealthy.", + "input": { + "InstanceId": "i-93633f9b", + "HealthStatus": "Unhealthy" + } + } + ] } - } - ] - } - }, - "com.amazonaws.autoscaling#ExecutePolicyType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

" - } - }, - "PolicyName": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or ARN of the policy.

", - "smithy.api#required": {} - } - }, - "HonorCooldown": { - "target": "com.amazonaws.autoscaling#HonorCooldown", - "traits": { - "smithy.api#documentation": "

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing\n the policy.

\n

Valid only if the policy type is SimpleScaling. For more information, see\n Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "MetricValue": { - "target": "com.amazonaws.autoscaling#MetricScale", - "traits": { - "smithy.api#documentation": "

The metric value to compare to BreachThreshold. This enables you to\n execute a policy of type StepScaling and determine which step adjustment to\n use. For example, if the breach threshold is 50 and you want to use a step adjustment\n with a lower bound of 0 and an upper bound of 10, you can set the metric value to\n 59.

\n

If you specify a metric value that doesn't correspond to a step adjustment for the\n policy, the call returns an error.

\n

Required if the policy type is StepScaling and not supported\n otherwise.

" - } - }, - "BreachThreshold": { - "target": "com.amazonaws.autoscaling#MetricScale", - "traits": { - "smithy.api#documentation": "

The breach threshold for the alarm.

\n

Required if the policy type is StepScaling and not supported\n otherwise.

" - } - } - } - }, - "com.amazonaws.autoscaling#ExitStandby": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#ExitStandbyQuery" - }, - "output": { - "target": "com.amazonaws.autoscaling#ExitStandbyAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Moves the specified instances out of the standby state.

\n

After you put the instances back in service, the desired capacity is\n incremented.

\n

For more information, see Temporarily removing\n instances from your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To move instances out of standby mode", - "documentation": "This example moves the specified instance out of standby mode.", + }, + "com.amazonaws.autoscaling#SetInstanceHealthQuery": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + }, + "HealthStatus": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The health status of the instance. Set to Healthy to have the instance\n remain in service. Set to Unhealthy to have the instance be out of service.\n Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.

", + "smithy.api#required": {} + } + }, + "ShouldRespectGracePeriod": { + "target": "com.amazonaws.autoscaling#ShouldRespectGracePeriod", + "traits": { + "smithy.api#documentation": "

If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod\n specified for the group, by default, this call respects the grace period. Set this to\n False, to have the call not respect the grace period associated with\n the group.

\n

For more information about the health check grace period, see Set the health check grace period for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

" + } + } + } + }, + "com.amazonaws.autoscaling#SetInstanceProtection": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#SetInstanceProtectionQuery" + }, + "output": { + "target": "com.amazonaws.autoscaling#SetInstanceProtectionAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#LimitExceededFault" + }, + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the instance protection settings of the specified instances. This operation\n cannot be called on instances in a warm pool.

\n

For more information, see Use\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.

\n

If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call\n fails.

", + "smithy.api#examples": [ + { + "title": "To enable instance protection for an instance", + "documentation": "This example enables instance protection for the specified instance.", + "input": { + "InstanceIds": [ + "i-93633f9b" + ], + "AutoScalingGroupName": "my-auto-scaling-group", + "ProtectedFromScaleIn": true + } + }, + { + "title": "To disable instance protection for an instance", + "documentation": "This example disables instance protection for the specified instance.", + "input": { + "InstanceIds": [ + "i-93633f9b" + ], + "AutoScalingGroupName": "my-auto-scaling-group", + "ProtectedFromScaleIn": false + } + } + ] + } + }, + "com.amazonaws.autoscaling#SetInstanceProtectionAnswer": { + "type": "structure", + "members": {} + }, + "com.amazonaws.autoscaling#SetInstanceProtectionQuery": { + "type": "structure", + "members": { + "InstanceIds": { + "target": "com.amazonaws.autoscaling#InstanceIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

One or more instance IDs. You can specify up to 50 instances.

", + "smithy.api#required": {} + } + }, + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "ProtectedFromScaleIn": { + "target": "com.amazonaws.autoscaling#ProtectedFromScaleIn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling\n in.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#ShouldDecrementDesiredCapacity": { + "type": "boolean" + }, + "com.amazonaws.autoscaling#ShouldRespectGracePeriod": { + "type": "boolean" + }, + "com.amazonaws.autoscaling#SkipMatching": { + "type": "boolean" + }, + "com.amazonaws.autoscaling#SpotInstancePools": { + "type": "integer" + }, + "com.amazonaws.autoscaling#SpotPrice": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.autoscaling#StandbyInstances": { + "type": "enum", + "members": { + "Terminate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terminate" + } + }, + "Ignore": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ignore" + } + }, + "Wait": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Wait" + } + } + } + }, + "com.amazonaws.autoscaling#StartInstanceRefresh": { + "type": "operation", "input": { - "InstanceIds": ["i-93633f9b"], - "AutoScalingGroupName": "my-auto-scaling-group" + "target": "com.amazonaws.autoscaling#StartInstanceRefreshType" }, "output": { - "Activities": [ + "target": "com.amazonaws.autoscaling#StartInstanceRefreshAnswer" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#InstanceRefreshInProgressFault" + }, + { + "target": "com.amazonaws.autoscaling#LimitExceededFault" + }, { - "Description": "Moving EC2 instance out of Standby: i-93633f9b", - "AutoScalingGroupName": "my-auto-scaling-group", - "ActivityId": "142928e1-a2dc-453a-9b24-b85ad6735928", - "Details": "details", - "StartTime": "2015-04-12T15:14:29.886Z", - "Progress": 30, - "Cause": "At 2015-04-12T15:14:29Z instance i-93633f9b was moved out of standby in response to a user request, increasing the capacity from 1 to 2.", - "StatusCode": "PreInService" + "target": "com.amazonaws.autoscaling#ResourceContentionFault" } - ] - } - } - ] - } - }, - "com.amazonaws.autoscaling#ExitStandbyAnswer": { - "type": "structure", - "members": { - "Activities": { - "target": "com.amazonaws.autoscaling#Activities", - "traits": { - "smithy.api#documentation": "

The activities related to moving instances out of Standby mode.

" - } - } - } - }, - "com.amazonaws.autoscaling#ExitStandbyQuery": { - "type": "structure", - "members": { - "InstanceIds": { - "target": "com.amazonaws.autoscaling#InstanceIds", - "traits": { - "smithy.api#documentation": "

The IDs of the instances. You can specify up to 20 instances.

" - } - }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#FailedScheduledUpdateGroupActionRequest": { - "type": "structure", - "members": { - "ScheduledActionName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the scheduled action.

", - "smithy.api#required": {} - } - }, - "ErrorCode": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", - "traits": { - "smithy.api#documentation": "

The error code.

" - } - }, - "ErrorMessage": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The error message accompanying the error code.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a scheduled action that could not be created, updated, or deleted.

" - } - }, - "com.amazonaws.autoscaling#FailedScheduledUpdateGroupActionRequests": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#FailedScheduledUpdateGroupActionRequest" - } - }, - "com.amazonaws.autoscaling#Filter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The name of the filter.

\n

The valid values for Name depend on which API operation you're using with\n the filter (DescribeAutoScalingGroups or DescribeTags).

\n

\n DescribeAutoScalingGroups\n

\n

Valid values for Name include the following:

\n \n

\n DescribeTags\n

\n

Valid values for Name include the following:

\n " - } - }, - "Values": { - "target": "com.amazonaws.autoscaling#Values", - "traits": { - "smithy.api#documentation": "

One or more filter values. Filter values are case-sensitive.

\n

If you specify multiple values for a filter, the values are automatically logically\n joined with an OR, and the request returns all results that match any of\n the specified values. For example, specify \"tag:environment\" for the filter name and\n \"production,development\" for the filter values to find Auto Scaling groups with the tag\n \"environment=production\" or \"environment=development\".

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a filter that is used to return a more specific list of results from a\n describe operation.

\n

If you specify multiple filters, the filters are automatically logically joined with\n an AND, and the request returns only the results that match all of the\n specified filters.

\n

For more information, see Tag Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "com.amazonaws.autoscaling#Filters": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#Filter" - } - }, - "com.amazonaws.autoscaling#ForceDelete": { - "type": "boolean" - }, - "com.amazonaws.autoscaling#GetPredictiveScalingForecast": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#GetPredictiveScalingForecastType" - }, - "output": { - "target": "com.amazonaws.autoscaling#GetPredictiveScalingForecastAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves the forecast data for a predictive scaling policy.

\n

Load forecasts are predictions of the hourly load values using historical load data\n from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as\n predicted values for the minimum capacity that is needed on an hourly basis, based on\n the hourly load forecast.

\n

A minimum of 24 hours of data is required to create the initial forecasts. However,\n having a full 14 days of historical data results in more accurate forecasts.

\n

For more information, see Predictive\n scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "com.amazonaws.autoscaling#GetPredictiveScalingForecastAnswer": { - "type": "structure", - "members": { - "LoadForecast": { - "target": "com.amazonaws.autoscaling#LoadForecasts", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The load forecast.

", - "smithy.api#required": {} - } - }, - "CapacityForecast": { - "target": "com.amazonaws.autoscaling#CapacityForecast", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The capacity forecast.

", - "smithy.api#required": {} - } - }, - "UpdateTime": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The time the forecast was made.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#GetPredictiveScalingForecastType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "PolicyName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the policy.

", - "smithy.api#required": {} - } - }, - "StartTime": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The inclusive start time of the time range for the forecast data to get. At most, the\n date and time can be one year before the current date and time.

", - "smithy.api#required": {} - } - }, - "EndTime": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The exclusive end time of the time range for the forecast data to get. The maximum\n time duration between the start and end time is 30 days.

\n

Although this parameter can accept a date and time that is more than two days in the\n future, the availability of forecast data has limits. Amazon EC2 Auto Scaling only issues forecasts for\n periods of two days in advance.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#GlobalTimeout": { - "type": "integer" - }, - "com.amazonaws.autoscaling#HealthCheckGracePeriod": { - "type": "integer" - }, - "com.amazonaws.autoscaling#HeartbeatTimeout": { - "type": "integer" - }, - "com.amazonaws.autoscaling#HonorCooldown": { - "type": "boolean" - }, - "com.amazonaws.autoscaling#IncludeDeletedGroups": { - "type": "boolean" - }, - "com.amazonaws.autoscaling#Instance": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {} - } - }, - "InstanceType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The instance type of the EC2 instance.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Availability Zone in which the instance is running.

", - "smithy.api#required": {} - } - }, - "LifecycleState": { - "target": "com.amazonaws.autoscaling#LifecycleState", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A description of the current lifecycle state. The Quarantined state is\n not used. For more information, see Amazon EC2 Auto Scaling instance\n lifecycle in the Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#required": {} - } - }, - "HealthStatus": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The last reported health status of the instance. Healthy means that the\n instance is healthy and should remain in service. Unhealthy means that the\n instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.

", - "smithy.api#required": {} - } - }, - "LaunchConfigurationName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The launch configuration associated with the instance.

" - } - }, - "LaunchTemplate": { - "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", - "traits": { - "smithy.api#documentation": "

The launch template for the instance.

" - } - }, - "ProtectedFromScaleIn": { - "target": "com.amazonaws.autoscaling#InstanceProtected", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling\n in.

", - "smithy.api#required": {} - } - }, - "WeightedCapacity": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", - "traits": { - "smithy.api#documentation": "

The number of capacity units contributed by the instance based on its instance\n type.

\n

Valid Range: Minimum value of 1. Maximum value of 999.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an EC2 instance.

" - } - }, - "com.amazonaws.autoscaling#InstanceGeneration": { - "type": "enum", - "members": { - "CURRENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "current" - } - }, - "PREVIOUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "previous" - } - } - } - }, - "com.amazonaws.autoscaling#InstanceGenerations": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#InstanceGeneration" - } - }, - "com.amazonaws.autoscaling#InstanceIds": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen19" - } - }, - "com.amazonaws.autoscaling#InstanceMaintenancePolicy": { - "type": "structure", - "members": { - "MinHealthyPercentage": { - "target": "com.amazonaws.autoscaling#IntPercentResettable", - "traits": { - "smithy.api#documentation": "

Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling\n group. It represents the minimum percentage of the group to keep in service, healthy,\n and ready to use to support your workload when replacing instances. Value range is 0 to\n 100. To clear a previously set value, specify a value of -1.

" - } - }, - "MaxHealthyPercentage": { - "target": "com.amazonaws.autoscaling#IntPercent100To200Resettable", - "traits": { - "smithy.api#documentation": "

Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling\n group. It represents the maximum percentage of the group that can be in service and\n healthy, or pending, to support your workload when replacing instances. Value range is\n 100 to 200. To clear a previously set value, specify a value of -1.

\n

Both MinHealthyPercentage and MaxHealthyPercentage must be\n specified, and the difference between them cannot be greater than 100. A large range\n increases the number of instances that can be replaced at the same time.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an instance maintenance policy.

\n

For more information, see Set instance maintenance policy in the\n Amazon EC2 Auto Scaling User Guide.

" - } - }, - "com.amazonaws.autoscaling#InstanceMetadataEndpointState": { - "type": "enum", - "members": { - "Disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "disabled" - } - }, - "Enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "enabled" - } - } - } - }, - "com.amazonaws.autoscaling#InstanceMetadataHttpPutResponseHopLimit": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.autoscaling#InstanceMetadataHttpTokensState": { - "type": "enum", - "members": { - "Optional": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "optional" - } - }, - "Required": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "required" - } - } - } - }, - "com.amazonaws.autoscaling#InstanceMetadataOptions": { - "type": "structure", - "members": { - "HttpTokens": { - "target": "com.amazonaws.autoscaling#InstanceMetadataHttpTokensState", - "traits": { - "smithy.api#documentation": "

The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.

\n

If the state is optional, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role\n credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid signed token, the version 2.0 role\n credentials are returned.

\n

If the state is required, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM role credentials\n always returns the version 2.0 credentials; the version 1.0 credentials are not\n available.

" - } - }, - "HttpPutResponseHopLimit": { - "target": "com.amazonaws.autoscaling#InstanceMetadataHttpPutResponseHopLimit", - "traits": { - "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.

\n

Default: 1

" - } - }, - "HttpEndpoint": { - "target": "com.amazonaws.autoscaling#InstanceMetadataEndpointState", - "traits": { - "smithy.api#documentation": "

This parameter enables or disables the HTTP metadata endpoint on your instances. If\n the parameter is not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access\n your instance metadata.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The metadata options for the instances. For more information, see Configure the instance metadata options in the\n Amazon EC2 Auto Scaling User Guide.

" - } - }, - "com.amazonaws.autoscaling#InstanceMonitoring": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.autoscaling#MonitoringEnabled", - "traits": { - "smithy.api#documentation": "

If true, detailed monitoring is enabled. Otherwise, basic monitoring is\n enabled.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes whether detailed monitoring is enabled for the Auto Scaling instances.

" - } - }, - "com.amazonaws.autoscaling#InstanceProtected": { - "type": "boolean" - }, - "com.amazonaws.autoscaling#InstanceRefresh": { - "type": "structure", - "members": { - "InstanceRefreshId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The instance refresh ID.

" - } - }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

" - } - }, - "Status": { - "target": "com.amazonaws.autoscaling#InstanceRefreshStatus", - "traits": { - "smithy.api#documentation": "

The current status for the instance refresh operation:

\n " - } - }, - "StatusReason": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", - "traits": { - "smithy.api#documentation": "

The explanation for the specific status assigned to this operation.

" - } - }, - "StartTime": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The date and time at which the instance refresh began.

" - } - }, - "EndTime": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The date and time at which the instance refresh ended.

" - } - }, - "PercentageComplete": { - "target": "com.amazonaws.autoscaling#IntPercent", - "traits": { - "smithy.api#documentation": "

The percentage of the instance refresh that is complete. For each instance\n replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the\n instance's health status changes to healthy and the specified warm-up time passes, the\n instance is considered updated and is added to the percentage complete.

\n \n

\n PercentageComplete does not include instances that are replaced\n during a rollback. This value gradually goes back down to zero during a\n rollback.

\n " - } - }, - "InstancesToUpdate": { - "target": "com.amazonaws.autoscaling#InstancesToUpdate", - "traits": { - "smithy.api#documentation": "

The number of instances remaining to update before the instance refresh is\n complete.

\n \n

If you roll back the instance refresh, InstancesToUpdate shows you\n the number of instances that were not yet updated by the instance refresh.\n Therefore, these instances don't need to be replaced as part of the rollback.

\n " - } - }, - "ProgressDetails": { - "target": "com.amazonaws.autoscaling#InstanceRefreshProgressDetails", - "traits": { - "smithy.api#documentation": "

Additional progress details for an Auto Scaling group that has a warm pool.

" - } - }, - "Preferences": { - "target": "com.amazonaws.autoscaling#RefreshPreferences", - "traits": { - "smithy.api#documentation": "

The preferences for an instance refresh.

" - } - }, - "DesiredConfiguration": { - "target": "com.amazonaws.autoscaling#DesiredConfiguration", - "traits": { - "smithy.api#documentation": "

Describes the desired configuration for the instance refresh.

" - } - }, - "RollbackDetails": { - "target": "com.amazonaws.autoscaling#RollbackDetails", - "traits": { - "smithy.api#documentation": "

The rollback details.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an instance refresh for an Auto Scaling group.

" - } - }, - "com.amazonaws.autoscaling#InstanceRefreshIds": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" - } - }, - "com.amazonaws.autoscaling#InstanceRefreshInProgressFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InstanceRefreshInProgress", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The request failed because an active instance refresh already exists for the specified\n Auto Scaling group.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.autoscaling#InstanceRefreshLivePoolProgress": { - "type": "structure", - "members": { - "PercentageComplete": { - "target": "com.amazonaws.autoscaling#IntPercent", - "traits": { - "smithy.api#documentation": "

The percentage of instances in the Auto Scaling group that have been replaced. For each\n instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time.\n When the instance's health status changes to healthy and the specified warm-up time\n passes, the instance is considered updated and is added to the percentage\n complete.

" - } - }, - "InstancesToUpdate": { - "target": "com.amazonaws.autoscaling#InstancesToUpdate", - "traits": { - "smithy.api#documentation": "

The number of instances remaining to update.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Reports progress on replacing instances that are in the Auto Scaling group.

" - } - }, - "com.amazonaws.autoscaling#InstanceRefreshProgressDetails": { - "type": "structure", - "members": { - "LivePoolProgress": { - "target": "com.amazonaws.autoscaling#InstanceRefreshLivePoolProgress", - "traits": { - "smithy.api#documentation": "

Reports progress on replacing instances that are in the Auto Scaling group.

" - } - }, - "WarmPoolProgress": { - "target": "com.amazonaws.autoscaling#InstanceRefreshWarmPoolProgress", - "traits": { - "smithy.api#documentation": "

Reports progress on replacing instances that are in the warm pool.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Reports progress on replacing instances in an Auto Scaling group that has a warm pool. This\n includes separate details for instances in the warm pool and instances in the Auto Scaling group\n (the live pool).

" - } - }, - "com.amazonaws.autoscaling#InstanceRefreshStatus": { - "type": "enum", - "members": { - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - }, - "InProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "Successful": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Successful" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "Cancelling": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Cancelling" - } - }, - "Cancelled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Cancelled" - } - }, - "RollbackInProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RollbackInProgress" - } - }, - "RollbackFailed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RollbackFailed" - } - }, - "RollbackSuccessful": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RollbackSuccessful" - } - } - } - }, - "com.amazonaws.autoscaling#InstanceRefreshWarmPoolProgress": { - "type": "structure", - "members": { - "PercentageComplete": { - "target": "com.amazonaws.autoscaling#IntPercent", - "traits": { - "smithy.api#documentation": "

The percentage of instances in the warm pool that have been replaced. For each\n instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time.\n When the instance's health status changes to healthy and the specified warm-up time\n passes, the instance is considered updated and is added to the percentage\n complete.

" - } - }, - "InstancesToUpdate": { - "target": "com.amazonaws.autoscaling#InstancesToUpdate", - "traits": { - "smithy.api#documentation": "

The number of instances remaining to update.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Reports progress on replacing instances that are in the warm pool.

" - } - }, - "com.amazonaws.autoscaling#InstanceRefreshes": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#InstanceRefresh" - } - }, - "com.amazonaws.autoscaling#InstanceRequirements": { - "type": "structure", - "members": { - "VCpuCount": { - "target": "com.amazonaws.autoscaling#VCpuCountRequest", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The minimum and maximum number of vCPUs for an instance type.

", - "smithy.api#required": {} - } - }, - "MemoryMiB": { - "target": "com.amazonaws.autoscaling#MemoryMiBRequest", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The minimum and maximum instance memory size for an instance type, in MiB.

", - "smithy.api#required": {} - } - }, - "CpuManufacturers": { - "target": "com.amazonaws.autoscaling#CpuManufacturers", - "traits": { - "smithy.api#documentation": "

Lists which specific CPU manufacturers to include.

\n \n \n

Don't confuse the CPU hardware manufacturer with the CPU hardware architecture.\n Instances will be launched with a compatible CPU architecture based on the Amazon\n Machine Image (AMI) that you specify in your launch template.

\n \n

Default: Any manufacturer

" - } - }, - "MemoryGiBPerVCpu": { - "target": "com.amazonaws.autoscaling#MemoryGiBPerVCpuRequest", - "traits": { - "smithy.api#documentation": "

The minimum and maximum amount of memory per vCPU for an instance type, in GiB.

\n

Default: No minimum or maximum limits

" - } - }, - "ExcludedInstanceTypes": { - "target": "com.amazonaws.autoscaling#ExcludedInstanceTypes", - "traits": { - "smithy.api#documentation": "

The instance types to exclude. You can use strings with one or more wild cards,\n represented by an asterisk (*), to exclude an instance family, type, size,\n or generation. The following are examples: m5.8xlarge, c5*.*,\n m5a.*, r*, *3*.

\n

For example, if you specify c5*, you are excluding the entire C5 instance\n family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n\n instance types.

\n \n

If you specify ExcludedInstanceTypes, you can't specify\n AllowedInstanceTypes.

\n \n

Default: No excluded instance types

" - } - }, - "InstanceGenerations": { - "target": "com.amazonaws.autoscaling#InstanceGenerations", - "traits": { - "smithy.api#documentation": "

Indicates whether current or previous generation instance types are included.

\n \n

Default: Any current or previous generation

" - } - }, - "SpotMaxPricePercentageOverLowestPrice": { - "target": "com.amazonaws.autoscaling#NullablePositiveInteger", - "traits": { - "smithy.api#documentation": "

[Price protection] The price protection threshold for Spot Instances, as a percentage\n higher than an identified Spot price. The identified Spot price is the price of the\n lowest priced current generation C, M, or R instance type with your specified\n attributes. If no current generation C, M, or R instance type matches your attributes,\n then the identified price is from either the lowest priced current generation instance\n types or, failing that, the lowest priced previous generation instance types that match\n your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will\n exclude instance types whose price exceeds your specified threshold.

\n

The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

\n

If you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is based on the per-vCPU or\n per-memory price instead of the per instance price.

\n \n

Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If\n you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection\n to consistently select from a wide range of instance types. To indicate no price\n protection threshold for Spot Instances, meaning you want to consider all instance\n types that match your attributes, include one of these parameters and specify a high\n value, such as 999999.

\n " - } - }, - "MaxSpotPriceAsPercentageOfOptimalOnDemandPrice": { - "target": "com.amazonaws.autoscaling#NullablePositiveInteger", - "traits": { - "smithy.api#documentation": "

[Price protection] The price protection threshold for Spot Instances, as a percentage\n of an identified On-Demand price. The identified On-Demand price is the price of the\n lowest priced current generation C, M, or R instance type with your specified\n attributes. If no current generation C, M, or R instance type matches your attributes,\n then the identified price is from either the lowest priced current generation instance\n types or, failing that, the lowest priced previous generation instance types that match\n your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will\n exclude instance types whose price exceeds your specified threshold.

\n

The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

\n

If you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is based on the per-vCPU or\n per-memory price instead of the per instance price.

\n \n

Only one of SpotMaxPricePercentageOverLowestPrice or\n MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If\n you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection\n to consistently select from a wide range of instance types. To indicate no price\n protection threshold for Spot Instances, meaning you want to consider all instance\n types that match your attributes, include one of these parameters and specify a high\n value, such as 999999.

\n " - } - }, - "OnDemandMaxPricePercentageOverLowestPrice": { - "target": "com.amazonaws.autoscaling#NullablePositiveInteger", - "traits": { - "smithy.api#documentation": "

[Price protection] The price protection threshold for On-Demand Instances, as a\n percentage higher than an identified On-Demand price. The identified On-Demand price is\n the price of the lowest priced current generation C, M, or R instance type with your\n specified attributes. If no current generation C, M, or R instance type matches your\n attributes, then the identified price is from either the lowest priced current\n generation instance types or, failing that, the lowest priced previous generation\n instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with\n your attributes, we will exclude instance types whose price exceeds your specified\n threshold.

\n

The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.

\n

To turn off price protection, specify a high value, such as 999999.

\n

If you set DesiredCapacityType to vcpu or\n memory-mib, the price protection threshold is applied based on the\n per-vCPU or per-memory price instead of the per instance price.

\n

Default: 20\n

" - } - }, - "BareMetal": { - "target": "com.amazonaws.autoscaling#BareMetal", - "traits": { - "smithy.api#documentation": "

Indicates whether bare metal instance types are included, excluded, or\n required.

\n

Default: excluded\n

" - } - }, - "BurstablePerformance": { - "target": "com.amazonaws.autoscaling#BurstablePerformance", - "traits": { - "smithy.api#documentation": "

Indicates whether burstable performance instance types are included, excluded, or\n required. For more information, see Burstable\n performance instances in the Amazon EC2 User Guide for Linux Instances.

\n

Default: excluded\n

" - } - }, - "RequireHibernateSupport": { - "target": "com.amazonaws.autoscaling#NullableBoolean", - "traits": { - "smithy.api#documentation": "

Indicates whether instance types must provide On-Demand Instance hibernation\n support.

\n

Default: false\n

" - } - }, - "NetworkInterfaceCount": { - "target": "com.amazonaws.autoscaling#NetworkInterfaceCountRequest", - "traits": { - "smithy.api#documentation": "

The minimum and maximum number of network interfaces for an instance type.

\n

Default: No minimum or maximum limits

" - } - }, - "LocalStorage": { - "target": "com.amazonaws.autoscaling#LocalStorage", - "traits": { - "smithy.api#documentation": "

Indicates whether instance types with instance store volumes are included, excluded,\n or required. For more information, see Amazon EC2 instance store in\n the Amazon EC2 User Guide for Linux Instances.

\n

Default: included\n

" - } - }, - "LocalStorageTypes": { - "target": "com.amazonaws.autoscaling#LocalStorageTypes", - "traits": { - "smithy.api#documentation": "

Indicates the type of local storage that is required.

\n \n

Default: Any local storage type

" - } - }, - "TotalLocalStorageGB": { - "target": "com.amazonaws.autoscaling#TotalLocalStorageGBRequest", - "traits": { - "smithy.api#documentation": "

The minimum and maximum total local storage size for an instance type, in GB.

\n

Default: No minimum or maximum limits

" - } - }, - "BaselineEbsBandwidthMbps": { - "target": "com.amazonaws.autoscaling#BaselineEbsBandwidthMbpsRequest", - "traits": { - "smithy.api#documentation": "

The minimum and maximum baseline bandwidth performance for an instance type, in Mbps.\n For more information, see Amazon EBS–optimized instances\n in the Amazon EC2 User Guide for Linux Instances.

\n

Default: No minimum or maximum limits

" - } - }, - "AcceleratorTypes": { - "target": "com.amazonaws.autoscaling#AcceleratorTypes", - "traits": { - "smithy.api#documentation": "

Lists the accelerator types that must be on an instance type.

\n \n

Default: Any accelerator type

" - } - }, - "AcceleratorCount": { - "target": "com.amazonaws.autoscaling#AcceleratorCountRequest", - "traits": { - "smithy.api#documentation": "

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia\n chips) for an instance type.

\n

To exclude accelerator-enabled instance types, set Max to\n 0.

\n

Default: No minimum or maximum limits

" - } - }, - "AcceleratorManufacturers": { - "target": "com.amazonaws.autoscaling#AcceleratorManufacturers", - "traits": { - "smithy.api#documentation": "

Indicates whether instance types must have accelerators by specific\n manufacturers.

\n \n

Default: Any manufacturer

" - } - }, - "AcceleratorNames": { - "target": "com.amazonaws.autoscaling#AcceleratorNames", - "traits": { - "smithy.api#documentation": "

Lists the accelerators that must be on an instance type.

\n \n

Default: Any accelerator

" - } - }, - "AcceleratorTotalMemoryMiB": { - "target": "com.amazonaws.autoscaling#AcceleratorTotalMemoryMiBRequest", - "traits": { - "smithy.api#documentation": "

The minimum and maximum total memory size for the accelerators on an instance type, in\n MiB.

\n

Default: No minimum or maximum limits

" - } - }, - "NetworkBandwidthGbps": { - "target": "com.amazonaws.autoscaling#NetworkBandwidthGbpsRequest", - "traits": { - "smithy.api#documentation": "

The minimum and maximum amount of network bandwidth, in gigabits per second\n (Gbps).

\n

Default: No minimum or maximum limits

" - } - }, - "AllowedInstanceTypes": { - "target": "com.amazonaws.autoscaling#AllowedInstanceTypes", - "traits": { - "smithy.api#documentation": "

The instance types to apply your specified attributes against. All other instance\n types are ignored, even if they match your specified attributes.

\n

You can use strings with one or more wild cards, represented by an asterisk\n (*), to allow an instance type, size, or generation. The following are\n examples: m5.8xlarge, c5*.*, m5a.*,\n r*, *3*.

\n

For example, if you specify c5*, Amazon EC2 Auto Scaling will allow the entire C5\n instance family, which includes all C5a and C5n instance types. If you specify\n m5a.*, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n\n instance types.

\n \n

If you specify AllowedInstanceTypes, you can't specify\n ExcludedInstanceTypes.

\n \n

Default: All instance types

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your\n specified requirements to identify instance types. Then, it uses your On-Demand and Spot\n allocation strategies to launch instances from these instance types.

\n

When you specify multiple attributes, you get instance types that satisfy all of the\n specified attributes. If you specify multiple values for an attribute, you get instance\n types that satisfy any of the specified values.

\n

To limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance\n types, you can use one of the following parameters, but not both in the same\n request:

\n \n \n

You must specify VCpuCount and MemoryMiB. All other\n attributes are optional. Any unspecified optional attribute is set to its\n default.

\n \n

For more information, see Create a mixed instances group using attribute-based instance type\n selection in the Amazon EC2 Auto Scaling User Guide. For help determining\n which instance types match your attributes before you apply them to your Auto Scaling group, see\n Preview instance types with specified attributes in the\n Amazon EC2 User Guide for Linux Instances.

" - } - }, - "com.amazonaws.autoscaling#InstanceReusePolicy": { - "type": "structure", - "members": { - "ReuseOnScaleIn": { - "target": "com.amazonaws.autoscaling#ReuseOnScaleIn", - "traits": { - "smithy.api#documentation": "

Specifies whether instances in the Auto Scaling group can be returned to the warm pool on\n scale in.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an instance reuse policy for a warm pool.

\n

For more information, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "com.amazonaws.autoscaling#Instances": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#Instance" - } - }, - "com.amazonaws.autoscaling#InstancesDistribution": { - "type": "structure", - "members": { - "OnDemandAllocationStrategy": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The allocation strategy to apply to your On-Demand Instances when they are launched.\n Possible instance types are determined by the launch template overrides that you\n specify.

\n

The following lists the valid values:

\n
\n
lowest-price
\n
\n

Uses price to determine which instance types are the highest priority,\n launching the lowest priced instance types within an Availability Zone\n first. This is the default value for Auto Scaling groups that specify InstanceRequirements.

\n
\n
prioritized
\n
\n

You set the order of instance types for the launch template overrides from\n highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling\n launches your highest priority instance types first. If all your On-Demand\n capacity cannot be fulfilled using your highest priority instance type, then\n Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance\n type, and so on. This is the default value for Auto Scaling groups that don't\n specify InstanceRequirements and cannot be used for groups\n that do.

\n
\n
" - } - }, - "OnDemandBaseCapacity": { - "target": "com.amazonaws.autoscaling#OnDemandBaseCapacity", - "traits": { - "smithy.api#documentation": "

The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand\n Instances. This base portion is launched first as your group scales.

\n

This number has the same unit of measurement as the group's desired capacity. If you\n change the default unit of measurement (number of instances) by specifying weighted\n capacity values in your launch template overrides list, or by changing the default\n desired capacity type setting of the group, you must specify this number using the same\n unit of measurement.

\n

Default: 0

" - } - }, - "OnDemandPercentageAboveBaseCapacity": { - "target": "com.amazonaws.autoscaling#OnDemandPercentageAboveBaseCapacity", - "traits": { - "smithy.api#documentation": "

Controls the percentages of On-Demand Instances and Spot Instances for your additional\n capacity beyond OnDemandBaseCapacity. Expressed as a number (for example,\n 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand\n Instances are used.

\n

Default: 100

" - } - }, - "SpotAllocationStrategy": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The allocation strategy to apply to your Spot Instances when they are launched.\n Possible instance types are determined by the launch template overrides that you\n specify.

\n

The following lists the valid values:

\n
\n
capacity-optimized
\n
\n

Requests Spot Instances using pools that are optimally chosen based on the\n available Spot capacity. This strategy has the lowest risk of interruption.\n To give certain instance types a higher chance of launching first, use\n capacity-optimized-prioritized.

\n
\n
capacity-optimized-prioritized
\n
\n

You set the order of instance types for the launch template overrides from\n highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors\n the instance type priorities on a best effort basis but optimizes for\n capacity first. Note that if the On-Demand allocation strategy is set to\n prioritized, the same priority is applied when fulfilling\n On-Demand capacity. This is not a valid value for Auto Scaling groups that specify\n InstanceRequirements.

\n
\n
lowest-price
\n
\n

Requests Spot Instances using the lowest priced pools within an\n Availability Zone, across the number of Spot pools that you specify for the\n SpotInstancePools property. To ensure that your desired\n capacity is met, you might receive Spot Instances from several pools. This\n is the default value, but it might lead to high interruption rates because\n this strategy only considers instance price and not available\n capacity.

\n
\n
price-capacity-optimized (recommended)
\n
\n

The price and capacity optimized allocation strategy looks at both price\n and capacity to select the Spot Instance pools that are the least likely to\n be interrupted and have the lowest possible price.

\n
\n
" - } - }, - "SpotInstancePools": { - "target": "com.amazonaws.autoscaling#SpotInstancePools", - "traits": { - "smithy.api#documentation": "

The number of Spot Instance pools across which to allocate your Spot Instances. The\n Spot pools are determined from the different instance types in the overrides. Valid only\n when the SpotAllocationStrategy is lowest-price. Value must be\n in the range of 1–20.

\n

Default: 2

" - } - }, - "SpotMaxPrice": { - "target": "com.amazonaws.autoscaling#MixedInstanceSpotPrice", - "traits": { - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. If\n your maximum price is lower than the Spot price for the instance types that you\n selected, your Spot Instances are not launched. We do not recommend specifying a maximum\n price because it can lead to increased interruptions. When Spot Instances launch, you\n pay the current Spot price. To remove a maximum price that you previously set, include\n the property but specify an empty string (\"\") for the value.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently\n than if you do not specify one.

\n \n

Valid Range: Minimum value of 0.001

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Use this structure to specify the distribution of On-Demand Instances and Spot\n Instances and the allocation strategies used to fulfill On-Demand and Spot capacities\n for a mixed instances policy.

" - } - }, - "com.amazonaws.autoscaling#InstancesToUpdate": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.autoscaling#IntPercent": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.autoscaling#IntPercent100To200": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 100, - "max": 200 - } - } - }, - "com.amazonaws.autoscaling#IntPercent100To200Resettable": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": -1, - "max": 200 - } - } - }, - "com.amazonaws.autoscaling#IntPercentResettable": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": -1, - "max": 100 - } - } - }, - "com.amazonaws.autoscaling#InvalidNextToken": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidNextToken", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The NextToken value is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.autoscaling#IrreversibleInstanceRefreshFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "IrreversibleInstanceRefresh", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The request failed because a desired configuration was not found or an incompatible\n launch template (uses a Systems Manager parameter instead of an AMI ID) or launch\n template version ($Latest or $Default) is present on the Auto Scaling\n group.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.autoscaling#LaunchConfiguration": { - "type": "structure", - "members": { - "LaunchConfigurationName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the launch configuration.

", - "smithy.api#required": {} - } - }, - "LaunchConfigurationARN": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the launch configuration.

" - } - }, - "ImageId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more\n information, see Find a Linux AMI in the\n Amazon EC2 User Guide for Linux Instances.

", - "smithy.api#required": {} - } - }, - "KeyName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the key pair.

\n

For more information, see Amazon EC2 key pairs and Amazon EC2\n instances in the Amazon EC2 User Guide for Linux Instances.

" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.autoscaling#SecurityGroups", - "traits": { - "smithy.api#documentation": "

A list that contains the security groups to assign to the instances in the Auto Scaling group.\n For more information, see Control traffic to your Amazon Web Services\n resources using security groups in the Amazon Virtual Private\n Cloud User Guide.

" - } - }, - "ClassicLinkVPCId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

Available for backward compatibility.

" - } - }, - "ClassicLinkVPCSecurityGroups": { - "target": "com.amazonaws.autoscaling#ClassicLinkVPCSecurityGroups", - "traits": { - "smithy.api#documentation": "

Available for backward compatibility.

" - } - }, - "UserData": { - "target": "com.amazonaws.autoscaling#XmlStringUserData", - "traits": { - "smithy.api#documentation": "

The user data to make available to the launched EC2 instances. For more information,\n see Instance metadata and user data (Linux) and Instance metadata and\n user data (Windows). If you are using a command line tool, base64-encoding\n is performed for you, and you can load the text from a file. Otherwise, you must provide\n base64-encoded text. User data is limited to 16 KB.

" - } - }, - "InstanceType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The instance type for the instances. For information about available instance types,\n see Available\n instance types in the Amazon EC2 User Guide for Linux Instances.

", - "smithy.api#required": {} - } - }, - "KernelId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The ID of the kernel associated with the AMI.

" - } - }, - "RamdiskId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The ID of the RAM disk associated with the AMI.

" - } - }, - "BlockDeviceMappings": { - "target": "com.amazonaws.autoscaling#BlockDeviceMappings", - "traits": { - "smithy.api#documentation": "

The block device mapping entries that define the block devices to attach to the\n instances at launch. By default, the block devices specified in the block device mapping\n for the AMI are used. For more information, see Block device\n mappings in the Amazon EC2 User Guide for Linux Instances.

" - } - }, - "InstanceMonitoring": { - "target": "com.amazonaws.autoscaling#InstanceMonitoring", - "traits": { - "smithy.api#documentation": "

Controls whether instances in this group are launched with detailed\n (true) or basic (false) monitoring.

\n

For more information, see Configure\n monitoring for Auto Scaling instances in the\n Amazon EC2 Auto Scaling User Guide.

" - } - }, - "SpotPrice": { - "target": "com.amazonaws.autoscaling#SpotPrice", - "traits": { - "smithy.api#documentation": "

The maximum hourly price to be paid for any Spot Instance launched to fulfill the\n request. Spot Instances are launched when the price you specify exceeds the current Spot\n price. For more information, see Requesting Spot\n Instances for fault-tolerant and flexible applications in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "IamInstanceProfile": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen1600", - "traits": { - "smithy.api#documentation": "

The name or the Amazon Resource Name (ARN) of the instance profile associated with the\n IAM role for the instance. The instance profile contains the IAM role. For more\n information, see IAM role for applications that run\n on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The creation date and time for the launch configuration.

", - "smithy.api#required": {} - } - }, - "EbsOptimized": { - "target": "com.amazonaws.autoscaling#EbsOptimized", - "traits": { - "smithy.api#documentation": "

Specifies whether the launch configuration is optimized for EBS I/O\n (true) or not (false). For more information, see Amazon EBS-optimized instances in the\n Amazon EC2 User Guide for Linux Instances.

" - } - }, - "AssociatePublicIpAddress": { - "target": "com.amazonaws.autoscaling#AssociatePublicIpAddress", - "traits": { - "smithy.api#documentation": "

Specifies whether to assign a public IPv4 address to the group's instances. If the\n instance is launched into a default subnet, the default is to assign a public IPv4\n address, unless you disabled the option to assign a public IPv4 address on the subnet.\n If the instance is launched into a nondefault subnet, the default is not to assign a\n public IPv4 address, unless you enabled the option to assign a public IPv4 address on\n the subnet. For more information, see Provide network connectivity for\n your Auto Scaling instances using Amazon VPC in the\n Amazon EC2 Auto Scaling User Guide.

" - } - }, - "PlacementTenancy": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", - "traits": { - "smithy.api#documentation": "

The tenancy of the instance, either default or dedicated. An\n instance with dedicated tenancy runs on isolated, single-tenant hardware\n and can only be launched into a VPC.

" - } - }, - "MetadataOptions": { - "target": "com.amazonaws.autoscaling#InstanceMetadataOptions", - "traits": { - "smithy.api#documentation": "

The metadata options for the instances. For more information, see Configure the instance metadata options in the\n Amazon EC2 Auto Scaling User Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a launch configuration.

" - } - }, - "com.amazonaws.autoscaling#LaunchConfigurationNameType": { - "type": "structure", - "members": { - "LaunchConfigurationName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the launch configuration.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#LaunchConfigurationNames": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" - } - }, - "com.amazonaws.autoscaling#LaunchConfigurationNamesType": { - "type": "structure", - "members": { - "LaunchConfigurationNames": { - "target": "com.amazonaws.autoscaling#LaunchConfigurationNames", - "traits": { - "smithy.api#documentation": "

The launch configuration names. If you omit this property, all launch configurations\n are described.

\n

Array Members: Maximum number of 50 items.

" - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a\n previous call.)

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.autoscaling#MaxRecords", - "traits": { - "smithy.api#documentation": "

The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.

" - } - } - } - }, - "com.amazonaws.autoscaling#LaunchConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#LaunchConfiguration" - } - }, - "com.amazonaws.autoscaling#LaunchConfigurationsType": { - "type": "structure", - "members": { - "LaunchConfigurations": { - "target": "com.amazonaws.autoscaling#LaunchConfigurations", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The launch configurations.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" - } - } - } - }, - "com.amazonaws.autoscaling#LaunchTemplate": { - "type": "structure", - "members": { - "LaunchTemplateSpecification": { - "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", - "traits": { - "smithy.api#documentation": "

The launch template.

" - } - }, - "Overrides": { - "target": "com.amazonaws.autoscaling#Overrides", - "traits": { - "smithy.api#documentation": "

Any properties that you specify override the same properties in the launch\n template.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Use this structure to specify the launch templates and instance types (overrides) for\n a mixed instances policy.

" - } - }, - "com.amazonaws.autoscaling#LaunchTemplateName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\(\\)\\.\\-/_]+$" - } - }, - "com.amazonaws.autoscaling#LaunchTemplateOverrides": { - "type": "structure", - "members": { - "InstanceType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The instance type, such as m3.xlarge. You must specify an instance type\n that is supported in your requested Region and Availability Zones. For more information,\n see Instance types in the Amazon EC2 User Guide for Linux Instances.

\n

You can specify up to 40 instance types per Auto Scaling group.

" - } - }, - "WeightedCapacity": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", - "traits": { - "smithy.api#documentation": "

If you provide a list of instance types to use, you can specify the number of capacity\n units provided by each instance type in terms of virtual CPUs, memory, storage,\n throughput, or other relative performance characteristic. When a Spot or On-Demand\n Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling\n launches instances until the desired capacity is totally fulfilled, even if this results\n in an overage. For example, if there are two units remaining to fulfill capacity, and\n Amazon EC2 Auto Scaling can only launch an instance with a WeightedCapacity of five units,\n the instance is launched, and the desired capacity is exceeded by three units. For more\n information, see Configure an Auto Scaling group to use instance weights in the\n Amazon EC2 Auto Scaling User Guide. Value must be in the range of 1–999.

\n

If you specify a value for WeightedCapacity for one instance type, you\n must specify a value for WeightedCapacity for all of them.

\n \n

Every Auto Scaling group has three size parameters (DesiredCapacity,\n MaxSize, and MinSize). Usually, you set these sizes\n based on a specific number of instances. However, if you configure a mixed instances\n policy that defines weights for the instance types, you must specify these sizes\n with the same units that you use for weighting instances.

\n " - } - }, - "LaunchTemplateSpecification": { - "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", - "traits": { - "smithy.api#documentation": "

Provides a launch template for the specified instance type or set of instance\n requirements. For example, some instance types might require a launch template with a\n different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in\n the LaunchTemplate definition. For more information, see Specifying a different launch template for an instance type in the\n Amazon EC2 Auto Scaling User Guide.

\n

You can specify up to 20 launch templates per Auto Scaling group. The launch templates\n specified in the overrides and in the LaunchTemplate definition count\n towards this limit.

" - } - }, - "InstanceRequirements": { - "target": "com.amazonaws.autoscaling#InstanceRequirements", - "traits": { - "smithy.api#documentation": "

The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify\n instance types. Then, it uses your On-Demand and Spot allocation strategies to launch\n instances from these instance types.

\n

You can specify up to four separate sets of instance requirements per Auto Scaling group. This\n is useful for provisioning instances from different Amazon Machine Images (AMIs) in the\n same Auto Scaling group. To do this, create the AMIs and create a new launch template for each\n AMI. Then, create a compatible set of instance requirements for each launch template.\n

\n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Use this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling group has a mixed\n instances policy:

\n \n

Specify the instance types that you want, or define your instance requirements instead\n and let Amazon EC2 Auto Scaling provision the available instance types that meet your requirements.\n This can provide Amazon EC2 Auto Scaling with a larger selection of instance types to choose from when\n fulfilling Spot and On-Demand capacities. You can view which instance types are matched\n before you apply the instance requirements to your Auto Scaling group.

\n

After you define your instance requirements, you don't have to keep updating these\n settings to get new EC2 instance types automatically. Amazon EC2 Auto Scaling uses the instance\n requirements of the Auto Scaling group to determine whether a new EC2 instance type can be\n used.

" - } - }, - "com.amazonaws.autoscaling#LaunchTemplateSpecification": { - "type": "structure", - "members": { - "LaunchTemplateId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created\n using the Amazon EC2 CreateLaunchTemplate API.

\n

Conditional: You must specify either a LaunchTemplateId or a\n LaunchTemplateName.

" - } - }, - "LaunchTemplateName": { - "target": "com.amazonaws.autoscaling#LaunchTemplateName", - "traits": { - "smithy.api#documentation": "

The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created\n using the Amazon EC2 CreateLaunchTemplate API.

\n

Conditional: You must specify either a LaunchTemplateId or a\n LaunchTemplateName.

" - } - }, - "Version": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The version number, $Latest, or $Default. To get the version\n number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions\n can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is $Latest,\n Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If\n the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch\n template when launching instances. The default value is $Default.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling\n uses to launch Amazon EC2 instances. For more information about launch templates, see Launch\n templates in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "com.amazonaws.autoscaling#LifecycleActionResult": { - "type": "string" - }, - "com.amazonaws.autoscaling#LifecycleActionToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 36, - "max": 36 - } - } - }, - "com.amazonaws.autoscaling#LifecycleHook": { - "type": "structure", - "members": { - "LifecycleHookName": { - "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the lifecycle hook.

" - } - }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group for the lifecycle hook.

" - } - }, - "LifecycleTransition": { - "target": "com.amazonaws.autoscaling#LifecycleTransition", - "traits": { - "smithy.api#documentation": "

The lifecycle transition.

\n

Valid values: autoscaling:EC2_INSTANCE_LAUNCHING |\n autoscaling:EC2_INSTANCE_TERMINATING\n

" - } - }, - "NotificationTargetARN": { - "target": "com.amazonaws.autoscaling#NotificationTargetResourceName", - "traits": { - "smithy.api#documentation": "

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a\n wait state for the lifecycle hook.

" - } - }, - "RoleARN": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target (an Amazon SNS topic or an Amazon SQS queue).

" - } - }, - "NotificationMetadata": { - "target": "com.amazonaws.autoscaling#AnyPrintableAsciiStringMaxLen4000", - "traits": { - "smithy.api#documentation": "

Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the\n notification target.

" - } - }, - "HeartbeatTimeout": { - "target": "com.amazonaws.autoscaling#HeartbeatTimeout", - "traits": { - "smithy.api#documentation": "

The maximum time, in seconds, that can elapse before the lifecycle hook times out. If\n the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the\n DefaultResult property.

" - } - }, - "GlobalTimeout": { - "target": "com.amazonaws.autoscaling#GlobalTimeout", - "traits": { - "smithy.api#documentation": "

The maximum time, in seconds, that an instance can remain in a wait state. The maximum\n is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is\n smaller.

" - } - }, - "DefaultResult": { - "target": "com.amazonaws.autoscaling#LifecycleActionResult", - "traits": { - "smithy.api#documentation": "

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an\n unexpected failure occurs.

\n

Valid values: CONTINUE | ABANDON\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a lifecycle hook. A lifecycle hook lets you create solutions that are aware\n of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances\n when the corresponding lifecycle event\n occurs.

" - } - }, - "com.amazonaws.autoscaling#LifecycleHookNames": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.autoscaling#LifecycleHookSpecification": { - "type": "structure", - "members": { - "LifecycleHookName": { - "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the lifecycle hook.

", - "smithy.api#required": {} - } - }, - "LifecycleTransition": { - "target": "com.amazonaws.autoscaling#LifecycleTransition", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The lifecycle transition. For Auto Scaling groups, there are two major lifecycle\n transitions.

\n ", - "smithy.api#required": {} - } - }, - "NotificationMetadata": { - "target": "com.amazonaws.autoscaling#AnyPrintableAsciiStringMaxLen4000", - "traits": { - "smithy.api#documentation": "

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to\n the notification target.

" - } - }, - "HeartbeatTimeout": { - "target": "com.amazonaws.autoscaling#HeartbeatTimeout", - "traits": { - "smithy.api#documentation": "

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The\n range is from 30 to 7200 seconds. The default value is\n 3600 seconds (1 hour).

" - } - }, - "DefaultResult": { - "target": "com.amazonaws.autoscaling#LifecycleActionResult", - "traits": { - "smithy.api#documentation": "

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an\n unexpected failure occurs. The default value is ABANDON.

\n

Valid values: CONTINUE | ABANDON\n

" - } - }, - "NotificationTargetARN": { - "target": "com.amazonaws.autoscaling#NotificationTargetResourceName", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends\n notifications to when an instance is in a wait state for the lifecycle hook. You can\n specify an Amazon SNS topic or an Amazon SQS queue.

" - } - }, - "RoleARN": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target. For information about creating this role, see Prepare to\n add a lifecycle hook to your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes information used to specify a lifecycle hook for an Auto Scaling\n group.

\n

For more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "com.amazonaws.autoscaling#LifecycleHookSpecifications": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#LifecycleHookSpecification" - } - }, - "com.amazonaws.autoscaling#LifecycleHooks": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#LifecycleHook" - } - }, - "com.amazonaws.autoscaling#LifecycleState": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - }, - "PENDING_WAIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending:Wait" - } - }, - "PENDING_PROCEED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending:Proceed" - } - }, - "QUARANTINED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Quarantined" - } - }, - "IN_SERVICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InService" - } - }, - "TERMINATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terminating" - } - }, - "TERMINATING_WAIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terminating:Wait" - } - }, - "TERMINATING_PROCEED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terminating:Proceed" - } - }, - "TERMINATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terminated" - } - }, - "DETACHING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Detaching" - } - }, - "DETACHED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Detached" - } - }, - "ENTERING_STANDBY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EnteringStandby" - } - }, - "STANDBY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Standby" - } - }, - "WARMED_PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Warmed:Pending" - } - }, - "WARMED_PENDING_WAIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Warmed:Pending:Wait" - } - }, - "WARMED_PENDING_PROCEED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Warmed:Pending:Proceed" - } - }, - "WARMED_TERMINATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Warmed:Terminating" - } - }, - "WARMED_TERMINATING_WAIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Warmed:Terminating:Wait" - } - }, - "WARMED_TERMINATING_PROCEED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Warmed:Terminating:Proceed" - } - }, - "WARMED_TERMINATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Warmed:Terminated" - } - }, - "WARMED_STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Warmed:Stopped" - } - }, - "WARMED_RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Warmed:Running" - } - }, - "WARMED_HIBERNATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Warmed:Hibernated" - } - } - } - }, - "com.amazonaws.autoscaling#LifecycleTransition": { - "type": "string" - }, - "com.amazonaws.autoscaling#LimitExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "LimitExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You have already reached a limit for your Amazon EC2 Auto Scaling\n resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For\n more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API\n Reference.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.autoscaling#LoadBalancerNames": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" - } - }, - "com.amazonaws.autoscaling#LoadBalancerState": { - "type": "structure", - "members": { - "LoadBalancerName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the load balancer.

" - } - }, - "State": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

One of the following load balancer states:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the state of a Classic Load Balancer.

" - } - }, - "com.amazonaws.autoscaling#LoadBalancerStates": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#LoadBalancerState" - } - }, - "com.amazonaws.autoscaling#LoadBalancerTargetGroupState": { - "type": "structure", - "members": { - "LoadBalancerTargetGroupARN": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen511", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target group.

" - } - }, - "State": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The state of the target group.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the state of a target group.

" - } - }, - "com.amazonaws.autoscaling#LoadBalancerTargetGroupStates": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#LoadBalancerTargetGroupState" - } - }, - "com.amazonaws.autoscaling#LoadForecast": { - "type": "structure", - "members": { - "Timestamps": { - "target": "com.amazonaws.autoscaling#PredictiveScalingForecastTimestamps", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The timestamps for the data points, in UTC format.

", - "smithy.api#required": {} - } - }, - "Values": { - "target": "com.amazonaws.autoscaling#PredictiveScalingForecastValues", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The values of the data points.

", - "smithy.api#required": {} - } - }, - "MetricSpecification": { - "target": "com.amazonaws.autoscaling#PredictiveScalingMetricSpecification", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The metric specification for the load forecast.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A GetPredictiveScalingForecast call returns the load forecast for a\n predictive scaling policy. This structure includes the data points for that load\n forecast, along with the timestamps of those data points and the metric specification.\n

" - } - }, - "com.amazonaws.autoscaling#LoadForecasts": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#LoadForecast" - } - }, - "com.amazonaws.autoscaling#LocalStorage": { - "type": "enum", - "members": { - "INCLUDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "included" - } - }, - "EXCLUDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "excluded" - } - }, - "REQUIRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "required" - } - } - } - }, - "com.amazonaws.autoscaling#LocalStorageType": { - "type": "enum", - "members": { - "HDD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "hdd" - } - }, - "SSD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ssd" - } - } - } - }, - "com.amazonaws.autoscaling#LocalStorageTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#LocalStorageType" - } - }, - "com.amazonaws.autoscaling#MaxGroupPreparedCapacity": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": -1 - } - } - }, - "com.amazonaws.autoscaling#MaxInstanceLifetime": { - "type": "integer" - }, - "com.amazonaws.autoscaling#MaxNumberOfAutoScalingGroups": { - "type": "integer" - }, - "com.amazonaws.autoscaling#MaxNumberOfLaunchConfigurations": { - "type": "integer" - }, - "com.amazonaws.autoscaling#MaxRecords": { - "type": "integer" - }, - "com.amazonaws.autoscaling#MemoryGiBPerVCpuRequest": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.autoscaling#NullablePositiveDouble", - "traits": { - "smithy.api#documentation": "

The memory minimum in GiB.

" - } - }, - "Max": { - "target": "com.amazonaws.autoscaling#NullablePositiveDouble", - "traits": { - "smithy.api#documentation": "

The memory maximum in GiB.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the minimum and maximum for the MemoryGiBPerVCpu object when\n you specify InstanceRequirements for an Auto Scaling group.

" - } - }, - "com.amazonaws.autoscaling#MemoryMiBRequest": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.autoscaling#NullablePositiveInteger", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The memory minimum in MiB.

", - "smithy.api#required": {} - } - }, - "Max": { - "target": "com.amazonaws.autoscaling#NullablePositiveInteger", - "traits": { - "smithy.api#documentation": "

The memory maximum in MiB.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the minimum and maximum for the MemoryMiB object when you\n specify InstanceRequirements for an Auto Scaling group.

" - } - }, - "com.amazonaws.autoscaling#Metric": { - "type": "structure", - "members": { - "Namespace": { - "target": "com.amazonaws.autoscaling#MetricNamespace", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The namespace of the metric. For more information, see the table in Amazon Web Services\n services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.

", - "smithy.api#required": {} - } - }, - "MetricName": { - "target": "com.amazonaws.autoscaling#MetricName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the metric.

", - "smithy.api#required": {} - } - }, - "Dimensions": { - "target": "com.amazonaws.autoscaling#MetricDimensions", - "traits": { - "smithy.api#documentation": "

The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services\n documentation available from the table in Amazon Web Services\n services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.

\n

Conditional: If you published your metric with dimensions, you must specify the same\n dimensions in your scaling policy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a specific metric.

" - } - }, - "com.amazonaws.autoscaling#MetricCollectionType": { - "type": "structure", - "members": { - "Metric": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

One of the following metrics:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a metric.

" - } - }, - "com.amazonaws.autoscaling#MetricCollectionTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#MetricCollectionType" - } - }, - "com.amazonaws.autoscaling#MetricDataQueries": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#MetricDataQuery" - } - }, - "com.amazonaws.autoscaling#MetricDataQuery": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A short name that identifies the object's results in the response. This name must be\n unique among all MetricDataQuery objects specified for a single scaling\n policy. If you are performing math expressions on this set of data, this name represents\n that data and can serve as a variable in the mathematical expression. The valid\n characters are letters, numbers, and underscores. The first character must be a\n lowercase letter.

", - "smithy.api#required": {} - } - }, - "Expression": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", - "traits": { - "smithy.api#documentation": "

The math expression to perform on the returned data, if this object is performing a\n math expression. This expression can use the Id of the other metrics to\n refer to those metrics, and can also use the Id of other expressions to use\n the result of those expressions.

\n

Conditional: Within each MetricDataQuery object, you must specify either\n Expression or MetricStat, but not both.

" - } - }, - "MetricStat": { - "target": "com.amazonaws.autoscaling#MetricStat", - "traits": { - "smithy.api#documentation": "

Information about the metric data to return.

\n

Conditional: Within each MetricDataQuery object, you must specify either\n Expression or MetricStat, but not both.

" - } - }, - "Label": { - "target": "com.amazonaws.autoscaling#XmlStringMetricLabel", - "traits": { - "smithy.api#documentation": "

A human-readable label for this metric or expression. This is especially useful if\n this is a math expression, so that you know what the value represents.

" - } - }, - "ReturnData": { - "target": "com.amazonaws.autoscaling#ReturnData", - "traits": { - "smithy.api#documentation": "

Indicates whether to return the timestamps and raw data values of this metric.

\n

If you use any math expressions, specify true for this value for only the\n final math expression that the metric specification is based on. You must specify\n false for ReturnData for all the other metrics and\n expressions used in the metric specification.

\n

If you are only retrieving metrics and not performing any math expressions, do not\n specify anything for ReturnData. This sets it to its default\n (true).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The metric data to return. Also defines whether this call is returning data for one\n metric only, or whether it is performing a math expression on the values of returned\n metric statistics to create a new time series. A time series is a series of data points,\n each of which is associated with a timestamp.

\n

For more information and examples, see Advanced predictive scaling policy configurations using custom metrics in\n the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "com.amazonaws.autoscaling#MetricDimension": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.autoscaling#MetricDimensionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the dimension.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.autoscaling#MetricDimensionValue", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The value of the dimension.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the dimension of a metric.

" - } - }, - "com.amazonaws.autoscaling#MetricDimensionName": { - "type": "string" - }, - "com.amazonaws.autoscaling#MetricDimensionValue": { - "type": "string" - }, - "com.amazonaws.autoscaling#MetricDimensions": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#MetricDimension" - } - }, - "com.amazonaws.autoscaling#MetricGranularityType": { - "type": "structure", - "members": { - "Granularity": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The granularity. The only valid value is 1Minute.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a granularity of a metric.

" - } - }, - "com.amazonaws.autoscaling#MetricGranularityTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#MetricGranularityType" - } - }, - "com.amazonaws.autoscaling#MetricName": { - "type": "string" - }, - "com.amazonaws.autoscaling#MetricNamespace": { - "type": "string" - }, - "com.amazonaws.autoscaling#MetricScale": { - "type": "double" - }, - "com.amazonaws.autoscaling#MetricStat": { - "type": "structure", - "members": { - "Metric": { - "target": "com.amazonaws.autoscaling#Metric", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The CloudWatch metric to return, including the metric name, namespace, and dimensions. To\n get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.

", - "smithy.api#required": {} - } - }, - "Stat": { - "target": "com.amazonaws.autoscaling#XmlStringMetricStat", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The statistic to return. It can include any CloudWatch statistic or extended statistic. For\n a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.

\n

The most commonly used metrics for predictive scaling are Average and\n Sum.

", - "smithy.api#required": {} - } - }, - "Unit": { - "target": "com.amazonaws.autoscaling#MetricUnit", - "traits": { - "smithy.api#documentation": "

The unit to use for the returned data points. For a complete list of the units that\n CloudWatch supports, see the MetricDatum\n data type in the Amazon CloudWatch API Reference.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This structure defines the CloudWatch metric to return, along with the statistic and\n unit.

\n

For more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts in the Amazon CloudWatch User Guide.

" - } - }, - "com.amazonaws.autoscaling#MetricStatistic": { - "type": "enum", - "members": { - "Average": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Average" - } - }, - "Minimum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Minimum" - } - }, - "Maximum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Maximum" - } - }, - "SampleCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SampleCount" - } - }, - "Sum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Sum" - } - } - } - }, - "com.amazonaws.autoscaling#MetricType": { - "type": "enum", - "members": { - "ASGAverageCPUUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASGAverageCPUUtilization" - } - }, - "ASGAverageNetworkIn": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASGAverageNetworkIn" - } - }, - "ASGAverageNetworkOut": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASGAverageNetworkOut" - } - }, - "ALBRequestCountPerTarget": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALBRequestCountPerTarget" - } - } - } - }, - "com.amazonaws.autoscaling#MetricUnit": { - "type": "string" - }, - "com.amazonaws.autoscaling#Metrics": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" - } - }, - "com.amazonaws.autoscaling#MinAdjustmentMagnitude": { - "type": "integer" - }, - "com.amazonaws.autoscaling#MinAdjustmentStep": { - "type": "integer", - "traits": { - "smithy.api#deprecated": {} - } - }, - "com.amazonaws.autoscaling#MixedInstanceSpotPrice": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.autoscaling#MixedInstancesPolicy": { - "type": "structure", - "members": { - "LaunchTemplate": { - "target": "com.amazonaws.autoscaling#LaunchTemplate", - "traits": { - "smithy.api#documentation": "

One or more launch templates and the instance types (overrides) that are used to\n launch EC2 instances to fulfill On-Demand and Spot capacities.

" - } - }, - "InstancesDistribution": { - "target": "com.amazonaws.autoscaling#InstancesDistribution", - "traits": { - "smithy.api#documentation": "

The instances distribution.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Use this structure to launch multiple instance types and On-Demand Instances and Spot\n Instances within a single Auto Scaling group.

\n

A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch\n instances and help optimize your costs. For more information, see Auto Scaling\n groups with multiple instance types and purchase options in the\n Amazon EC2 Auto Scaling User Guide.

" - } - }, - "com.amazonaws.autoscaling#MonitoringEnabled": { - "type": "boolean" - }, - "com.amazonaws.autoscaling#NetworkBandwidthGbpsRequest": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.autoscaling#NullablePositiveDouble", - "traits": { - "smithy.api#documentation": "

The minimum amount of network bandwidth, in gigabits per second (Gbps).

" - } - }, - "Max": { - "target": "com.amazonaws.autoscaling#NullablePositiveDouble", - "traits": { - "smithy.api#documentation": "

The maximum amount of network bandwidth, in gigabits per second (Gbps).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the minimum and maximum for the NetworkBandwidthGbps object\n when you specify InstanceRequirements for an Auto Scaling group.

\n \n

Setting the minimum bandwidth does not guarantee that your instance will achieve\n the minimum bandwidth. Amazon EC2 will identify instance types that support the specified\n minimum bandwidth, but the actual bandwidth of your instance might go below the\n specified minimum at times. For more information, see Available instance bandwidth in the\n Amazon EC2 User Guide for Linux Instances.

\n " - } - }, - "com.amazonaws.autoscaling#NetworkInterfaceCountRequest": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.autoscaling#NullablePositiveInteger", - "traits": { - "smithy.api#documentation": "

The minimum number of network interfaces.

" - } - }, - "Max": { - "target": "com.amazonaws.autoscaling#NullablePositiveInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of network interfaces.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the minimum and maximum for the NetworkInterfaceCount object\n when you specify InstanceRequirements for an Auto Scaling group.

" - } - }, - "com.amazonaws.autoscaling#NoDevice": { - "type": "boolean" - }, - "com.amazonaws.autoscaling#NonZeroIntPercent": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.autoscaling#NotificationConfiguration": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

" - } - }, - "TopicARN": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SNS topic.

" - } - }, - "NotificationType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

One of the following event notification types:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a notification.

" - } - }, - "com.amazonaws.autoscaling#NotificationConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#NotificationConfiguration" - } - }, - "com.amazonaws.autoscaling#NotificationTargetResourceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.autoscaling#NullableBoolean": { - "type": "boolean" - }, - "com.amazonaws.autoscaling#NullablePositiveDouble": { - "type": "double", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.autoscaling#NullablePositiveInteger": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.autoscaling#NumberOfAutoScalingGroups": { - "type": "integer" - }, - "com.amazonaws.autoscaling#NumberOfLaunchConfigurations": { - "type": "integer" - }, - "com.amazonaws.autoscaling#OnDemandBaseCapacity": { - "type": "integer" - }, - "com.amazonaws.autoscaling#OnDemandPercentageAboveBaseCapacity": { - "type": "integer" - }, - "com.amazonaws.autoscaling#Overrides": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#LaunchTemplateOverrides" - } - }, - "com.amazonaws.autoscaling#PoliciesType": { - "type": "structure", - "members": { - "ScalingPolicies": { - "target": "com.amazonaws.autoscaling#ScalingPolicies", - "traits": { - "smithy.api#documentation": "

The scaling policies.

" - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" - } - } - } - }, - "com.amazonaws.autoscaling#PolicyARNType": { - "type": "structure", - "members": { - "PolicyARN": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy.

" - } - }, - "Alarms": { - "target": "com.amazonaws.autoscaling#Alarms", - "traits": { - "smithy.api#documentation": "

The CloudWatch alarms created for the target tracking scaling policy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the output of PutScalingPolicy.

" - } - }, - "com.amazonaws.autoscaling#PolicyIncrement": { - "type": "integer" - }, - "com.amazonaws.autoscaling#PolicyNames": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#ResourceName" - } - }, - "com.amazonaws.autoscaling#PolicyTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen64" - } - }, - "com.amazonaws.autoscaling#PredefinedLoadMetricType": { - "type": "enum", - "members": { - "ASGTotalCPUUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASGTotalCPUUtilization" - } - }, - "ASGTotalNetworkIn": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASGTotalNetworkIn" - } - }, - "ASGTotalNetworkOut": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASGTotalNetworkOut" - } - }, - "ALBTargetGroupRequestCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALBTargetGroupRequestCount" - } - } - } - }, - "com.amazonaws.autoscaling#PredefinedMetricPairType": { - "type": "enum", - "members": { - "ASGCPUUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASGCPUUtilization" - } - }, - "ASGNetworkIn": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASGNetworkIn" - } - }, - "ASGNetworkOut": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASGNetworkOut" - } - }, - "ALBRequestCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALBRequestCount" - } - } - } - }, - "com.amazonaws.autoscaling#PredefinedMetricSpecification": { - "type": "structure", - "members": { - "PredefinedMetricType": { - "target": "com.amazonaws.autoscaling#MetricType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The metric type. The following predefined metrics are available:

\n ", - "smithy.api#required": {} - } - }, - "ResourceLabel": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", - "traits": { - "smithy.api#documentation": "

A label that uniquely identifies a specific Application Load Balancer target group\n from which to determine the average request count served by your Auto Scaling group. You can't\n specify a resource label unless the target group is attached to the Auto Scaling group.

\n

You create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:

\n

\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

\n

Where:

\n \n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a predefined metric for a target tracking scaling policy to use with\n Amazon EC2 Auto Scaling.

" - } - }, - "com.amazonaws.autoscaling#PredefinedScalingMetricType": { - "type": "enum", - "members": { - "ASGAverageCPUUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASGAverageCPUUtilization" - } - }, - "ASGAverageNetworkIn": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASGAverageNetworkIn" - } - }, - "ASGAverageNetworkOut": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASGAverageNetworkOut" - } - }, - "ALBRequestCountPerTarget": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALBRequestCountPerTarget" - } - } - } - }, - "com.amazonaws.autoscaling#PredictiveScalingConfiguration": { - "type": "structure", - "members": { - "MetricSpecifications": { - "target": "com.amazonaws.autoscaling#PredictiveScalingMetricSpecifications", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

This structure includes the metrics and target utilization to use for predictive\n scaling.

\n

This is an array, but we currently only support a single metric specification. That\n is, you can specify a target value and a single metric pair, or a target value and one\n scaling metric and one load metric.

", - "smithy.api#required": {} - } - }, - "Mode": { - "target": "com.amazonaws.autoscaling#PredictiveScalingMode", - "traits": { - "smithy.api#documentation": "

The predictive scaling mode. Defaults to ForecastOnly if not\n specified.

" - } - }, - "SchedulingBufferTime": { - "target": "com.amazonaws.autoscaling#PredictiveScalingSchedulingBufferTime", - "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, by which the instance launch time can be advanced. For\n example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch\n instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The\n intention is to give resources time to be provisioned. It can take a few minutes to\n launch an EC2 instance. The actual amount of time required depends on several factors,\n such as the size of the instance and whether there are startup scripts to complete.

\n

The value must be less than the forecast interval duration of 3600 seconds (60\n minutes). Defaults to 300 seconds if not specified.

" - } - }, - "MaxCapacityBreachBehavior": { - "target": "com.amazonaws.autoscaling#PredictiveScalingMaxCapacityBreachBehavior", - "traits": { - "smithy.api#documentation": "

Defines the behavior that should be applied if the forecast capacity approaches or\n exceeds the maximum capacity of the Auto Scaling group. Defaults to\n HonorMaxCapacity if not specified.

\n

The following are possible values:

\n \n \n

Use caution when allowing the maximum capacity to be automatically increased. This\n can lead to more instances being launched than intended if the increased maximum\n capacity is not monitored and managed. The increased maximum capacity then becomes\n the new normal maximum capacity for the Auto Scaling group until you manually update\n it. The maximum capacity does not automatically decrease back to the original\n maximum.

\n " - } - }, - "MaxCapacityBuffer": { - "target": "com.amazonaws.autoscaling#PredictiveScalingMaxCapacityBuffer", - "traits": { - "smithy.api#documentation": "

The size of the capacity buffer to use when the forecast capacity is close to or\n exceeds the maximum capacity. The value is specified as a percentage relative to the\n forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer,\n such that if the forecast capacity is 50, and the maximum capacity is 40, then the\n effective maximum capacity is 55.

\n

If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but\n not exceed forecast capacity.

\n

Required if the MaxCapacityBreachBehavior property is set to\n IncreaseMaxCapacity, and cannot be used otherwise.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a predictive scaling policy configuration to use with Amazon EC2 Auto Scaling.

" - } - }, - "com.amazonaws.autoscaling#PredictiveScalingCustomizedCapacityMetric": { - "type": "structure", - "members": { - "MetricDataQueries": { - "target": "com.amazonaws.autoscaling#MetricDataQueries", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

One or more metric data queries to provide the data points for a capacity metric. Use\n multiple metric data queries only if you are performing a math expression on returned\n data.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a customized capacity metric for a predictive scaling policy.

" - } - }, - "com.amazonaws.autoscaling#PredictiveScalingCustomizedLoadMetric": { - "type": "structure", - "members": { - "MetricDataQueries": { - "target": "com.amazonaws.autoscaling#MetricDataQueries", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

One or more metric data queries to provide the data points for a load metric. Use\n multiple metric data queries only if you are performing a math expression on returned\n data.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a custom load metric for a predictive scaling policy.

" - } - }, - "com.amazonaws.autoscaling#PredictiveScalingCustomizedScalingMetric": { - "type": "structure", - "members": { - "MetricDataQueries": { - "target": "com.amazonaws.autoscaling#MetricDataQueries", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

One or more metric data queries to provide the data points for a scaling metric. Use\n multiple metric data queries only if you are performing a math expression on returned\n data.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a custom scaling metric for a predictive scaling policy.

" - } - }, - "com.amazonaws.autoscaling#PredictiveScalingForecastTimestamps": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#TimestampType" - } - }, - "com.amazonaws.autoscaling#PredictiveScalingForecastValues": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#MetricScale" - } - }, - "com.amazonaws.autoscaling#PredictiveScalingMaxCapacityBreachBehavior": { - "type": "enum", - "members": { - "HonorMaxCapacity": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HonorMaxCapacity" - } - }, - "IncreaseMaxCapacity": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IncreaseMaxCapacity" - } - } - } - }, - "com.amazonaws.autoscaling#PredictiveScalingMaxCapacityBuffer": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.autoscaling#PredictiveScalingMetricSpecification": { - "type": "structure", - "members": { - "TargetValue": { - "target": "com.amazonaws.autoscaling#MetricScale", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Specifies the target utilization.

\n \n

Some metrics are based on a count instead of a percentage, such as the request\n count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy\n specifies one of these metrics, specify the target utilization as the optimal\n average request or message count per instance during any one-minute interval.\n

\n ", - "smithy.api#required": {} - } - }, - "PredefinedMetricPairSpecification": { - "target": "com.amazonaws.autoscaling#PredictiveScalingPredefinedMetricPair", - "traits": { - "smithy.api#documentation": "

The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the\n appropriate scaling metric and load metric to use.

" - } - }, - "PredefinedScalingMetricSpecification": { - "target": "com.amazonaws.autoscaling#PredictiveScalingPredefinedScalingMetric", - "traits": { - "smithy.api#documentation": "

The predefined scaling metric specification.

" - } - }, - "PredefinedLoadMetricSpecification": { - "target": "com.amazonaws.autoscaling#PredictiveScalingPredefinedLoadMetric", - "traits": { - "smithy.api#documentation": "

The predefined load metric specification.

" - } - }, - "CustomizedScalingMetricSpecification": { - "target": "com.amazonaws.autoscaling#PredictiveScalingCustomizedScalingMetric", - "traits": { - "smithy.api#documentation": "

The customized scaling metric specification.

" - } - }, - "CustomizedLoadMetricSpecification": { - "target": "com.amazonaws.autoscaling#PredictiveScalingCustomizedLoadMetric", - "traits": { - "smithy.api#documentation": "

The customized load metric specification.

" - } - }, - "CustomizedCapacityMetricSpecification": { - "target": "com.amazonaws.autoscaling#PredictiveScalingCustomizedCapacityMetric", - "traits": { - "smithy.api#documentation": "

The customized capacity metric specification.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This structure specifies the metrics and target utilization settings for a predictive\n scaling policy.

\n

You must specify either a metric pair, or a load metric and a scaling metric\n individually. Specifying a metric pair instead of individual metrics provides a simpler\n way to configure metrics for a scaling policy. You choose the metric pair, and the\n policy automatically knows the correct sum and average statistics to use for the load\n metric and the scaling metric.

\n

Example

\n \n

For information about using custom metrics with predictive scaling, see Advanced predictive scaling policy configurations using custom metrics in\n the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "com.amazonaws.autoscaling#PredictiveScalingMetricSpecifications": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#PredictiveScalingMetricSpecification" - } - }, - "com.amazonaws.autoscaling#PredictiveScalingMode": { - "type": "enum", - "members": { - "ForecastAndScale": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ForecastAndScale" - } - }, - "ForecastOnly": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ForecastOnly" - } - } - } - }, - "com.amazonaws.autoscaling#PredictiveScalingPredefinedLoadMetric": { - "type": "structure", - "members": { - "PredefinedMetricType": { - "target": "com.amazonaws.autoscaling#PredefinedLoadMetricType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The metric type.

", - "smithy.api#required": {} - } - }, - "ResourceLabel": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", - "traits": { - "smithy.api#documentation": "

A label that uniquely identifies a specific Application Load Balancer target group from which to determine\n the request count served by your Auto Scaling group. You can't specify a resource label unless\n the target group is attached to the Auto Scaling group.

\n

You create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:

\n

\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

\n

Where:

\n \n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a load metric for a predictive scaling policy.

\n

When returned in the output of DescribePolicies, it indicates that a\n predictive scaling policy uses individually specified load and scaling metrics instead\n of a metric pair.

" - } - }, - "com.amazonaws.autoscaling#PredictiveScalingPredefinedMetricPair": { - "type": "structure", - "members": { - "PredefinedMetricType": { - "target": "com.amazonaws.autoscaling#PredefinedMetricPairType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Indicates which metrics to use. There are two different types of metrics for each\n metric type: one is a load metric and one is a scaling metric. For example, if the\n metric type is ASGCPUUtilization, the Auto Scaling group's total CPU metric is used\n as the load metric, and the average CPU metric is used for the scaling metric.

", - "smithy.api#required": {} - } - }, - "ResourceLabel": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", - "traits": { - "smithy.api#documentation": "

A label that uniquely identifies a specific Application Load Balancer target group from which to determine\n the total and average request count served by your Auto Scaling group. You can't specify a\n resource label unless the target group is attached to the Auto Scaling group.

\n

You create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:

\n

\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

\n

Where:

\n \n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a metric pair for a predictive scaling policy.

" - } - }, - "com.amazonaws.autoscaling#PredictiveScalingPredefinedScalingMetric": { - "type": "structure", - "members": { - "PredefinedMetricType": { - "target": "com.amazonaws.autoscaling#PredefinedScalingMetricType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The metric type.

", - "smithy.api#required": {} - } - }, - "ResourceLabel": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", - "traits": { - "smithy.api#documentation": "

A label that uniquely identifies a specific Application Load Balancer target group from which to determine\n the average request count served by your Auto Scaling group. You can't specify a resource label\n unless the target group is attached to the Auto Scaling group.

\n

You create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:

\n

\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

\n

Where:

\n \n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a scaling metric for a predictive scaling policy.

\n

When returned in the output of DescribePolicies, it indicates that a\n predictive scaling policy uses individually specified load and scaling metrics instead\n of a metric pair.

" - } - }, - "com.amazonaws.autoscaling#PredictiveScalingSchedulingBufferTime": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.autoscaling#ProcessNames": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" - } - }, - "com.amazonaws.autoscaling#ProcessType": { - "type": "structure", - "members": { - "ProcessName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

One of the following processes:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a process type.

\n

For more information, see Types\n of processes in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "com.amazonaws.autoscaling#Processes": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#ProcessType" - } - }, - "com.amazonaws.autoscaling#ProcessesType": { - "type": "structure", - "members": { - "Processes": { - "target": "com.amazonaws.autoscaling#Processes", - "traits": { - "smithy.api#documentation": "

The names of the process types.

" - } - } - } - }, - "com.amazonaws.autoscaling#Progress": { - "type": "integer" - }, - "com.amazonaws.autoscaling#PropagateAtLaunch": { - "type": "boolean" - }, - "com.amazonaws.autoscaling#ProtectedFromScaleIn": { - "type": "boolean" - }, - "com.amazonaws.autoscaling#PutLifecycleHook": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#PutLifecycleHookType" - }, - "output": { - "target": "com.amazonaws.autoscaling#PutLifecycleHookAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#LimitExceededFault" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates or updates a lifecycle hook for the specified Auto Scaling group.

\n

Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance\n lifecycle, and then perform a custom action on instances when the corresponding\n lifecycle event occurs.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.

    \n
    2. \n
  2. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.

    \n
    3. \n
  3. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    4. \n
  4. \n

    \n Create the lifecycle hook. Specify whether the hook is\n used when the instances launch or terminate.\n

    \n
    5. \n
  5. \n

    If you need more time, record the lifecycle action heartbeat to keep the\n instance in a wait state using the RecordLifecycleActionHeartbeat API call.

    \n
    6. \n
  6. \n

    If you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.

    \n
    7. \n
\n

For more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.

\n

If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling\n group, the call fails.

\n

You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle\n hook, you can delete it by calling the DeleteLifecycleHook API.

", - "smithy.api#examples": [ - { - "title": "To create a launch lifecycle hook", - "documentation": "This example creates a lifecycle hook for instance launch.", + ], + "traits": { + "smithy.api#documentation": "

Starts an instance refresh.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group.\n This feature is helpful, for example, when you have a new AMI or a new user data script.\n You just need to create a new launch template that specifies the new AMI or user data\n script. Then start an instance refresh to immediately begin the process of updating\n instances in the group.

\n

If successful, the request's response contains a unique ID that you can use to track\n the progress of the instance refresh. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that\n have already run, call the DescribeInstanceRefreshes API. To cancel an\n instance refresh that is in progress, use the CancelInstanceRefresh\n API.

\n

An instance refresh might fail for several reasons, such as EC2 launch failures,\n misconfigured health checks, or not ignoring or allowing the termination of instances\n that are in Standby state or protected from scale in. You can monitor for\n failed EC2 launches using the scaling activities. To find the scaling activities, call\n the DescribeScalingActivities API.

\n

If you enable auto rollback, your Auto Scaling group will be rolled back automatically when\n the instance refresh fails. You can enable this feature before starting an instance\n refresh by specifying the AutoRollback property in the instance refresh\n preferences. Otherwise, to roll back an instance refresh before it finishes, use the\n RollbackInstanceRefresh API.

", + "smithy.api#examples": [ + { + "title": "To start an instance refresh", + "documentation": "This example starts an instance refresh for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "DesiredConfiguration": { + "LaunchTemplate": { + "LaunchTemplateName": "my-template-for-auto-scaling", + "Version": "$Latest" + } + }, + "Preferences": { + "AutoRollback": true, + "InstanceWarmup": 200, + "MinHealthyPercentage": 90, + "MaxHealthyPercentage": 120, + "AlarmSpecification": { + "Alarms": [ + "my-alarm" + ] + } + } + }, + "output": { + "InstanceRefreshId": "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b" + } + } + ] + } + }, + "com.amazonaws.autoscaling#StartInstanceRefreshAnswer": { + "type": "structure", + "members": { + "InstanceRefreshId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

A unique ID for tracking the progress of the instance refresh.

" + } + } + } + }, + "com.amazonaws.autoscaling#StartInstanceRefreshType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "Strategy": { + "target": "com.amazonaws.autoscaling#RefreshStrategy", + "traits": { + "smithy.api#documentation": "

The strategy to use for the instance refresh. The only valid value is\n Rolling.

" + } + }, + "DesiredConfiguration": { + "target": "com.amazonaws.autoscaling#DesiredConfiguration", + "traits": { + "smithy.api#documentation": "

The desired configuration. For example, the desired configuration can specify a new\n launch template or a new version of the current launch template.

\n

Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to\n reflect the new desired configuration.

\n \n

When you specify a new launch template or a new version of the current launch\n template for your desired configuration, consider enabling the\n SkipMatching property in preferences. If it's enabled, Amazon EC2 Auto Scaling\n skips replacing instances that already use the specified launch template and\n instance types. This can help you reduce the number of replacements that are\n required to apply updates.

\n " + } + }, + "Preferences": { + "target": "com.amazonaws.autoscaling#RefreshPreferences", + "traits": { + "smithy.api#documentation": "

Sets your preferences for the instance refresh so that it performs as expected when\n you start it. Includes the instance warmup time, the minimum and maximum healthy\n percentages, and the behaviors that you want Amazon EC2 Auto Scaling to use if instances that are in\n Standby state or protected from scale in are found. You can also choose\n to enable additional features, such as the following:

\n " + } + } + } + }, + "com.amazonaws.autoscaling#StepAdjustment": { + "type": "structure", + "members": { + "MetricIntervalLowerBound": { + "target": "com.amazonaws.autoscaling#MetricScale", + "traits": { + "smithy.api#documentation": "

The lower bound for the difference between the alarm threshold and the CloudWatch metric. If\n the metric value is above the breach threshold, the lower bound is inclusive (the metric\n must be greater than or equal to the threshold plus the lower bound). Otherwise, it is\n exclusive (the metric must be greater than the threshold plus the lower bound). A null\n value indicates negative infinity.

" + } + }, + "MetricIntervalUpperBound": { + "target": "com.amazonaws.autoscaling#MetricScale", + "traits": { + "smithy.api#documentation": "

The upper bound for the difference between the alarm threshold and the CloudWatch metric. If\n the metric value is above the breach threshold, the upper bound is exclusive (the metric\n must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the\n metric must be less than or equal to the threshold plus the upper bound). A null value\n indicates positive infinity.

\n

The upper bound must be greater than the lower bound.

" + } + }, + "ScalingAdjustment": { + "target": "com.amazonaws.autoscaling#PolicyIncrement", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current capacity.\n For exact capacity, you must specify a non-negative value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes information used to create a step adjustment for a step scaling\n policy.

\n

For the following examples, suppose that you have an alarm with a breach threshold of\n 50:

\n \n

There are a few rules for the step adjustments for your step policy:

\n \n

For more information, see Step\n adjustments in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "com.amazonaws.autoscaling#StepAdjustments": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#StepAdjustment" + } + }, + "com.amazonaws.autoscaling#SuspendProcesses": { + "type": "operation", "input": { - "LifecycleHookName": "my-launch-lifecycle-hook", - "HeartbeatTimeout": 300, - "AutoScalingGroupName": "my-auto-scaling-group", - "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING", - "DefaultResult": "CONTINUE" + "target": "com.amazonaws.autoscaling#ScalingProcessQuery" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + }, + { + "target": "com.amazonaws.autoscaling#ResourceInUseFault" + } + ], + "traits": { + "smithy.api#documentation": "

Suspends the specified auto scaling processes, or all processes, for the specified\n Auto Scaling group.

\n

If you suspend either the Launch or Terminate process types,\n it can prevent other process types from functioning properly. For more information, see\n Suspend and resume\n Amazon EC2 Auto Scaling processes in the Amazon EC2 Auto Scaling User Guide.

\n

To resume processes that have been suspended, call the ResumeProcesses API.

", + "smithy.api#examples": [ + { + "title": "To suspend Auto Scaling processes", + "documentation": "This example suspends the specified scaling process for the specified Auto Scaling group.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "ScalingProcesses": [ + "AlarmNotification" + ] + } + } + ] } - } - ] - } - }, - "com.amazonaws.autoscaling#PutLifecycleHookAnswer": { - "type": "structure", - "members": {} - }, - "com.amazonaws.autoscaling#PutLifecycleHookType": { - "type": "structure", - "members": { - "LifecycleHookName": { - "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the lifecycle hook.

", - "smithy.api#required": {} - } - }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "LifecycleTransition": { - "target": "com.amazonaws.autoscaling#LifecycleTransition", - "traits": { - "smithy.api#documentation": "

The lifecycle transition. For Auto Scaling groups, there are two major lifecycle\n transitions.

\n \n

Required for new lifecycle hooks, but optional when updating existing hooks.

" - } - }, - "RoleARN": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target.

\n

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required\n for new lifecycle hooks, but optional when updating existing hooks.

" - } - }, - "NotificationTargetARN": { - "target": "com.amazonaws.autoscaling#NotificationTargetResourceName", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify\n you when an instance is in a wait state for the lifecycle hook. You can specify either\n an Amazon SNS topic or an Amazon SQS queue.

\n

If you specify an empty string, this overrides the current ARN.

\n

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and\n an email key-value pair format when sending notifications to an Amazon SNS topic.

\n

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test\n messages contain the following additional key-value pair: \"Event\":\n \"autoscaling:TEST_NOTIFICATION\".

" - } - }, - "NotificationMetadata": { - "target": "com.amazonaws.autoscaling#AnyPrintableAsciiStringMaxLen4000", - "traits": { - "smithy.api#documentation": "

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to\n the notification target.

" - } - }, - "HeartbeatTimeout": { - "target": "com.amazonaws.autoscaling#HeartbeatTimeout", - "traits": { - "smithy.api#documentation": "

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The\n range is from 30 to 7200 seconds. The default value is\n 3600 seconds (1 hour).

" - } - }, - "DefaultResult": { - "target": "com.amazonaws.autoscaling#LifecycleActionResult", - "traits": { - "smithy.api#documentation": "

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an\n unexpected failure occurs. The default value is ABANDON.

\n

Valid values: CONTINUE | ABANDON\n

" - } - } - } - }, - "com.amazonaws.autoscaling#PutNotificationConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#PutNotificationConfigurationType" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#LimitExceededFault" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - }, - { - "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" - } - ], - "traits": { - "smithy.api#documentation": "

Configures an Auto Scaling group to send notifications when specified events take place.\n Subscribers to the specified topic can have messages delivered to an endpoint such as a\n web server or an email address.

\n

This configuration overwrites any existing configuration.

\n

For more information, see Amazon SNS\n notification options for Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.

\n

If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call\n fails.

", - "smithy.api#examples": [ - { - "title": "To add an Auto Scaling notification", - "documentation": "This example adds the specified notification to the specified Auto Scaling group.", + }, + "com.amazonaws.autoscaling#SuspendedProcess": { + "type": "structure", + "members": { + "ProcessName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the suspended process.

" + } + }, + "SuspensionReason": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The reason that the process was suspended.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an auto scaling process that has been suspended.

\n

For more information, see Types\n of processes in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "com.amazonaws.autoscaling#SuspendedProcesses": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#SuspendedProcess" + } + }, + "com.amazonaws.autoscaling#Tag": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The name of the Auto Scaling group.

" + } + }, + "ResourceType": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The type of resource. The only supported value is\n auto-scaling-group.

" + } + }, + "Key": { + "target": "com.amazonaws.autoscaling#TagKey", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The tag key.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.autoscaling#TagValue", + "traits": { + "smithy.api#documentation": "

The tag value.

" + } + }, + "PropagateAtLaunch": { + "target": "com.amazonaws.autoscaling#PropagateAtLaunch", + "traits": { + "smithy.api#documentation": "

Determines whether the tag is added to new instances as they are launched in the\n group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a tag for an Auto Scaling group.

" + } + }, + "com.amazonaws.autoscaling#TagDescription": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The name of the group.

" + } + }, + "ResourceType": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The type of resource. The only supported value is\n auto-scaling-group.

" + } + }, + "Key": { + "target": "com.amazonaws.autoscaling#TagKey", + "traits": { + "smithy.api#documentation": "

The tag key.

" + } + }, + "Value": { + "target": "com.amazonaws.autoscaling#TagValue", + "traits": { + "smithy.api#documentation": "

The tag value.

" + } + }, + "PropagateAtLaunch": { + "target": "com.amazonaws.autoscaling#PropagateAtLaunch", + "traits": { + "smithy.api#documentation": "

Determines whether the tag is added to new instances as they are launched in the\n group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a tag for an Auto Scaling group.

" + } + }, + "com.amazonaws.autoscaling#TagDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#TagDescription" + } + }, + "com.amazonaws.autoscaling#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.autoscaling#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.autoscaling#Tags": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#Tag" + } + }, + "com.amazonaws.autoscaling#TagsType": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.autoscaling#TagDescriptionList", + "traits": { + "smithy.api#documentation": "

One or more tags.

" + } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" + } + } + } + }, + "com.amazonaws.autoscaling#TargetGroupARNs": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen511" + } + }, + "com.amazonaws.autoscaling#TargetTrackingConfiguration": { + "type": "structure", + "members": { + "PredefinedMetricSpecification": { + "target": "com.amazonaws.autoscaling#PredefinedMetricSpecification", + "traits": { + "smithy.api#documentation": "

A predefined metric. You must specify either a predefined metric or a customized\n metric.

" + } + }, + "CustomizedMetricSpecification": { + "target": "com.amazonaws.autoscaling#CustomizedMetricSpecification", + "traits": { + "smithy.api#documentation": "

A customized metric. You must specify either a predefined metric or a customized\n metric.

" + } + }, + "TargetValue": { + "target": "com.amazonaws.autoscaling#MetricScale", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The target value for the metric.

\n \n

Some metrics are based on a count instead of a percentage, such as the request\n count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy\n specifies one of these metrics, specify the target utilization as the optimal\n average request or message count per instance during any one-minute interval.\n

\n ", + "smithy.api#required": {} + } + }, + "DisableScaleIn": { + "target": "com.amazonaws.autoscaling#DisableScaleIn", + "traits": { + "smithy.api#documentation": "

Indicates whether scaling in by the target tracking scaling policy is disabled. If\n scaling in is disabled, the target tracking scaling policy doesn't remove instances from\n the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from\n the Auto Scaling group. The default is false.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a target tracking scaling policy configuration to use with Amazon EC2 Auto Scaling.

" + } + }, + "com.amazonaws.autoscaling#TargetTrackingMetricDataQueries": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#TargetTrackingMetricDataQuery" + } + }, + "com.amazonaws.autoscaling#TargetTrackingMetricDataQuery": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A short name that identifies the object's results in the response. This name must be\n unique among all TargetTrackingMetricDataQuery objects specified for a\n single scaling policy. If you are performing math expressions on this set of data, this\n name represents that data and can serve as a variable in the mathematical expression.\n The valid characters are letters, numbers, and underscores. The first character must be\n a lowercase letter.

", + "smithy.api#required": {} + } + }, + "Expression": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen2047", + "traits": { + "smithy.api#documentation": "

The math expression to perform on the returned data, if this object is performing a\n math expression. This expression can use the Id of the other metrics to\n refer to those metrics, and can also use the Id of other expressions to use\n the result of those expressions.

\n

Conditional: Within each TargetTrackingMetricDataQuery object, you must\n specify either Expression or MetricStat, but not both.

" + } + }, + "MetricStat": { + "target": "com.amazonaws.autoscaling#TargetTrackingMetricStat", + "traits": { + "smithy.api#documentation": "

Information about the metric data to return.

\n

Conditional: Within each TargetTrackingMetricDataQuery object, you must\n specify either Expression or MetricStat, but not both.

" + } + }, + "Label": { + "target": "com.amazonaws.autoscaling#XmlStringMetricLabel", + "traits": { + "smithy.api#documentation": "

A human-readable label for this metric or expression. This is especially useful if\n this is a math expression, so that you know what the value represents.

" + } + }, + "ReturnData": { + "target": "com.amazonaws.autoscaling#ReturnData", + "traits": { + "smithy.api#documentation": "

Indicates whether to return the timestamps and raw data values of this metric.

\n

If you use any math expressions, specify true for this value for only the\n final math expression that the metric specification is based on. You must specify\n false for ReturnData for all the other metrics and\n expressions used in the metric specification.

\n

If you are only retrieving metrics and not performing any math expressions, do not\n specify anything for ReturnData. This sets it to its default\n (true).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metric data to return. Also defines whether this call is returning data for one\n metric only, or whether it is performing a math expression on the values of returned\n metric statistics to create a new time series. A time series is a series of data points,\n each of which is associated with a timestamp.

" + } + }, + "com.amazonaws.autoscaling#TargetTrackingMetricStat": { + "type": "structure", + "members": { + "Metric": { + "target": "com.amazonaws.autoscaling#Metric", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The metric to use.

", + "smithy.api#required": {} + } + }, + "Stat": { + "target": "com.amazonaws.autoscaling#XmlStringMetricStat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The statistic to return. It can include any CloudWatch statistic or extended statistic. For\n a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.

\n

The most commonly used metric for scaling is Average.

", + "smithy.api#required": {} + } + }, + "Unit": { + "target": "com.amazonaws.autoscaling#MetricUnit", + "traits": { + "smithy.api#documentation": "

The unit to use for the returned data points. For a complete list of the units that\n CloudWatch supports, see the MetricDatum\n data type in the Amazon CloudWatch API Reference.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This structure defines the CloudWatch metric to return, along with the statistic and\n unit.

\n

For more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts in the Amazon CloudWatch User Guide.

" + } + }, + "com.amazonaws.autoscaling#TerminateInstanceInAutoScalingGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.autoscaling#TerminateInstanceInAutoScalingGroupType" + }, + "output": { + "target": "com.amazonaws.autoscaling#ActivityType" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + }, + { + "target": "com.amazonaws.autoscaling#ScalingActivityInProgressFault" + } + ], + "traits": { + "smithy.api#documentation": "

Terminates the specified instance and optionally adjusts the desired group size. This\n operation cannot be called on instances in a warm pool.

\n

This call simply makes a termination request. The instance is not terminated\n immediately. When an instance is terminated, the instance status changes to\n terminated. You can't connect to or start an instance after you've\n terminated it.

\n

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are terminated.

\n

By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you\n decrement the desired capacity, your Auto Scaling group can become unbalanced between\n Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might\n terminate instances in other zones. For more information, see Manual\n scaling in the Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To terminate an instance in an Auto Scaling group", + "documentation": "This example terminates the specified instance from the specified Auto Scaling group without updating the size of the group. Auto Scaling launches a replacement instance after the specified instance terminates.", + "input": { + "InstanceId": "i-93633f9b", + "ShouldDecrementDesiredCapacity": false + } + } + ] + } + }, + "com.amazonaws.autoscaling#TerminateInstanceInAutoScalingGroupType": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {} + } + }, + "ShouldDecrementDesiredCapacity": { + "target": "com.amazonaws.autoscaling#ShouldDecrementDesiredCapacity", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates whether terminating the instance also decrements the size of the Auto Scaling\n group.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#TerminationPolicies": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen1600" + } + }, + "com.amazonaws.autoscaling#TimestampType": { + "type": "timestamp" + }, + "com.amazonaws.autoscaling#TotalLocalStorageGBRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.autoscaling#NullablePositiveDouble", + "traits": { + "smithy.api#documentation": "

The storage minimum in GB.

" + } + }, + "Max": { + "target": "com.amazonaws.autoscaling#NullablePositiveDouble", + "traits": { + "smithy.api#documentation": "

The storage maximum in GB.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the minimum and maximum for the TotalLocalStorageGB object when\n you specify InstanceRequirements for an Auto Scaling group.

" + } + }, + "com.amazonaws.autoscaling#TrafficSourceIdentifier": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen511", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Identifies the traffic source.

\n

For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will be the Amazon Resource Name\n (ARN) for a target group in this account and Region. For Classic Load Balancers, this will be the name\n of the Classic Load Balancer in this account and Region.

\n

For example:

\n \n

To get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer, or the name of a\n Classic Load Balancer, use the Elastic Load Balancing DescribeTargetGroups and DescribeLoadBalancers API operations.

\n

To get the ARN of a target group for VPC Lattice, use the VPC Lattice GetTargetGroup API operation.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen511", + "traits": { + "smithy.api#documentation": "

Provides additional context for the value of Identifier.

\n

The following lists the valid values:

\n \n

Required if the identifier is the name of a Classic Load Balancer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Identifying information for a traffic source.

" + } + }, + "com.amazonaws.autoscaling#TrafficSourceState": { + "type": "structure", + "members": { + "TrafficSource": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen511", + "traits": { + "smithy.api#deprecated": { + "message": "TrafficSource has been replaced by Identifier" + }, + "smithy.api#documentation": "

This is replaced by Identifier.

" + } + }, + "State": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

Describes the current state of a traffic source.

\n

The state values are as follows:

\n " + } + }, + "Identifier": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen511", + "traits": { + "smithy.api#documentation": "

The unique identifier of the traffic source.

" + } + }, + "Type": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen511", + "traits": { + "smithy.api#documentation": "

Provides additional context for the value of Identifier.

\n

The following lists the valid values:

\n \n

Required if the identifier is the name of a Classic Load Balancer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the state of a traffic source.

" + } + }, + "com.amazonaws.autoscaling#TrafficSourceStates": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#TrafficSourceState" + } + }, + "com.amazonaws.autoscaling#TrafficSources": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#TrafficSourceIdentifier" + } + }, + "com.amazonaws.autoscaling#UpdateAutoScalingGroup": { + "type": "operation", "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic", - "NotificationTypes": ["autoscaling:TEST_NOTIFICATION"] + "target": "com.amazonaws.autoscaling#UpdateAutoScalingGroupType" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.autoscaling#ResourceContentionFault" + }, + { + "target": "com.amazonaws.autoscaling#ScalingActivityInProgressFault" + }, + { + "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" + } + ], + "traits": { + "smithy.api#documentation": "

\n We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n

\n

Updates the configuration for the specified Auto Scaling group.

\n

To update an Auto Scaling group, specify the name of the group and the property that you want\n to change. Any properties that you don't specify are not changed by this update request.\n The new settings take effect on any scaling activities after this call returns.\n

\n

If you associate a new launch configuration or template with an Auto Scaling group, all new\n instances will get the updated configuration. Existing instances continue to run with\n the configuration that they were originally launched with. When you update a group to\n specify a mixed instances policy instead of a launch configuration or template, existing\n instances may be replaced to match the new purchasing options that you specified in the\n policy. For example, if the group currently has 100% On-Demand capacity and the policy\n specifies 50% Spot capacity, this means that half of your instances will be gradually\n terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches\n new instances before terminating the old ones, so that updating your group does not\n compromise the performance or availability of your application.

\n

Note the following about changing DesiredCapacity, MaxSize,\n or MinSize:

\n \n

To see which properties have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling\n group, call the DescribePolicies API. If the group has scaling\n policies, you can update them by calling the PutScalingPolicy\n API.

", + "smithy.api#examples": [ + { + "title": "To update an Auto Scaling group", + "documentation": "This example updates multiple properties at the same time.", + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LaunchTemplate": { + "LaunchTemplateName": "my-template-for-auto-scaling", + "Version": "2" + }, + "MinSize": 1, + "MaxSize": 5, + "NewInstancesProtectedFromScaleIn": true + } + } + ] + } + }, + "com.amazonaws.autoscaling#UpdateAutoScalingGroupType": { + "type": "structure", + "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the Auto Scaling group.

", + "smithy.api#required": {} + } + }, + "LaunchConfigurationName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of the launch configuration. If you specify\n LaunchConfigurationName in your update request, you can't specify\n LaunchTemplate or MixedInstancesPolicy.

" + } + }, + "LaunchTemplate": { + "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", + "traits": { + "smithy.api#documentation": "

The launch template and version to use to specify the updates. If you specify\n LaunchTemplate in your update request, you can't specify\n LaunchConfigurationName or MixedInstancesPolicy.

" + } + }, + "MixedInstancesPolicy": { + "target": "com.amazonaws.autoscaling#MixedInstancesPolicy", + "traits": { + "smithy.api#documentation": "

The mixed instances policy. For more information, see Auto Scaling\n groups with multiple instance types and purchase options in the\n Amazon EC2 Auto Scaling User Guide.

" + } + }, + "MinSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", + "traits": { + "smithy.api#documentation": "

The minimum size of the Auto Scaling group.

" + } + }, + "MaxSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", + "traits": { + "smithy.api#documentation": "

The maximum size of the Auto Scaling group.

\n \n

With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to\n go above MaxSize to meet your capacity requirements. In this event,\n Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance\n weight (weights that define how many units each instance contributes to the desired\n capacity of the group).

\n " + } + }, + "DesiredCapacity": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", + "traits": { + "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group after this operation\n completes and the capacity it attempts to maintain. This number must be greater than or\n equal to the minimum size of the group and less than or equal to the maximum size of the\n group.

" + } + }, + "DefaultCooldown": { + "target": "com.amazonaws.autoscaling#Cooldown", + "traits": { + "smithy.api#documentation": "

\n Only needed if you use simple scaling policies.\n

\n

The amount of time, in seconds, between one scaling activity ending and another one\n starting due to simple scaling policies. For more information, see Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.autoscaling#AvailabilityZones", + "traits": { + "smithy.api#documentation": "

One or more Availability Zones for the group.

" + } + }, + "HealthCheckType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", + "traits": { + "smithy.api#documentation": "

A comma-separated value string of one or more health check types.

\n

The valid values are EC2, EBS, ELB, and\n VPC_LATTICE. EC2 is the default health check and cannot be\n disabled. For more information, see Health checks\n for instances in an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n

Only specify EC2 if you must clear a value that was previously\n set.

" + } + }, + "HealthCheckGracePeriod": { + "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n health check. This is useful if your instances do not immediately pass their health\n checks after they enter the InService state. For more information, see\n Set the health check\n grace period for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

" + } + }, + "PlacementGroup": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The name of an existing placement group into which to launch your instances. For more\n information, see Placement groups in the\n Amazon EC2 User Guide for Linux Instances.

\n \n

A cluster placement group is a logical grouping of instances\n within a single Availability Zone. You cannot specify multiple Availability Zones\n and a cluster placement group.

\n " + } + }, + "VPCZoneIdentifier": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen5000", + "traits": { + "smithy.api#documentation": "

A comma-separated list of subnet IDs for a virtual private cloud (VPC). If you specify\n VPCZoneIdentifier with AvailabilityZones, the subnets that\n you specify must reside in those Availability Zones.

" + } + }, + "TerminationPolicies": { + "target": "com.amazonaws.autoscaling#TerminationPolicies", + "traits": { + "smithy.api#documentation": "

A policy or a list of policies that are used to select the instances to terminate. The\n policies are executed in the order that you list them. For more information, see Configure\n termination policies for Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.

\n

Valid values: Default | AllocationStrategy |\n ClosestToNextInstanceHour | NewestInstance |\n OldestInstance | OldestLaunchConfiguration |\n OldestLaunchTemplate |\n arn:aws:lambda:region:account-id:function:my-function:my-alias\n

" + } + }, + "NewInstancesProtectedFromScaleIn": { + "target": "com.amazonaws.autoscaling#InstanceProtected", + "traits": { + "smithy.api#documentation": "

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in. For more information about preventing instances from terminating on\n scale in, see Use\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.

" + } + }, + "ServiceLinkedRoleARN": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other Amazon Web Services on your behalf. For more information, see Service-linked\n roles in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "MaxInstanceLifetime": { + "target": "com.amazonaws.autoscaling#MaxInstanceLifetime", + "traits": { + "smithy.api#documentation": "

The maximum amount of time, in seconds, that an instance can be in service. The\n default is null. If specified, the value must be either 0 or a number equal to or\n greater than 86,400 seconds (1 day). To clear a previously set value, specify a new\n value of 0. For more information, see Replacing Auto Scaling\n instances based on maximum instance lifetime in the\n Amazon EC2 Auto Scaling User Guide.

" + } + }, + "CapacityRebalance": { + "target": "com.amazonaws.autoscaling#CapacityRebalanceEnabled", + "traits": { + "smithy.api#documentation": "

Enables or disables Capacity Rebalancing. For more information, see Use Capacity\n Rebalancing to handle Amazon EC2 Spot Interruptions in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "Context": { + "target": "com.amazonaws.autoscaling#Context", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } + }, + "DesiredCapacityType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only. For more information, see Create a mixed instances group using attribute-based instance type\n selection in the Amazon EC2 Auto Scaling User Guide.

\n

By default, Amazon EC2 Auto Scaling specifies units, which translates into number of\n instances.

\n

Valid values: units | vcpu | memory-mib\n

" + } + }, + "DefaultInstanceWarmup": { + "target": "com.amazonaws.autoscaling#DefaultInstanceWarmup", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, until a new instance is considered to have finished\n initializing and resource consumption to become stable after it enters the\n InService state.

\n

During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an\n instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the\n warm-up period before aggregating the metrics for new instances with existing instances\n in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage\n data. For more information, see Set\n the default instance warmup for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n \n

To manage various warm-up settings at the group level, we recommend that you set\n the default instance warmup, even if it is set to 0 seconds. To\n remove a value that you previously set, include the property but specify\n -1 for the value. However, we strongly recommend keeping the\n default instance warmup enabled by specifying a value of 0 or other\n nominal value.

\n " + } + }, + "InstanceMaintenancePolicy": { + "target": "com.amazonaws.autoscaling#InstanceMaintenancePolicy", + "traits": { + "smithy.api#documentation": "

An instance maintenance policy. For more information, see Set instance maintenance policy in the\n Amazon EC2 Auto Scaling User Guide.

" + } + } + } + }, + "com.amazonaws.autoscaling#VCpuCountRequest": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.autoscaling#NullablePositiveInteger", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The minimum number of vCPUs.

", + "smithy.api#required": {} + } + }, + "Max": { + "target": "com.amazonaws.autoscaling#NullablePositiveInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of vCPUs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the minimum and maximum for the VCpuCount object when you\n specify InstanceRequirements for an Auto Scaling group.

" } - } - ] - } - }, - "com.amazonaws.autoscaling#PutNotificationConfigurationType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "TopicARN": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SNS topic.

", - "smithy.api#required": {} - } - }, - "NotificationTypes": { - "target": "com.amazonaws.autoscaling#AutoScalingNotificationTypes", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of event that causes the notification to be sent. To query the notification\n types supported by Amazon EC2 Auto Scaling, call the DescribeAutoScalingNotificationTypes API.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#PutScalingPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#PutScalingPolicyType" - }, - "output": { - "target": "com.amazonaws.autoscaling#PolicyARNType" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#LimitExceededFault" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - }, - { - "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" - } - ], - "traits": { - "smithy.api#documentation": "

Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to\n scale an Auto Scaling group based on configurable metrics. If no policies are defined, the\n dynamic scaling and predictive scaling features are not used.

\n

For more information about using dynamic scaling, see Target tracking\n scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.

\n

For more information about using predictive scaling, see Predictive\n scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy,\n you can delete it by calling the DeletePolicy API.

", - "smithy.api#examples": [ - { - "title": "To add a scaling policy to an Auto Scaling group", - "documentation": "This example adds the specified policy to the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "PolicyName": "alb1000-target-tracking-scaling-policy", - "PolicyType": "TargetTrackingScaling", - "TargetTrackingConfiguration": { - "TargetValue": 1000.0, - "PredefinedMetricSpecification": { - "PredefinedMetricType": "ALBRequestCountPerTarget", - "ResourceLabel": "app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff" + }, + "com.amazonaws.autoscaling#Values": { + "type": "list", + "member": { + "target": "com.amazonaws.autoscaling#XmlString" + } + }, + "com.amazonaws.autoscaling#WarmPoolConfiguration": { + "type": "structure", + "members": { + "MaxGroupPreparedCapacity": { + "target": "com.amazonaws.autoscaling#MaxGroupPreparedCapacity", + "traits": { + "smithy.api#documentation": "

The maximum number of instances that are allowed to be in the warm pool or in any\n state except Terminated for the Auto Scaling group.

" + } + }, + "MinSize": { + "target": "com.amazonaws.autoscaling#WarmPoolMinSize", + "traits": { + "smithy.api#documentation": "

The minimum number of instances to maintain in the warm pool.

" + } + }, + "PoolState": { + "target": "com.amazonaws.autoscaling#WarmPoolState", + "traits": { + "smithy.api#documentation": "

The instance state to transition to after the lifecycle actions are complete.

" + } + }, + "Status": { + "target": "com.amazonaws.autoscaling#WarmPoolStatus", + "traits": { + "smithy.api#documentation": "

The status of a warm pool that is marked for deletion.

" + } + }, + "InstanceReusePolicy": { + "target": "com.amazonaws.autoscaling#InstanceReusePolicy", + "traits": { + "smithy.api#documentation": "

The instance reuse policy.

" + } } - } }, - "output": { - "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:228f02c2-c665-4bfd-aaac-8b04080bea3c:autoScalingGroupName/my-auto-scaling-group:policyName/alb1000-target-tracking-scaling-policy", - "Alarms": [ - { - "AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e", - "AlarmName": "TargetTracking-my-asg-AlarmHigh-fc0e4183-23ac-497e-9992-691c9980c38e" + "traits": { + "smithy.api#documentation": "

Describes a warm pool configuration.

" + } + }, + "com.amazonaws.autoscaling#WarmPoolMinSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.autoscaling#WarmPoolSize": { + "type": "integer" + }, + "com.amazonaws.autoscaling#WarmPoolState": { + "type": "enum", + "members": { + "Stopped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } }, - { - "AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2", - "AlarmName": "TargetTracking-my-asg-AlarmLow-61a39305-ed0c-47af-bd9e-471a352ee1a2" + "Running": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Running" + } + }, + "Hibernated": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Hibernated" + } } - ] } - } - ] - } - }, - "com.amazonaws.autoscaling#PutScalingPolicyType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "PolicyName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the policy.

", - "smithy.api#required": {} - } - }, - "PolicyType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", - "traits": { - "smithy.api#documentation": "

One of the following policy types:

\n " - } - }, - "AdjustmentType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

Specifies how the scaling adjustment is interpreted (for example, an absolute number\n or a percentage). The valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.

\n

Required if the policy type is StepScaling or SimpleScaling.\n For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "MinAdjustmentStep": { - "target": "com.amazonaws.autoscaling#MinAdjustmentStep", - "traits": { - "smithy.api#documentation": "

Available for backward compatibility. Use MinAdjustmentMagnitude\n instead.

" - } - }, - "MinAdjustmentMagnitude": { - "target": "com.amazonaws.autoscaling#MinAdjustmentMagnitude", - "traits": { - "smithy.api#documentation": "

The minimum value to scale by when the adjustment type is\n PercentChangeInCapacity. For example, suppose that you create a step\n scaling policy to scale out an Auto Scaling group by 25 percent and you specify a\n MinAdjustmentMagnitude of 2. If the group has 4 instances and the\n scaling policy is performed, 25 percent of 4 is 1. However, because you specified a\n MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2\n instances.

\n

Valid only if the policy type is StepScaling or\n SimpleScaling. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User\n Guide.

\n \n

Some Auto Scaling groups use instance weights. In this case, set the\n MinAdjustmentMagnitude to a value that is at least as large as your\n largest instance weight.

\n " - } - }, - "ScalingAdjustment": { - "target": "com.amazonaws.autoscaling#PolicyIncrement", - "traits": { - "smithy.api#documentation": "

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current capacity.\n For exact capacity, you must specify a non-negative value.

\n

Required if the policy type is SimpleScaling. (Not used with any other\n policy type.)

" - } - }, - "Cooldown": { - "target": "com.amazonaws.autoscaling#Cooldown", - "traits": { - "smithy.api#documentation": "

A cooldown period, in seconds, that applies to a specific simple scaling policy. When\n a cooldown period is specified here, it overrides the default cooldown.

\n

Valid only if the policy type is SimpleScaling. For more information, see\n Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

Default: None

" - } - }, - "MetricAggregationType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", - "traits": { - "smithy.api#documentation": "

The aggregation type for the CloudWatch metrics. The valid values are Minimum,\n Maximum, and Average. If the aggregation type is null, the\n value is treated as Average.

\n

Valid only if the policy type is StepScaling.

" - } - }, - "StepAdjustments": { - "target": "com.amazonaws.autoscaling#StepAdjustments", - "traits": { - "smithy.api#documentation": "

A set of adjustments that enable you to scale based on the size of the alarm\n breach.

\n

Required if the policy type is StepScaling. (Not used with any other\n policy type.)

" - } - }, - "EstimatedInstanceWarmup": { - "target": "com.amazonaws.autoscaling#EstimatedInstanceWarmup", - "traits": { - "smithy.api#documentation": "

\n Not needed if the default instance warmup is defined for the\n group.\n

\n

The estimated time, in seconds, until a newly launched instance can contribute to the\n CloudWatch metrics. This warm-up period applies to instances launched due to a specific target\n tracking or step scaling policy. When a warm-up period is specified here, it overrides\n the default instance warmup.

\n

Valid only if the policy type is TargetTrackingScaling or\n StepScaling.

\n \n

The default is to use the value for the default instance warmup defined for the\n group. If default instance warmup is null, then EstimatedInstanceWarmup\n falls back to the value of default cooldown.

\n " - } - }, - "TargetTrackingConfiguration": { - "target": "com.amazonaws.autoscaling#TargetTrackingConfiguration", - "traits": { - "smithy.api#documentation": "

A target tracking scaling policy. Provides support for predefined or custom\n metrics.

\n

The following predefined metrics are available:

\n \n

If you specify ALBRequestCountPerTarget for the metric, you must specify\n the ResourceLabel property with the\n PredefinedMetricSpecification.

\n

For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API\n Reference.

\n

Required if the policy type is TargetTrackingScaling.

" - } - }, - "Enabled": { - "target": "com.amazonaws.autoscaling#ScalingPolicyEnabled", - "traits": { - "smithy.api#documentation": "

Indicates whether the scaling policy is enabled or disabled. The default is enabled.\n For more information, see Disable a\n scaling policy for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

" - } - }, - "PredictiveScalingConfiguration": { - "target": "com.amazonaws.autoscaling#PredictiveScalingConfiguration", - "traits": { - "smithy.api#documentation": "

A predictive scaling policy. Provides support for predefined and custom\n metrics.

\n

Predefined metrics include CPU utilization, network in/out, and the Application Load\n Balancer request count.

\n

For more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API\n Reference.

\n

Required if the policy type is PredictiveScaling.

" - } - } - } - }, - "com.amazonaws.autoscaling#PutScheduledUpdateGroupAction": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#PutScheduledUpdateGroupActionType" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#AlreadyExistsFault" - }, - { - "target": "com.amazonaws.autoscaling#LimitExceededFault" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates or updates a scheduled scaling action for an Auto Scaling group.

\n

For more information, see Scheduled scaling in the\n Amazon EC2 Auto Scaling User Guide.

\n

You can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a\n scheduled action, you can delete it by calling the DeleteScheduledAction API.

\n

If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error\n message.

", - "smithy.api#examples": [ - { - "title": "To add a scheduled action to an Auto Scaling group", - "documentation": "This example adds the specified scheduled action to the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "ScheduledActionName": "my-scheduled-action", - "StartTime": "2014-05-12T08:00:00Z", - "EndTime": "2014-05-12T08:00:00Z", - "MinSize": 2, - "MaxSize": 6, - "DesiredCapacity": 4 - } - } - ] - } - }, - "com.amazonaws.autoscaling#PutScheduledUpdateGroupActionType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "ScheduledActionName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of this scaling action.

", - "smithy.api#required": {} - } - }, - "Time": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

This property is no longer used.

" - } - }, - "StartTime": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT\n only and in quotes (for example, \"2021-06-01T00:00:00Z\").

\n

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs\n the action at this time, and then performs the action based on the specified\n recurrence.

" - } - }, - "EndTime": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The date and time for the recurring schedule to end, in UTC. For example,\n \"2021-06-01T00:00:00Z\".

" - } - }, - "Recurrence": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The recurring schedule for this action. This format consists of five fields separated\n by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value\n must be in quotes (for example, \"30 0 1 1,6,12 *\"). For more information\n about this format, see Crontab.

\n

When StartTime and EndTime are specified with\n Recurrence, they form the boundaries of when the recurring action\n starts and stops.

\n

Cron expressions use Universal Coordinated Time (UTC) by default.

" - } - }, - "MinSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", - "traits": { - "smithy.api#documentation": "

The minimum size of the Auto Scaling group.

" - } - }, - "MaxSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", - "traits": { - "smithy.api#documentation": "

The maximum size of the Auto Scaling group.

" - } - }, - "DesiredCapacity": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", - "traits": { - "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group after the scheduled\n action runs and the capacity it attempts to maintain. It can scale beyond this capacity\n if you add more scaling conditions.

\n \n

You must specify at least one of the following properties: MaxSize,\n MinSize, or DesiredCapacity.

\n " - } - }, - "TimeZone": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

Specifies the time zone for a cron expression. If a time zone is not provided, UTC is\n used by default.

\n

Valid values are the canonical names of the IANA time zones, derived from the IANA\n Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti). For\n more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

" - } - } - } - }, - "com.amazonaws.autoscaling#PutWarmPool": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#PutWarmPoolType" - }, - "output": { - "target": "com.amazonaws.autoscaling#PutWarmPoolAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#LimitExceededFault" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of\n pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your\n application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new\n desired capacity.

\n

This operation must be called from the Region in which the Auto Scaling group was\n created.

\n

You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the\n DeleteWarmPool API.

\n

For more information, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To create a warm pool for an Auto Scaling group", - "documentation": "This example creates a warm pool for the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "MinSize": 30, - "PoolState": "Hibernated", - "InstanceReusePolicy": { - "ReuseOnScaleIn": true - } - } - } - ] - } - }, - "com.amazonaws.autoscaling#PutWarmPoolAnswer": { - "type": "structure", - "members": {} - }, - "com.amazonaws.autoscaling#PutWarmPoolType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "MaxGroupPreparedCapacity": { - "target": "com.amazonaws.autoscaling#MaxGroupPreparedCapacity", - "traits": { - "smithy.api#documentation": "

Specifies the maximum number of instances that are allowed to be in the warm pool or\n in any state except Terminated for the Auto Scaling group. This is an optional\n property. Specify it only if you do not want the warm pool size to be determined by the\n difference between the group's maximum capacity and its desired capacity.

\n \n

If a value for MaxGroupPreparedCapacity is not specified, Amazon EC2 Auto Scaling\n launches and maintains the difference between the group's maximum capacity and its\n desired capacity. If you specify a value for MaxGroupPreparedCapacity,\n Amazon EC2 Auto Scaling uses the difference between the MaxGroupPreparedCapacity and\n the desired capacity instead.

\n

The size of the warm pool is dynamic. Only when\n MaxGroupPreparedCapacity and MinSize are set to the\n same value does the warm pool have an absolute size.

\n \n

If the desired capacity of the Auto Scaling group is higher than the\n MaxGroupPreparedCapacity, the capacity of the warm pool is 0, unless\n you specify a value for MinSize. To remove a value that you previously set,\n include the property but specify -1 for the value.

" - } - }, - "MinSize": { - "target": "com.amazonaws.autoscaling#WarmPoolMinSize", - "traits": { - "smithy.api#documentation": "

Specifies the minimum number of instances to maintain in the warm pool. This helps you\n to ensure that there is always a certain number of warmed instances available to handle\n traffic spikes. Defaults to 0 if not specified.

" - } - }, - "PoolState": { - "target": "com.amazonaws.autoscaling#WarmPoolState", - "traits": { - "smithy.api#documentation": "

Sets the instance state to transition to after the lifecycle actions are complete.\n Default is Stopped.

" - } - }, - "InstanceReusePolicy": { - "target": "com.amazonaws.autoscaling#InstanceReusePolicy", - "traits": { - "smithy.api#documentation": "

Indicates whether instances in the Auto Scaling group can be returned to the warm pool on\n scale in. The default is to terminate instances in the Auto Scaling group when the group scales\n in.

" - } - } - } - }, - "com.amazonaws.autoscaling#RecordLifecycleActionHeartbeat": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#RecordLifecycleActionHeartbeatType" - }, - "output": { - "target": "com.amazonaws.autoscaling#RecordLifecycleActionHeartbeatAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Records a heartbeat for the lifecycle action associated with the specified token or\n instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.

    \n
    2. \n
  2. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.

    \n
    3. \n
  3. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    4. \n
  4. \n

    Create the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.

    \n
    5. \n
  5. \n

    \n If you need more time, record the lifecycle action\n heartbeat to keep the instance in a wait state.\n

    \n
    6. \n
  6. \n

    If you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.

    \n
    7. \n
\n

For more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To record a lifecycle action heartbeat", - "documentation": "This example records a lifecycle action heartbeat to keep the instance in a pending state.", - "input": { - "LifecycleHookName": "my-lifecycle-hook", - "AutoScalingGroupName": "my-auto-scaling-group", - "LifecycleActionToken": "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635" + }, + "com.amazonaws.autoscaling#WarmPoolStatus": { + "type": "enum", + "members": { + "PendingDelete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingDelete" + } + } } - } - ] - } - }, - "com.amazonaws.autoscaling#RecordLifecycleActionHeartbeatAnswer": { - "type": "structure", - "members": {} - }, - "com.amazonaws.autoscaling#RecordLifecycleActionHeartbeatType": { - "type": "structure", - "members": { - "LifecycleHookName": { - "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the lifecycle hook.

", - "smithy.api#required": {} - } - }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "LifecycleActionToken": { - "target": "com.amazonaws.autoscaling#LifecycleActionToken", - "traits": { - "smithy.api#documentation": "

A token that uniquely identifies a specific lifecycle action associated with an\n instance. Amazon EC2 Auto Scaling sends this token to the notification target that you specified when\n you created the lifecycle hook.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", - "traits": { - "smithy.api#documentation": "

The ID of the instance.

" - } - } - } - }, - "com.amazonaws.autoscaling#RefreshInstanceWarmup": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.autoscaling#RefreshPreferences": { - "type": "structure", - "members": { - "MinHealthyPercentage": { - "target": "com.amazonaws.autoscaling#IntPercent", - "traits": { - "smithy.api#documentation": "

Specifies the minimum percentage of the group to keep in service, healthy, and ready\n to use to support your workload to allow the operation to continue. The value is\n expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 0 to\n 100.

\n

If you do not specify this property, the default is 90 percent, or the percentage set\n in the instance maintenance policy for the Auto Scaling group, if defined.

" - } - }, - "InstanceWarmup": { - "target": "com.amazonaws.autoscaling#RefreshInstanceWarmup", - "traits": { - "smithy.api#documentation": "

A time period, in seconds, during which an instance refresh waits before moving on to\n replacing the next instance after a new instance enters the InService\n state.

\n

This property is not required for normal usage. Instead, use the\n DefaultInstanceWarmup property of the Auto Scaling group. The\n InstanceWarmup and DefaultInstanceWarmup properties work\n the same way. Only specify this property if you must override the\n DefaultInstanceWarmup property.

\n

If you do not specify this property, the instance warmup by default is the value of\n the DefaultInstanceWarmup property, if defined (which is recommended in all\n cases), or the HealthCheckGracePeriod property otherwise.

" - } - }, - "CheckpointPercentages": { - "target": "com.amazonaws.autoscaling#CheckpointPercentages", - "traits": { - "smithy.api#documentation": "

(Optional) Threshold values for each checkpoint in ascending order. Each number must\n be unique. To replace all instances in the Auto Scaling group, the last number in the array must\n be 100.

\n

For usage examples, see Add checkpoints to an instance refresh in the\n Amazon EC2 Auto Scaling User Guide.

" - } - }, - "CheckpointDelay": { - "target": "com.amazonaws.autoscaling#CheckpointDelay", - "traits": { - "smithy.api#documentation": "

(Optional) The amount of time, in seconds, to wait after a checkpoint before\n continuing. This property is optional, but if you specify a value for it, you must also\n specify a value for CheckpointPercentages. If you specify a value for\n CheckpointPercentages and not for CheckpointDelay, the\n CheckpointDelay defaults to 3600 (1 hour).

" - } - }, - "SkipMatching": { - "target": "com.amazonaws.autoscaling#SkipMatching", - "traits": { - "smithy.api#documentation": "

(Optional) Indicates whether skip matching is enabled. If enabled (true),\n then Amazon EC2 Auto Scaling skips replacing instances that match the desired configuration. If no\n desired configuration is specified, then it skips replacing instances that have the same\n launch template and instance types that the Auto Scaling group was using before the start of the\n instance refresh. The default is false.

\n

For more information, see Use an\n instance refresh with skip matching in the\n Amazon EC2 Auto Scaling User Guide.

" - } - }, - "AutoRollback": { - "target": "com.amazonaws.autoscaling#AutoRollback", - "traits": { - "smithy.api#documentation": "

(Optional) Indicates whether to roll back the Auto Scaling group to its previous configuration\n if the instance refresh fails or a CloudWatch alarm threshold is met. The default is\n false.

\n

A rollback is not supported in the following situations:

\n \n

For more information, see Undo changes with a\n rollback in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "ScaleInProtectedInstances": { - "target": "com.amazonaws.autoscaling#ScaleInProtectedInstances", - "traits": { - "smithy.api#documentation": "

Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances protected from scale in\n are found.

\n

The following lists the valid values:

\n
\n
Refresh
\n
\n

Amazon EC2 Auto Scaling replaces instances that are protected from scale in.

\n
\n
Ignore
\n
\n

Amazon EC2 Auto Scaling ignores instances that are protected from scale in and continues\n to replace instances that are not protected.

\n
\n
Wait (default)
\n
\n

Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. Otherwise,\n the instance refresh will fail.

\n
\n
" - } - }, - "StandbyInstances": { - "target": "com.amazonaws.autoscaling#StandbyInstances", - "traits": { - "smithy.api#documentation": "

Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances in Standby\n state are found.

\n

The following lists the valid values:

\n
\n
Terminate
\n
\n

Amazon EC2 Auto Scaling terminates instances that are in Standby.

\n
\n
Ignore
\n
\n

Amazon EC2 Auto Scaling ignores instances that are in Standby and continues\n to replace instances that are in the InService state.

\n
\n
Wait (default)
\n
\n

Amazon EC2 Auto Scaling waits one hour for you to return the instances to service.\n Otherwise, the instance refresh will fail.

\n
\n
" - } - }, - "AlarmSpecification": { - "target": "com.amazonaws.autoscaling#AlarmSpecification", - "traits": { - "smithy.api#documentation": "

(Optional) The CloudWatch alarm specification. CloudWatch alarms can be used to identify any\n issues and fail the operation if an alarm threshold is met.

" - } - }, - "MaxHealthyPercentage": { - "target": "com.amazonaws.autoscaling#IntPercent100To200", - "traits": { - "smithy.api#documentation": "

Specifies the maximum percentage of the group that can be in service and healthy, or\n pending, to support your workload when replacing instances. The value is expressed as a\n percentage of the desired capacity of the Auto Scaling group. Value range is 100 to 200.

\n

If you specify MaxHealthyPercentage, you must also specify\n MinHealthyPercentage, and the difference between them cannot be greater\n than 100. A larger range increases the number of instances that can be replaced at the\n same time.

\n

If you do not specify this property, the default is 100 percent, or the percentage set\n in the instance maintenance policy for the Auto Scaling group, if defined.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the preferences for an instance refresh.

" - } - }, - "com.amazonaws.autoscaling#RefreshStrategy": { - "type": "enum", - "members": { - "Rolling": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Rolling" - } - } - } - }, - "com.amazonaws.autoscaling#ResourceContentionFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ResourceContention", - "httpResponseCode": 500 - }, - "smithy.api#documentation": "

You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group,\n instance, or load balancer).

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.autoscaling#ResourceInUseFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ResourceInUse", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The operation can't be performed because the resource is in use.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.autoscaling#ResourceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1600 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.autoscaling#ResumeProcesses": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#ScalingProcessQuery" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - }, - { - "target": "com.amazonaws.autoscaling#ResourceInUseFault" - } - ], - "traits": { - "smithy.api#documentation": "

Resumes the specified suspended auto scaling processes, or all suspended process, for\n the specified Auto Scaling group.

\n

For more information, see Suspend and resume\n Amazon EC2 Auto Scaling processes in the Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To resume Auto Scaling processes", - "documentation": "This example resumes the specified suspended scaling process for the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "ScalingProcesses": ["AlarmNotification"] + }, + "com.amazonaws.autoscaling#XmlString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } - } - ] - } - }, - "com.amazonaws.autoscaling#ReturnData": { - "type": "boolean" - }, - "com.amazonaws.autoscaling#ReuseOnScaleIn": { - "type": "boolean" - }, - "com.amazonaws.autoscaling#RollbackDetails": { - "type": "structure", - "members": { - "RollbackReason": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", - "traits": { - "smithy.api#documentation": "

The reason for this instance refresh rollback (for example, whether a manual or\n automatic rollback was initiated).

" - } - }, - "RollbackStartTime": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The date and time at which the rollback began.

" - } - }, - "PercentageCompleteOnRollback": { - "target": "com.amazonaws.autoscaling#IntPercent", - "traits": { - "smithy.api#documentation": "

Indicates the value of PercentageComplete at the time the rollback\n started.

" - } - }, - "InstancesToUpdateOnRollback": { - "target": "com.amazonaws.autoscaling#InstancesToUpdate", - "traits": { - "smithy.api#documentation": "

Indicates the value of InstancesToUpdate at the time the rollback\n started.

" - } - }, - "ProgressDetailsOnRollback": { - "target": "com.amazonaws.autoscaling#InstanceRefreshProgressDetails", - "traits": { - "smithy.api#documentation": "

Reports progress on replacing instances in an Auto Scaling group that has a warm pool. This\n includes separate details for instances in the warm pool and instances in the Auto Scaling group\n (the live pool).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about an instance refresh rollback.

" - } - }, - "com.amazonaws.autoscaling#RollbackInstanceRefresh": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#RollbackInstanceRefreshType" - }, - "output": { - "target": "com.amazonaws.autoscaling#RollbackInstanceRefreshAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ActiveInstanceRefreshNotFoundFault" - }, - { - "target": "com.amazonaws.autoscaling#IrreversibleInstanceRefreshFault" - }, - { - "target": "com.amazonaws.autoscaling#LimitExceededFault" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Cancels an instance refresh that is in progress and rolls back any changes that it\n made. Amazon EC2 Auto Scaling replaces any instances that were replaced during the instance refresh.\n This restores your Auto Scaling group to the configuration that it was using before the start of\n the instance refresh.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group\n after you make configuration changes.

\n

A rollback is not supported in the following situations:

\n \n

When you receive a successful response from this operation, Amazon EC2 Auto Scaling immediately\n begins replacing instances. You can check the status of this operation through the DescribeInstanceRefreshes API operation.

" - } - }, - "com.amazonaws.autoscaling#RollbackInstanceRefreshAnswer": { - "type": "structure", - "members": { - "InstanceRefreshId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The instance refresh ID associated with the request. This is the unique ID assigned to\n the instance refresh when it was started.

" - } - } - } - }, - "com.amazonaws.autoscaling#RollbackInstanceRefreshType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#ScaleInProtectedInstances": { - "type": "enum", - "members": { - "Refresh": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Refresh" - } - }, - "Ignore": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ignore" - } - }, - "Wait": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Wait" - } - } - } - }, - "com.amazonaws.autoscaling#ScalingActivityInProgressFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ScalingActivityInProgress", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The operation can't be performed because there are scaling activities in\n progress.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.autoscaling#ScalingActivityStatusCode": { - "type": "enum", - "members": { - "PendingSpotBidPlacement": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PendingSpotBidPlacement" - } - }, - "WaitingForSpotInstanceRequestId": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WaitingForSpotInstanceRequestId" - } - }, - "WaitingForSpotInstanceId": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WaitingForSpotInstanceId" - } - }, - "WaitingForInstanceId": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WaitingForInstanceId" - } - }, - "PreInService": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PreInService" - } - }, - "InProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "WaitingForELBConnectionDraining": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WaitingForELBConnectionDraining" - } - }, - "MidLifecycleAction": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MidLifecycleAction" - } - }, - "WaitingForInstanceWarmup": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WaitingForInstanceWarmup" - } - }, - "Successful": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Successful" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "Cancelled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Cancelled" - } - }, - "WaitingForConnectionDraining": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WaitingForConnectionDraining" - } - } - } - }, - "com.amazonaws.autoscaling#ScalingPolicies": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#ScalingPolicy" - } - }, - "com.amazonaws.autoscaling#ScalingPolicy": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

" - } - }, - "PolicyName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the scaling policy.

" - } - }, - "PolicyARN": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy.

" - } - }, - "PolicyType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", - "traits": { - "smithy.api#documentation": "

One of the following policy types:

\n \n

For more information, see Target tracking\n scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "AdjustmentType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

Specifies how the scaling adjustment is interpreted (for example, an absolute number\n or a percentage). The valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.

" - } - }, - "MinAdjustmentStep": { - "target": "com.amazonaws.autoscaling#MinAdjustmentStep", - "traits": { - "smithy.api#documentation": "

Available for backward compatibility. Use MinAdjustmentMagnitude\n instead.

" - } - }, - "MinAdjustmentMagnitude": { - "target": "com.amazonaws.autoscaling#MinAdjustmentMagnitude", - "traits": { - "smithy.api#documentation": "

The minimum value to scale by when the adjustment type is\n PercentChangeInCapacity.

" - } - }, - "ScalingAdjustment": { - "target": "com.amazonaws.autoscaling#PolicyIncrement", - "traits": { - "smithy.api#documentation": "

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current\n capacity.

" - } - }, - "Cooldown": { - "target": "com.amazonaws.autoscaling#Cooldown", - "traits": { - "smithy.api#documentation": "

The duration of the policy's cooldown period, in seconds.

" - } - }, - "StepAdjustments": { - "target": "com.amazonaws.autoscaling#StepAdjustments", - "traits": { - "smithy.api#documentation": "

A set of adjustments that enable you to scale based on the size of the alarm\n breach.

" - } - }, - "MetricAggregationType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", - "traits": { - "smithy.api#documentation": "

The aggregation type for the CloudWatch metrics. The valid values are Minimum,\n Maximum, and Average.

" - } - }, - "EstimatedInstanceWarmup": { - "target": "com.amazonaws.autoscaling#EstimatedInstanceWarmup", - "traits": { - "smithy.api#documentation": "

The estimated time, in seconds, until a newly launched instance can contribute to the\n CloudWatch metrics.

" - } - }, - "Alarms": { - "target": "com.amazonaws.autoscaling#Alarms", - "traits": { - "smithy.api#documentation": "

The CloudWatch alarms related to the policy.

" - } - }, - "TargetTrackingConfiguration": { - "target": "com.amazonaws.autoscaling#TargetTrackingConfiguration", - "traits": { - "smithy.api#documentation": "

A target tracking scaling policy.

" - } - }, - "Enabled": { - "target": "com.amazonaws.autoscaling#ScalingPolicyEnabled", - "traits": { - "smithy.api#documentation": "

Indicates whether the policy is enabled (true) or disabled\n (false).

" - } - }, - "PredictiveScalingConfiguration": { - "target": "com.amazonaws.autoscaling#PredictiveScalingConfiguration", - "traits": { - "smithy.api#documentation": "

A predictive scaling policy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a scaling policy.

" - } - }, - "com.amazonaws.autoscaling#ScalingPolicyEnabled": { - "type": "boolean" - }, - "com.amazonaws.autoscaling#ScalingProcessQuery": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "ScalingProcesses": { - "target": "com.amazonaws.autoscaling#ProcessNames", - "traits": { - "smithy.api#documentation": "

One or more of the following processes:

\n \n

If you omit this property, all processes are specified.

" - } - } - } - }, - "com.amazonaws.autoscaling#ScheduledActionNames": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" - } - }, - "com.amazonaws.autoscaling#ScheduledActionsType": { - "type": "structure", - "members": { - "ScheduledUpdateGroupActions": { - "target": "com.amazonaws.autoscaling#ScheduledUpdateGroupActions", - "traits": { - "smithy.api#documentation": "

The scheduled actions.

" - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" - } - } - } - }, - "com.amazonaws.autoscaling#ScheduledUpdateGroupAction": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

" - } - }, - "ScheduledActionName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the scheduled action.

" - } - }, - "ScheduledActionARN": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the scheduled action.

" - } - }, - "Time": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

This property is no longer used.

" - } - }, - "StartTime": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The date and time in UTC for this action to start. For example,\n \"2019-06-01T00:00:00Z\".

" - } - }, - "EndTime": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The date and time in UTC for the recurring schedule to end. For example,\n \"2019-06-01T00:00:00Z\".

" - } - }, - "Recurrence": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The recurring schedule for the action, in Unix cron syntax format.

\n

When StartTime and EndTime are specified with\n Recurrence, they form the boundaries of when the recurring action\n starts and stops.

" - } - }, - "MinSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", - "traits": { - "smithy.api#documentation": "

The minimum size of the Auto Scaling group.

" - } - }, - "MaxSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", - "traits": { - "smithy.api#documentation": "

The maximum size of the Auto Scaling group.

" - } - }, - "DesiredCapacity": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", - "traits": { - "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group after the scheduled\n action runs and the capacity it attempts to maintain.

" - } - }, - "TimeZone": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The time zone for the cron expression.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a scheduled scaling\n action.

" - } - }, - "com.amazonaws.autoscaling#ScheduledUpdateGroupActionRequest": { - "type": "structure", - "members": { - "ScheduledActionName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the scaling action.

", - "smithy.api#required": {} - } - }, - "StartTime": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT\n only and in quotes (for example, \"2019-06-01T00:00:00Z\").

\n

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs\n the action at this time, and then performs the action based on the specified\n recurrence.

\n

If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error\n message.

" - } - }, - "EndTime": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The date and time for the recurring schedule to end, in UTC.

" - } - }, - "Recurrence": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The recurring schedule for the action, in Unix cron syntax format. This format\n consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month]\n [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, \"30 0 1\n 1,6,12 *\"). For more information about this format, see Crontab.

\n

When StartTime and EndTime are specified with\n Recurrence, they form the boundaries of when the recurring action\n starts and stops.

\n

Cron expressions use Universal Coordinated Time (UTC) by default.

" - } - }, - "MinSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", - "traits": { - "smithy.api#documentation": "

The minimum size of the Auto Scaling group.

" - } - }, - "MaxSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", - "traits": { - "smithy.api#documentation": "

The maximum size of the Auto Scaling group.

" - } - }, - "DesiredCapacity": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", - "traits": { - "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group after the scheduled\n action runs and the capacity it attempts to maintain.

" - } - }, - "TimeZone": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

Specifies the time zone for a cron expression. If a time zone is not provided, UTC is\n used by default.

\n

Valid values are the canonical names of the IANA time zones, derived from the IANA\n Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti). For\n more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes information used for one or more scheduled scaling action updates in a BatchPutScheduledUpdateGroupAction operation.

" - } - }, - "com.amazonaws.autoscaling#ScheduledUpdateGroupActionRequests": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#ScheduledUpdateGroupActionRequest" - } - }, - "com.amazonaws.autoscaling#ScheduledUpdateGroupActions": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#ScheduledUpdateGroupAction" - } - }, - "com.amazonaws.autoscaling#SecurityGroups": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#XmlString" - } - }, - "com.amazonaws.autoscaling#ServiceLinkedRoleFailure": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ServiceLinkedRoleFailure", - "httpResponseCode": 500 - }, - "smithy.api#documentation": "

The service-linked role is not yet ready for use.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.autoscaling#SetDesiredCapacity": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#SetDesiredCapacityType" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - }, - { - "target": "com.amazonaws.autoscaling#ScalingActivityInProgressFault" - } - ], - "traits": { - "smithy.api#documentation": "

Sets the size of the specified Auto Scaling group.

\n

If a scale-in activity occurs as a result of a new DesiredCapacity value\n that is lower than the current size of the group, the Auto Scaling group uses its termination\n policy to determine which instances to terminate.

\n

For more information, see Manual\n scaling in the Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To set the desired capacity for an Auto Scaling group", - "documentation": "This example sets the desired capacity for the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "DesiredCapacity": 2, - "HonorCooldown": true + }, + "com.amazonaws.autoscaling#XmlStringMaxLen1023": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1023 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } - } - ] - } - }, - "com.amazonaws.autoscaling#SetDesiredCapacityType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "DesiredCapacity": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group after this operation\n completes and the capacity it attempts to maintain.

", - "smithy.api#required": {} - } - }, - "HonorCooldown": { - "target": "com.amazonaws.autoscaling#HonorCooldown", - "traits": { - "smithy.api#documentation": "

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating\n a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does\n not honor the cooldown period during manual scaling activities.

" - } - } - } - }, - "com.amazonaws.autoscaling#SetInstanceHealth": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#SetInstanceHealthQuery" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Sets the health status of the specified instance.

\n

For more information, see Health checks\n for instances in an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To set the health status of an instance", - "documentation": "This example sets the health status of the specified instance to Unhealthy.", - "input": { - "InstanceId": "i-93633f9b", - "HealthStatus": "Unhealthy" + }, + "com.amazonaws.autoscaling#XmlStringMaxLen1600": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } - } - ] - } - }, - "com.amazonaws.autoscaling#SetInstanceHealthQuery": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {} - } - }, - "HealthStatus": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The health status of the instance. Set to Healthy to have the instance\n remain in service. Set to Unhealthy to have the instance be out of service.\n Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.

", - "smithy.api#required": {} - } - }, - "ShouldRespectGracePeriod": { - "target": "com.amazonaws.autoscaling#ShouldRespectGracePeriod", - "traits": { - "smithy.api#documentation": "

If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod\n specified for the group, by default, this call respects the grace period. Set this to\n False, to have the call not respect the grace period associated with\n the group.

\n

For more information about the health check grace period, see Set the health check grace period for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

" - } - } - } - }, - "com.amazonaws.autoscaling#SetInstanceProtection": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#SetInstanceProtectionQuery" - }, - "output": { - "target": "com.amazonaws.autoscaling#SetInstanceProtectionAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#LimitExceededFault" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the instance protection settings of the specified instances. This operation\n cannot be called on instances in a warm pool.

\n

For more information, see Use\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.

\n

If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call\n fails.

", - "smithy.api#examples": [ - { - "title": "To enable instance protection for an instance", - "documentation": "This example enables instance protection for the specified instance.", - "input": { - "InstanceIds": ["i-93633f9b"], - "AutoScalingGroupName": "my-auto-scaling-group", - "ProtectedFromScaleIn": true - } - }, - { - "title": "To disable instance protection for an instance", - "documentation": "This example disables instance protection for the specified instance.", - "input": { - "InstanceIds": ["i-93633f9b"], - "AutoScalingGroupName": "my-auto-scaling-group", - "ProtectedFromScaleIn": false + }, + "com.amazonaws.autoscaling#XmlStringMaxLen19": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 19 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } - } - ] - } - }, - "com.amazonaws.autoscaling#SetInstanceProtectionAnswer": { - "type": "structure", - "members": {} - }, - "com.amazonaws.autoscaling#SetInstanceProtectionQuery": { - "type": "structure", - "members": { - "InstanceIds": { - "target": "com.amazonaws.autoscaling#InstanceIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

One or more instance IDs. You can specify up to 50 instances.

", - "smithy.api#required": {} - } - }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "ProtectedFromScaleIn": { - "target": "com.amazonaws.autoscaling#ProtectedFromScaleIn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling\n in.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#ShouldDecrementDesiredCapacity": { - "type": "boolean" - }, - "com.amazonaws.autoscaling#ShouldRespectGracePeriod": { - "type": "boolean" - }, - "com.amazonaws.autoscaling#SkipMatching": { - "type": "boolean" - }, - "com.amazonaws.autoscaling#SpotInstancePools": { - "type": "integer" - }, - "com.amazonaws.autoscaling#SpotPrice": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.autoscaling#StandbyInstances": { - "type": "enum", - "members": { - "Terminate": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Terminate" - } - }, - "Ignore": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ignore" - } - }, - "Wait": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Wait" - } - } - } - }, - "com.amazonaws.autoscaling#StartInstanceRefresh": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#StartInstanceRefreshType" - }, - "output": { - "target": "com.amazonaws.autoscaling#StartInstanceRefreshAnswer" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#InstanceRefreshInProgressFault" - }, - { - "target": "com.amazonaws.autoscaling#LimitExceededFault" - }, - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - } - ], - "traits": { - "smithy.api#documentation": "

Starts an instance refresh.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group.\n This feature is helpful, for example, when you have a new AMI or a new user data script.\n You just need to create a new launch template that specifies the new AMI or user data\n script. Then start an instance refresh to immediately begin the process of updating\n instances in the group.

\n

If successful, the request's response contains a unique ID that you can use to track\n the progress of the instance refresh. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that\n have already run, call the DescribeInstanceRefreshes API. To cancel an\n instance refresh that is in progress, use the CancelInstanceRefresh\n API.

\n

An instance refresh might fail for several reasons, such as EC2 launch failures,\n misconfigured health checks, or not ignoring or allowing the termination of instances\n that are in Standby state or protected from scale in. You can monitor for\n failed EC2 launches using the scaling activities. To find the scaling activities, call\n the DescribeScalingActivities API.

\n

If you enable auto rollback, your Auto Scaling group will be rolled back automatically when\n the instance refresh fails. You can enable this feature before starting an instance\n refresh by specifying the AutoRollback property in the instance refresh\n preferences. Otherwise, to roll back an instance refresh before it finishes, use the\n RollbackInstanceRefresh API.

", - "smithy.api#examples": [ - { - "title": "To start an instance refresh", - "documentation": "This example starts an instance refresh for the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "DesiredConfiguration": { - "LaunchTemplate": { - "LaunchTemplateName": "my-template-for-auto-scaling", - "Version": "$Latest" - } - }, - "Preferences": { - "AutoRollback": true, - "InstanceWarmup": 200, - "MinHealthyPercentage": 90, - "MaxHealthyPercentage": 120, - "AlarmSpecification": { - "Alarms": ["my-alarm"] - } - } - }, - "output": { - "InstanceRefreshId": "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b" + }, + "com.amazonaws.autoscaling#XmlStringMaxLen2047": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2047 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } - } - ] - } - }, - "com.amazonaws.autoscaling#StartInstanceRefreshAnswer": { - "type": "structure", - "members": { - "InstanceRefreshId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

A unique ID for tracking the progress of the instance refresh.

" - } - } - } - }, - "com.amazonaws.autoscaling#StartInstanceRefreshType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "Strategy": { - "target": "com.amazonaws.autoscaling#RefreshStrategy", - "traits": { - "smithy.api#documentation": "

The strategy to use for the instance refresh. The only valid value is\n Rolling.

" - } - }, - "DesiredConfiguration": { - "target": "com.amazonaws.autoscaling#DesiredConfiguration", - "traits": { - "smithy.api#documentation": "

The desired configuration. For example, the desired configuration can specify a new\n launch template or a new version of the current launch template.

\n

Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to\n reflect the new desired configuration.

\n \n

When you specify a new launch template or a new version of the current launch\n template for your desired configuration, consider enabling the\n SkipMatching property in preferences. If it's enabled, Amazon EC2 Auto Scaling\n skips replacing instances that already use the specified launch template and\n instance types. This can help you reduce the number of replacements that are\n required to apply updates.

\n " - } - }, - "Preferences": { - "target": "com.amazonaws.autoscaling#RefreshPreferences", - "traits": { - "smithy.api#documentation": "

Sets your preferences for the instance refresh so that it performs as expected when\n you start it. Includes the instance warmup time, the minimum and maximum healthy\n percentages, and the behaviors that you want Amazon EC2 Auto Scaling to use if instances that are in\n Standby state or protected from scale in are found. You can also choose\n to enable additional features, such as the following:

\n " - } - } - } - }, - "com.amazonaws.autoscaling#StepAdjustment": { - "type": "structure", - "members": { - "MetricIntervalLowerBound": { - "target": "com.amazonaws.autoscaling#MetricScale", - "traits": { - "smithy.api#documentation": "

The lower bound for the difference between the alarm threshold and the CloudWatch metric. If\n the metric value is above the breach threshold, the lower bound is inclusive (the metric\n must be greater than or equal to the threshold plus the lower bound). Otherwise, it is\n exclusive (the metric must be greater than the threshold plus the lower bound). A null\n value indicates negative infinity.

" - } - }, - "MetricIntervalUpperBound": { - "target": "com.amazonaws.autoscaling#MetricScale", - "traits": { - "smithy.api#documentation": "

The upper bound for the difference between the alarm threshold and the CloudWatch metric. If\n the metric value is above the breach threshold, the upper bound is exclusive (the metric\n must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the\n metric must be less than or equal to the threshold plus the upper bound). A null value\n indicates positive infinity.

\n

The upper bound must be greater than the lower bound.

" - } - }, - "ScalingAdjustment": { - "target": "com.amazonaws.autoscaling#PolicyIncrement", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current capacity.\n For exact capacity, you must specify a non-negative value.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes information used to create a step adjustment for a step scaling\n policy.

\n

For the following examples, suppose that you have an alarm with a breach threshold of\n 50:

\n \n

There are a few rules for the step adjustments for your step policy:

\n \n

For more information, see Step\n adjustments in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "com.amazonaws.autoscaling#StepAdjustments": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#StepAdjustment" - } - }, - "com.amazonaws.autoscaling#SuspendProcesses": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#ScalingProcessQuery" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - }, - { - "target": "com.amazonaws.autoscaling#ResourceInUseFault" - } - ], - "traits": { - "smithy.api#documentation": "

Suspends the specified auto scaling processes, or all processes, for the specified\n Auto Scaling group.

\n

If you suspend either the Launch or Terminate process types,\n it can prevent other process types from functioning properly. For more information, see\n Suspend and resume\n Amazon EC2 Auto Scaling processes in the Amazon EC2 Auto Scaling User Guide.

\n

To resume processes that have been suspended, call the ResumeProcesses API.

", - "smithy.api#examples": [ - { - "title": "To suspend Auto Scaling processes", - "documentation": "This example suspends the specified scaling process for the specified Auto Scaling group.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "ScalingProcesses": ["AlarmNotification"] + }, + "com.amazonaws.autoscaling#XmlStringMaxLen255": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } - } - ] - } - }, - "com.amazonaws.autoscaling#SuspendedProcess": { - "type": "structure", - "members": { - "ProcessName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the suspended process.

" - } - }, - "SuspensionReason": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The reason that the process was suspended.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an auto scaling process that has been suspended.

\n

For more information, see Types\n of processes in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "com.amazonaws.autoscaling#SuspendedProcesses": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#SuspendedProcess" - } - }, - "com.amazonaws.autoscaling#Tag": { - "type": "structure", - "members": { - "ResourceId": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The name of the Auto Scaling group.

" - } - }, - "ResourceType": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The type of resource. The only supported value is\n auto-scaling-group.

" - } - }, - "Key": { - "target": "com.amazonaws.autoscaling#TagKey", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The tag key.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.autoscaling#TagValue", - "traits": { - "smithy.api#documentation": "

The tag value.

" - } - }, - "PropagateAtLaunch": { - "target": "com.amazonaws.autoscaling#PropagateAtLaunch", - "traits": { - "smithy.api#documentation": "

Determines whether the tag is added to new instances as they are launched in the\n group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a tag for an Auto Scaling group.

" - } - }, - "com.amazonaws.autoscaling#TagDescription": { - "type": "structure", - "members": { - "ResourceId": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The name of the group.

" - } - }, - "ResourceType": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The type of resource. The only supported value is\n auto-scaling-group.

" - } - }, - "Key": { - "target": "com.amazonaws.autoscaling#TagKey", - "traits": { - "smithy.api#documentation": "

The tag key.

" - } - }, - "Value": { - "target": "com.amazonaws.autoscaling#TagValue", - "traits": { - "smithy.api#documentation": "

The tag value.

" - } - }, - "PropagateAtLaunch": { - "target": "com.amazonaws.autoscaling#PropagateAtLaunch", - "traits": { - "smithy.api#documentation": "

Determines whether the tag is added to new instances as they are launched in the\n group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a tag for an Auto Scaling group.

" - } - }, - "com.amazonaws.autoscaling#TagDescriptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#TagDescription" - } - }, - "com.amazonaws.autoscaling#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.autoscaling#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.autoscaling#Tags": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#Tag" - } - }, - "com.amazonaws.autoscaling#TagsType": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.autoscaling#TagDescriptionList", - "traits": { - "smithy.api#documentation": "

One or more tags.

" - } - }, - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.

" - } - } - } - }, - "com.amazonaws.autoscaling#TargetGroupARNs": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen511" - } - }, - "com.amazonaws.autoscaling#TargetTrackingConfiguration": { - "type": "structure", - "members": { - "PredefinedMetricSpecification": { - "target": "com.amazonaws.autoscaling#PredefinedMetricSpecification", - "traits": { - "smithy.api#documentation": "

A predefined metric. You must specify either a predefined metric or a customized\n metric.

" - } - }, - "CustomizedMetricSpecification": { - "target": "com.amazonaws.autoscaling#CustomizedMetricSpecification", - "traits": { - "smithy.api#documentation": "

A customized metric. You must specify either a predefined metric or a customized\n metric.

" - } - }, - "TargetValue": { - "target": "com.amazonaws.autoscaling#MetricScale", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The target value for the metric.

\n \n

Some metrics are based on a count instead of a percentage, such as the request\n count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy\n specifies one of these metrics, specify the target utilization as the optimal\n average request or message count per instance during any one-minute interval.\n

\n ", - "smithy.api#required": {} - } - }, - "DisableScaleIn": { - "target": "com.amazonaws.autoscaling#DisableScaleIn", - "traits": { - "smithy.api#documentation": "

Indicates whether scaling in by the target tracking scaling policy is disabled. If\n scaling in is disabled, the target tracking scaling policy doesn't remove instances from\n the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from\n the Auto Scaling group. The default is false.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a target tracking scaling policy configuration to use with Amazon EC2 Auto Scaling.

" - } - }, - "com.amazonaws.autoscaling#TargetTrackingMetricDataQueries": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#TargetTrackingMetricDataQuery" - } - }, - "com.amazonaws.autoscaling#TargetTrackingMetricDataQuery": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A short name that identifies the object's results in the response. This name must be\n unique among all TargetTrackingMetricDataQuery objects specified for a\n single scaling policy. If you are performing math expressions on this set of data, this\n name represents that data and can serve as a variable in the mathematical expression.\n The valid characters are letters, numbers, and underscores. The first character must be\n a lowercase letter.

", - "smithy.api#required": {} - } - }, - "Expression": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen2047", - "traits": { - "smithy.api#documentation": "

The math expression to perform on the returned data, if this object is performing a\n math expression. This expression can use the Id of the other metrics to\n refer to those metrics, and can also use the Id of other expressions to use\n the result of those expressions.

\n

Conditional: Within each TargetTrackingMetricDataQuery object, you must\n specify either Expression or MetricStat, but not both.

" - } - }, - "MetricStat": { - "target": "com.amazonaws.autoscaling#TargetTrackingMetricStat", - "traits": { - "smithy.api#documentation": "

Information about the metric data to return.

\n

Conditional: Within each TargetTrackingMetricDataQuery object, you must\n specify either Expression or MetricStat, but not both.

" - } - }, - "Label": { - "target": "com.amazonaws.autoscaling#XmlStringMetricLabel", - "traits": { - "smithy.api#documentation": "

A human-readable label for this metric or expression. This is especially useful if\n this is a math expression, so that you know what the value represents.

" - } - }, - "ReturnData": { - "target": "com.amazonaws.autoscaling#ReturnData", - "traits": { - "smithy.api#documentation": "

Indicates whether to return the timestamps and raw data values of this metric.

\n

If you use any math expressions, specify true for this value for only the\n final math expression that the metric specification is based on. You must specify\n false for ReturnData for all the other metrics and\n expressions used in the metric specification.

\n

If you are only retrieving metrics and not performing any math expressions, do not\n specify anything for ReturnData. This sets it to its default\n (true).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The metric data to return. Also defines whether this call is returning data for one\n metric only, or whether it is performing a math expression on the values of returned\n metric statistics to create a new time series. A time series is a series of data points,\n each of which is associated with a timestamp.

" - } - }, - "com.amazonaws.autoscaling#TargetTrackingMetricStat": { - "type": "structure", - "members": { - "Metric": { - "target": "com.amazonaws.autoscaling#Metric", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The metric to use.

", - "smithy.api#required": {} - } - }, - "Stat": { - "target": "com.amazonaws.autoscaling#XmlStringMetricStat", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The statistic to return. It can include any CloudWatch statistic or extended statistic. For\n a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.

\n

The most commonly used metric for scaling is Average.

", - "smithy.api#required": {} - } - }, - "Unit": { - "target": "com.amazonaws.autoscaling#MetricUnit", - "traits": { - "smithy.api#documentation": "

The unit to use for the returned data points. For a complete list of the units that\n CloudWatch supports, see the MetricDatum\n data type in the Amazon CloudWatch API Reference.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This structure defines the CloudWatch metric to return, along with the statistic and\n unit.

\n

For more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts in the Amazon CloudWatch User Guide.

" - } - }, - "com.amazonaws.autoscaling#TerminateInstanceInAutoScalingGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#TerminateInstanceInAutoScalingGroupType" - }, - "output": { - "target": "com.amazonaws.autoscaling#ActivityType" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - }, - { - "target": "com.amazonaws.autoscaling#ScalingActivityInProgressFault" - } - ], - "traits": { - "smithy.api#documentation": "

Terminates the specified instance and optionally adjusts the desired group size. This\n operation cannot be called on instances in a warm pool.

\n

This call simply makes a termination request. The instance is not terminated\n immediately. When an instance is terminated, the instance status changes to\n terminated. You can't connect to or start an instance after you've\n terminated it.

\n

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are terminated.

\n

By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you\n decrement the desired capacity, your Auto Scaling group can become unbalanced between\n Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might\n terminate instances in other zones. For more information, see Manual\n scaling in the Amazon EC2 Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To terminate an instance in an Auto Scaling group", - "documentation": "This example terminates the specified instance from the specified Auto Scaling group without updating the size of the group. Auto Scaling launches a replacement instance after the specified instance terminates.", - "input": { - "InstanceId": "i-93633f9b", - "ShouldDecrementDesiredCapacity": false + }, + "com.amazonaws.autoscaling#XmlStringMaxLen32": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.autoscaling#XmlStringMaxLen5000": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5000 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.autoscaling#XmlStringMaxLen511": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 511 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.autoscaling#XmlStringMaxLen64": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.autoscaling#XmlStringMetricLabel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2047 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.autoscaling#XmlStringMetricStat": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.autoscaling#XmlStringUserData": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 21847 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } - } - ] - } - }, - "com.amazonaws.autoscaling#TerminateInstanceInAutoScalingGroupType": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {} - } - }, - "ShouldDecrementDesiredCapacity": { - "target": "com.amazonaws.autoscaling#ShouldDecrementDesiredCapacity", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Indicates whether terminating the instance also decrements the size of the Auto Scaling\n group.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.autoscaling#TerminationPolicies": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen1600" - } - }, - "com.amazonaws.autoscaling#TimestampType": { - "type": "timestamp" - }, - "com.amazonaws.autoscaling#TotalLocalStorageGBRequest": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.autoscaling#NullablePositiveDouble", - "traits": { - "smithy.api#documentation": "

The storage minimum in GB.

" - } - }, - "Max": { - "target": "com.amazonaws.autoscaling#NullablePositiveDouble", - "traits": { - "smithy.api#documentation": "

The storage maximum in GB.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the minimum and maximum for the TotalLocalStorageGB object when\n you specify InstanceRequirements for an Auto Scaling group.

" - } - }, - "com.amazonaws.autoscaling#TrafficSourceIdentifier": { - "type": "structure", - "members": { - "Identifier": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen511", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Identifies the traffic source.

\n

For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will be the Amazon Resource Name\n (ARN) for a target group in this account and Region. For Classic Load Balancers, this will be the name\n of the Classic Load Balancer in this account and Region.

\n

For example:

\n \n

To get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer, or the name of a\n Classic Load Balancer, use the Elastic Load Balancing DescribeTargetGroups and DescribeLoadBalancers API operations.

\n

To get the ARN of a target group for VPC Lattice, use the VPC Lattice GetTargetGroup API operation.

", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen511", - "traits": { - "smithy.api#documentation": "

Provides additional context for the value of Identifier.

\n

The following lists the valid values:

\n \n

Required if the identifier is the name of a Classic Load Balancer.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Identifying information for a traffic source.

" - } - }, - "com.amazonaws.autoscaling#TrafficSourceState": { - "type": "structure", - "members": { - "TrafficSource": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen511", - "traits": { - "smithy.api#deprecated": { - "message": "TrafficSource has been replaced by Identifier" - }, - "smithy.api#documentation": "

This is replaced by Identifier.

" - } - }, - "State": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

Describes the current state of a traffic source.

\n

The state values are as follows:

\n " - } - }, - "Identifier": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen511", - "traits": { - "smithy.api#documentation": "

The unique identifier of the traffic source.

" - } - }, - "Type": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen511", - "traits": { - "smithy.api#documentation": "

Provides additional context for the value of Identifier.

\n

The following lists the valid values:

\n \n

Required if the identifier is the name of a Classic Load Balancer.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the state of a traffic source.

" - } - }, - "com.amazonaws.autoscaling#TrafficSourceStates": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#TrafficSourceState" - } - }, - "com.amazonaws.autoscaling#TrafficSources": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#TrafficSourceIdentifier" - } - }, - "com.amazonaws.autoscaling#UpdateAutoScalingGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.autoscaling#UpdateAutoScalingGroupType" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.autoscaling#ResourceContentionFault" - }, - { - "target": "com.amazonaws.autoscaling#ScalingActivityInProgressFault" - }, - { - "target": "com.amazonaws.autoscaling#ServiceLinkedRoleFailure" - } - ], - "traits": { - "smithy.api#documentation": "

\n We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n

\n

Updates the configuration for the specified Auto Scaling group.

\n

To update an Auto Scaling group, specify the name of the group and the property that you want\n to change. Any properties that you don't specify are not changed by this update request.\n The new settings take effect on any scaling activities after this call returns.\n

\n

If you associate a new launch configuration or template with an Auto Scaling group, all new\n instances will get the updated configuration. Existing instances continue to run with\n the configuration that they were originally launched with. When you update a group to\n specify a mixed instances policy instead of a launch configuration or template, existing\n instances may be replaced to match the new purchasing options that you specified in the\n policy. For example, if the group currently has 100% On-Demand capacity and the policy\n specifies 50% Spot capacity, this means that half of your instances will be gradually\n terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches\n new instances before terminating the old ones, so that updating your group does not\n compromise the performance or availability of your application.

\n

Note the following about changing DesiredCapacity, MaxSize,\n or MinSize:

\n \n

To see which properties have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling\n group, call the DescribePolicies API. If the group has scaling\n policies, you can update them by calling the PutScalingPolicy\n API.

", - "smithy.api#examples": [ - { - "title": "To update an Auto Scaling group", - "documentation": "This example updates multiple properties at the same time.", - "input": { - "AutoScalingGroupName": "my-auto-scaling-group", - "LaunchTemplate": { - "LaunchTemplateName": "my-template-for-auto-scaling", - "Version": "2" - }, - "MinSize": 1, - "MaxSize": 5, - "NewInstancesProtectedFromScaleIn": true - } - } - ] - } - }, - "com.amazonaws.autoscaling#UpdateAutoScalingGroupType": { - "type": "structure", - "members": { - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Auto Scaling group.

", - "smithy.api#required": {} - } - }, - "LaunchConfigurationName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of the launch configuration. If you specify\n LaunchConfigurationName in your update request, you can't specify\n LaunchTemplate or MixedInstancesPolicy.

" - } - }, - "LaunchTemplate": { - "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", - "traits": { - "smithy.api#documentation": "

The launch template and version to use to specify the updates. If you specify\n LaunchTemplate in your update request, you can't specify\n LaunchConfigurationName or MixedInstancesPolicy.

" - } - }, - "MixedInstancesPolicy": { - "target": "com.amazonaws.autoscaling#MixedInstancesPolicy", - "traits": { - "smithy.api#documentation": "

The mixed instances policy. For more information, see Auto Scaling\n groups with multiple instance types and purchase options in the\n Amazon EC2 Auto Scaling User Guide.

" - } - }, - "MinSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", - "traits": { - "smithy.api#documentation": "

The minimum size of the Auto Scaling group.

" - } - }, - "MaxSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", - "traits": { - "smithy.api#documentation": "

The maximum size of the Auto Scaling group.

\n \n

With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to\n go above MaxSize to meet your capacity requirements. In this event,\n Amazon EC2 Auto Scaling will never go above MaxSize by more than your largest instance\n weight (weights that define how many units each instance contributes to the desired\n capacity of the group).

\n " - } - }, - "DesiredCapacity": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", - "traits": { - "smithy.api#documentation": "

The desired capacity is the initial capacity of the Auto Scaling group after this operation\n completes and the capacity it attempts to maintain. This number must be greater than or\n equal to the minimum size of the group and less than or equal to the maximum size of the\n group.

" - } - }, - "DefaultCooldown": { - "target": "com.amazonaws.autoscaling#Cooldown", - "traits": { - "smithy.api#documentation": "

\n Only needed if you use simple scaling policies.\n

\n

The amount of time, in seconds, between one scaling activity ending and another one\n starting due to simple scaling policies. For more information, see Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.autoscaling#AvailabilityZones", - "traits": { - "smithy.api#documentation": "

One or more Availability Zones for the group.

" - } - }, - "HealthCheckType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", - "traits": { - "smithy.api#documentation": "

A comma-separated value string of one or more health check types.

\n

The valid values are EC2, ELB, and VPC_LATTICE.\n EC2 is the default health check and cannot be disabled. For more\n information, see Health checks\n for instances in an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n

Only specify EC2 if you must clear a value that was previously\n set.

" - } - }, - "HealthCheckGracePeriod": { - "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", - "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n health check. This is useful if your instances do not immediately pass their health\n checks after they enter the InService state. For more information, see\n Set the health check\n grace period for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

" - } - }, - "PlacementGroup": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The name of an existing placement group into which to launch your instances. For more\n information, see Placement groups in the\n Amazon EC2 User Guide for Linux Instances.

\n \n

A cluster placement group is a logical grouping of instances\n within a single Availability Zone. You cannot specify multiple Availability Zones\n and a cluster placement group.

\n " - } - }, - "VPCZoneIdentifier": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen5000", - "traits": { - "smithy.api#documentation": "

A comma-separated list of subnet IDs for a virtual private cloud (VPC). If you specify\n VPCZoneIdentifier with AvailabilityZones, the subnets that\n you specify must reside in those Availability Zones.

" - } - }, - "TerminationPolicies": { - "target": "com.amazonaws.autoscaling#TerminationPolicies", - "traits": { - "smithy.api#documentation": "

A policy or a list of policies that are used to select the instances to terminate. The\n policies are executed in the order that you list them. For more information, see Configure\n termination policies for Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.

\n

Valid values: Default | AllocationStrategy |\n ClosestToNextInstanceHour | NewestInstance |\n OldestInstance | OldestLaunchConfiguration |\n OldestLaunchTemplate |\n arn:aws:lambda:region:account-id:function:my-function:my-alias\n

" - } - }, - "NewInstancesProtectedFromScaleIn": { - "target": "com.amazonaws.autoscaling#InstanceProtected", - "traits": { - "smithy.api#documentation": "

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in. For more information about preventing instances from terminating on\n scale in, see Use\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.

" - } - }, - "ServiceLinkedRoleARN": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other Amazon Web Services on your behalf. For more information, see Service-linked\n roles in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "MaxInstanceLifetime": { - "target": "com.amazonaws.autoscaling#MaxInstanceLifetime", - "traits": { - "smithy.api#documentation": "

The maximum amount of time, in seconds, that an instance can be in service. The\n default is null. If specified, the value must be either 0 or a number equal to or\n greater than 86,400 seconds (1 day). To clear a previously set value, specify a new\n value of 0. For more information, see Replacing Auto Scaling\n instances based on maximum instance lifetime in the\n Amazon EC2 Auto Scaling User Guide.

" - } - }, - "CapacityRebalance": { - "target": "com.amazonaws.autoscaling#CapacityRebalanceEnabled", - "traits": { - "smithy.api#documentation": "

Enables or disables Capacity Rebalancing. For more information, see Use Capacity\n Rebalancing to handle Amazon EC2 Spot Interruptions in the Amazon EC2 Auto Scaling User Guide.

" - } - }, - "Context": { - "target": "com.amazonaws.autoscaling#Context", - "traits": { - "smithy.api#documentation": "

Reserved.

" - } - }, - "DesiredCapacityType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only. For more information, see Create a mixed instances group using attribute-based instance type\n selection in the Amazon EC2 Auto Scaling User Guide.

\n

By default, Amazon EC2 Auto Scaling specifies units, which translates into number of\n instances.

\n

Valid values: units | vcpu | memory-mib\n

" - } - }, - "DefaultInstanceWarmup": { - "target": "com.amazonaws.autoscaling#DefaultInstanceWarmup", - "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, until a new instance is considered to have finished\n initializing and resource consumption to become stable after it enters the\n InService state.

\n

During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an\n instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the\n warm-up period before aggregating the metrics for new instances with existing instances\n in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage\n data. For more information, see Set\n the default instance warmup for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n \n

To manage various warm-up settings at the group level, we recommend that you set\n the default instance warmup, even if it is set to 0 seconds. To\n remove a value that you previously set, include the property but specify\n -1 for the value. However, we strongly recommend keeping the\n default instance warmup enabled by specifying a value of 0 or other\n nominal value.

\n " - } - }, - "InstanceMaintenancePolicy": { - "target": "com.amazonaws.autoscaling#InstanceMaintenancePolicy", - "traits": { - "smithy.api#documentation": "

An instance maintenance policy. For more information, see Set instance maintenance policy in the\n Amazon EC2 Auto Scaling User Guide.

" - } - } - } - }, - "com.amazonaws.autoscaling#VCpuCountRequest": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.autoscaling#NullablePositiveInteger", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The minimum number of vCPUs.

", - "smithy.api#required": {} - } - }, - "Max": { - "target": "com.amazonaws.autoscaling#NullablePositiveInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of vCPUs.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the minimum and maximum for the VCpuCount object when you\n specify InstanceRequirements for an Auto Scaling group.

" - } - }, - "com.amazonaws.autoscaling#Values": { - "type": "list", - "member": { - "target": "com.amazonaws.autoscaling#XmlString" - } - }, - "com.amazonaws.autoscaling#WarmPoolConfiguration": { - "type": "structure", - "members": { - "MaxGroupPreparedCapacity": { - "target": "com.amazonaws.autoscaling#MaxGroupPreparedCapacity", - "traits": { - "smithy.api#documentation": "

The maximum number of instances that are allowed to be in the warm pool or in any\n state except Terminated for the Auto Scaling group.

" - } - }, - "MinSize": { - "target": "com.amazonaws.autoscaling#WarmPoolMinSize", - "traits": { - "smithy.api#documentation": "

The minimum number of instances to maintain in the warm pool.

" - } - }, - "PoolState": { - "target": "com.amazonaws.autoscaling#WarmPoolState", - "traits": { - "smithy.api#documentation": "

The instance state to transition to after the lifecycle actions are complete.

" - } - }, - "Status": { - "target": "com.amazonaws.autoscaling#WarmPoolStatus", - "traits": { - "smithy.api#documentation": "

The status of a warm pool that is marked for deletion.

" - } - }, - "InstanceReusePolicy": { - "target": "com.amazonaws.autoscaling#InstanceReusePolicy", - "traits": { - "smithy.api#documentation": "

The instance reuse policy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a warm pool configuration.

" - } - }, - "com.amazonaws.autoscaling#WarmPoolMinSize": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.autoscaling#WarmPoolSize": { - "type": "integer" - }, - "com.amazonaws.autoscaling#WarmPoolState": { - "type": "enum", - "members": { - "Stopped": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Stopped" - } - }, - "Running": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Running" - } - }, - "Hibernated": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Hibernated" - } - } - } - }, - "com.amazonaws.autoscaling#WarmPoolStatus": { - "type": "enum", - "members": { - "PendingDelete": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PendingDelete" - } } - } - }, - "com.amazonaws.autoscaling#XmlString": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.autoscaling#XmlStringMaxLen1023": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1023 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.autoscaling#XmlStringMaxLen1600": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1600 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.autoscaling#XmlStringMaxLen19": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 19 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.autoscaling#XmlStringMaxLen2047": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2047 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.autoscaling#XmlStringMaxLen255": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.autoscaling#XmlStringMaxLen32": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.autoscaling#XmlStringMaxLen5000": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5000 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.autoscaling#XmlStringMaxLen511": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 511 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.autoscaling#XmlStringMaxLen64": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.autoscaling#XmlStringMetricLabel": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2047 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.autoscaling#XmlStringMetricStat": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.autoscaling#XmlStringUserData": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 21847 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } } - } } diff --git a/codegen/sdk-codegen/aws-models/bedrock.json b/codegen/sdk-codegen/aws-models/bedrock.json index 45a840764004..aaf59e0fc59c 100644 --- a/codegen/sdk-codegen/aws-models/bedrock.json +++ b/codegen/sdk-codegen/aws-models/bedrock.json @@ -1,8515 +1,9572 @@ { - "smithy": "2.0", - "shapes": { - "com.amazonaws.bedrock#AccessDeniedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrock#NonBlankString" - } - }, - "traits": { - "smithy.api#documentation": "

The request is denied because of missing access permissions.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.bedrock#AccountId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[0-9]{12}$" - } - }, - "com.amazonaws.bedrock#AmazonBedrockControlPlaneService": { - "type": "service", - "version": "2023-04-20", - "resources": [ - { - "target": "com.amazonaws.bedrock#EvaluationJobResource" - }, - { - "target": "com.amazonaws.bedrock#GuardrailsResource" - }, - { - "target": "com.amazonaws.bedrock#LoggingResource" - }, - { - "target": "com.amazonaws.bedrock#ModelCopyResource" - }, - { - "target": "com.amazonaws.bedrock#ModelInvocationJobResource" - }, - { - "target": "com.amazonaws.bedrock#ModelResource" - }, - { - "target": "com.amazonaws.bedrock#ProvisionedModelThroughputResource" - }, - { - "target": "com.amazonaws.bedrock#SubscriptionResource" - }, - { - "target": "com.amazonaws.bedrock#TaggingResource" - }, - { - "target": "com.amazonaws.bedrock#TrainingResource" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "Bedrock", - "endpointPrefix": "bedrock" - }, - "aws.auth#sigv4": { - "name": "bedrock" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Describes the API operations for creating, managing, fine-turning, and evaluating Amazon Bedrock models.

", - "smithy.api#title": "Amazon Bedrock", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" + "smithy": "2.0", + "shapes": { + "com.amazonaws.bedrock#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrock#NonBlankString" } - ], - "type": "tree" }, - { - "conditions": [], - "rules": [ + "traits": { + "smithy.api#documentation": "

The request is denied because of missing access permissions.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.bedrock#AccountId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.bedrock#AmazonBedrockControlPlaneService": { + "type": "service", + "version": "2023-04-20", + "resources": [ { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "target": "com.amazonaws.bedrock#EvaluationJobResource" + }, + { + "target": "com.amazonaws.bedrock#GuardrailsResource" + }, + { + "target": "com.amazonaws.bedrock#LoggingResource" + }, + { + "target": "com.amazonaws.bedrock#ModelCopyResource" + }, + { + "target": "com.amazonaws.bedrock#ModelImportResource" + }, + { + "target": "com.amazonaws.bedrock#ModelInvocationJobResource" + }, + { + "target": "com.amazonaws.bedrock#ModelResource" + }, + { + "target": "com.amazonaws.bedrock#ProvisionedModelThroughputResource" + }, + { + "target": "com.amazonaws.bedrock#SubscriptionResource" + }, + { + "target": "com.amazonaws.bedrock#TaggingResource" + }, + { + "target": "com.amazonaws.bedrock#TrainingResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Bedrock", + "endpointPrefix": "bedrock" + }, + "aws.auth#sigv4": { + "name": "bedrock" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Describes the API operations for creating, managing, fine-turning, and evaluating Amazon Bedrock models.

", + "smithy.api#title": "Amazon Bedrock", + "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": [ + }, + "rules": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "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": [], + "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": [ + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://bedrock.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://bedrock-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-fips.us-east-1.api.aws" } - ], - "type": "tree" }, - { - "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 } - ], - "type": "tree" }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://bedrock-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock.us-east-1.api.aws" } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://bedrock-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" + }, + "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://bedrock.us-east-1.amazonaws.com" } - ], - "type": "tree" }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false } - ], - "type": "tree" }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://bedrock-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true } - ], - "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://bedrock-fips.cn-north-1.amazonaws.com.cn" } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://bedrock.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" + }, + "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://bedrock.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://bedrock.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://bedrock-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://bedrock-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://bedrock.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://bedrock.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://bedrock-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://bedrock.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://bedrock-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://bedrock.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" } - ], - "type": "tree" }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" } - ], - "type": "tree" }, { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://bedrock.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" } - ], - "type": "tree" } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "type": "tree" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://bedrock-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://bedrock-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://bedrock.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://bedrock.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://bedrock-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://bedrock-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://bedrock.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://bedrock.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://bedrock-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://bedrock-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://bedrock.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://bedrock.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://bedrock-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://bedrock.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://bedrock-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://bedrock.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.bedrock#AutomatedEvaluationConfig": { - "type": "structure", - "members": { - "datasetMetricConfigs": { - "target": "com.amazonaws.bedrock#EvaluationDatasetMetricConfigs", - "traits": { - "smithy.api#documentation": "

Specifies the required elements for an automatic model evaluation job.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Use to specify a automatic model evaluation job. The EvaluationDatasetMetricConfig object is used to specify the prompt datasets, task type, and metric names.

" - } - }, - "com.amazonaws.bedrock#BaseModelIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$" - } - }, - "com.amazonaws.bedrock#BedrockModelId": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 140 - }, - "smithy.api#pattern": "^[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)$" - } - }, - "com.amazonaws.bedrock#BrandedName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 - }, - "smithy.api#pattern": "^.*$" - } - }, - "com.amazonaws.bedrock#BucketName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - } - } - }, - "com.amazonaws.bedrock#CloudWatchConfig": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.bedrock#LogGroupName", - "traits": { - "smithy.api#documentation": "

The log group name.

", - "smithy.api#required": {} - } - }, - "roleArn": { - "target": "com.amazonaws.bedrock#RoleArn", - "traits": { - "smithy.api#documentation": "

The role Amazon Resource Name (ARN).

", - "smithy.api#required": {} - } - }, - "largeDataDeliveryS3Config": { - "target": "com.amazonaws.bedrock#S3Config", - "traits": { - "smithy.api#documentation": "

S3 configuration for delivering a large amount of data.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

CloudWatch logging configuration.

" - } - }, - "com.amazonaws.bedrock#CommitmentDuration": { - "type": "enum", - "members": { - "ONE_MONTH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OneMonth" - } - }, - "SIX_MONTHS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SixMonths" - } - } - } - }, - "com.amazonaws.bedrock#ConflictException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrock#NonBlankString" - } - }, - "traits": { - "smithy.api#documentation": "

Error occurred because of a conflict while performing an operation.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.bedrock#CreateEvaluationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#CreateEvaluationJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#CreateEvaluationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers. To learn more about the requirements for creating a model evaluation job see, Model evaluation.

", - "smithy.api#http": { - "code": 202, - "method": "POST", - "uri": "/evaluation-jobs" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.bedrock#CreateEvaluationJobRequest": { - "type": "structure", - "members": { - "jobName": { - "target": "com.amazonaws.bedrock#EvaluationJobName", - "traits": { - "smithy.api#documentation": "

The name of the model evaluation job. Model evaluation job names must unique with your AWS account, and your account's AWS region.

", - "smithy.api#required": {} - } - }, - "jobDescription": { - "target": "com.amazonaws.bedrock#EvaluationJobDescription", - "traits": { - "smithy.api#documentation": "

A description of the model evaluation job.

" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.bedrock#IdempotencyToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "roleArn": { - "target": "com.amazonaws.bedrock#RoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. The service role must have Amazon Bedrock as the service principal, and provide access to any Amazon S3 buckets specified in the EvaluationConfig object. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission. To learn more about the required permissions, see Required permissions.

", - "smithy.api#required": {} - } - }, - "customerEncryptionKeyId": { - "target": "com.amazonaws.bedrock#KmsKeyId", - "traits": { - "smithy.api#documentation": "

Specify your customer managed key ARN that will be used to encrypt your model evaluation job.

" - } - }, - "jobTags": { - "target": "com.amazonaws.bedrock#TagList", - "traits": { - "smithy.api#documentation": "

Tags to attach to the model evaluation job.

" - } - }, - "evaluationConfig": { - "target": "com.amazonaws.bedrock#EvaluationConfig", - "traits": { - "smithy.api#documentation": "

Specifies whether the model evaluation job is automatic or uses human worker.

", - "smithy.api#required": {} - } - }, - "inferenceConfig": { - "target": "com.amazonaws.bedrock#EvaluationInferenceConfig", - "traits": { - "smithy.api#documentation": "

Specify the models you want to use in your model evaluation job. Automatic model evaluation jobs support a single model, and model evaluation job that use human workers support two models.

", - "smithy.api#required": {} - } - }, - "outputDataConfig": { - "target": "com.amazonaws.bedrock#EvaluationOutputDataConfig", - "traits": { - "smithy.api#documentation": "

An object that defines where the results of model evaluation job will be saved in Amazon S3.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#CreateEvaluationJobResponse": { - "type": "structure", - "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#EvaluationJobArn", - "traits": { - "smithy.api#documentation": "

The ARN of the model evaluation job.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#CreateGuardrail": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#CreateGuardrailRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#CreateGuardrailResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#TooManyTagsException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a guardrail to block topics and to implement safeguards for your generative AI applications.

\n

You can configure the following policies in a guardrail to avoid undesirable and harmful content, filter \n out denied topics and words, and remove sensitive information for privacy protection.

\n \n

In addition to the above policies, you can also configure the messages to be returned to \n the user if a user input or model response is in violation of the policies defined in the guardrail.

\n

For more information, see Guardrails for Amazon Bedrock in\n the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 202, - "method": "POST", - "uri": "/guardrails" - } - } - }, - "com.amazonaws.bedrock#CreateGuardrailRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrock#GuardrailName", - "traits": { - "smithy.api#documentation": "

The name to give the guardrail.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrock#GuardrailDescription", - "traits": { - "smithy.api#documentation": "

A description of the guardrail.

" - } - }, - "topicPolicyConfig": { - "target": "com.amazonaws.bedrock#GuardrailTopicPolicyConfig", - "traits": { - "smithy.api#documentation": "

The topic policies to configure for the guardrail.

" - } - }, - "contentPolicyConfig": { - "target": "com.amazonaws.bedrock#GuardrailContentPolicyConfig", - "traits": { - "smithy.api#documentation": "

The content filter policies to configure for the guardrail.

" - } - }, - "wordPolicyConfig": { - "target": "com.amazonaws.bedrock#GuardrailWordPolicyConfig", - "traits": { - "smithy.api#documentation": "

The word policy you configure for the guardrail.

" - } - }, - "sensitiveInformationPolicyConfig": { - "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicyConfig", - "traits": { - "smithy.api#documentation": "

The sensitive information policy to configure for the guardrail.

" - } - }, - "contextualGroundingPolicyConfig": { - "target": "com.amazonaws.bedrock#GuardrailContextualGroundingPolicyConfig", - "traits": { - "smithy.api#documentation": "

The contextual grounding policy configuration used to create a guardrail.

" - } - }, - "blockedInputMessaging": { - "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", - "traits": { - "smithy.api#documentation": "

The message to return when the guardrail blocks a prompt.

", - "smithy.api#required": {} - } - }, - "blockedOutputsMessaging": { - "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", - "traits": { - "smithy.api#documentation": "

The message to return when the guardrail blocks a model response.

", - "smithy.api#required": {} - } - }, - "kmsKeyId": { - "target": "com.amazonaws.bedrock#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The ARN of the KMS key that you use to encrypt the guardrail.

" - } - }, - "tags": { - "target": "com.amazonaws.bedrock#TagList", - "traits": { - "smithy.api#documentation": "

The tags that you want to attach to the guardrail.

" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.bedrock#IdempotencyToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request \n completes no more than once. If this token matches a previous request, \n Amazon Bedrock ignores the request, but does not return an error. \n For more information, see Ensuring \n idempotency in the Amazon S3 User Guide.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#CreateGuardrailResponse": { - "type": "structure", - "members": { - "guardrailId": { - "target": "com.amazonaws.bedrock#GuardrailId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the guardrail that was created.

", - "smithy.api#required": {} - } - }, - "guardrailArn": { - "target": "com.amazonaws.bedrock#GuardrailArn", - "traits": { - "smithy.api#documentation": "

The ARN of the guardrail.

", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrock#GuardrailDraftVersion", - "traits": { - "smithy.api#documentation": "

The version of the guardrail that was created. \n This value will always be DRAFT.

", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the guardrail was created.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#CreateGuardrailVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#CreateGuardrailVersionRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#CreateGuardrailVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a version of the guardrail. Use this API to create a snapshot of the \n guardrail when you are satisfied with a configuration, or to compare the configuration with another version.

", - "smithy.api#http": { - "code": 202, - "method": "POST", - "uri": "/guardrails/{guardrailIdentifier}" - } - } - }, - "com.amazonaws.bedrock#CreateGuardrailVersionRequest": { - "type": "structure", - "members": { - "guardrailIdentifier": { - "target": "com.amazonaws.bedrock#GuardrailIdentifier", - "traits": { - "smithy.api#documentation": "

The unique identifier of the guardrail. This can be an ID or the ARN.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrock#GuardrailDescription", - "traits": { - "smithy.api#documentation": "

A description of the guardrail version.

" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.bedrock#IdempotencyToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request \n completes no more than once. If this token matches a previous request, \n Amazon Bedrock ignores the request, but does not return an error. \n For more information, see Ensuring \n idempotency in the Amazon S3 User Guide.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#CreateGuardrailVersionResponse": { - "type": "structure", - "members": { - "guardrailId": { - "target": "com.amazonaws.bedrock#GuardrailId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the guardrail.

", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrock#GuardrailNumericalVersion", - "traits": { - "smithy.api#documentation": "

The number of the version of the guardrail.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#CreateModelCopyJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#CreateModelCopyJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#CreateModelCopyJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#TooManyTagsException" - } - ], - "traits": { - "smithy.api#documentation": "

Copies a model to another region so that it can be used there. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 201, - "method": "POST", - "uri": "/model-copy-jobs" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.bedrock#CreateModelCopyJobRequest": { - "type": "structure", - "members": { - "sourceModelArn": { - "target": "com.amazonaws.bedrock#ModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model to be copied.

", - "smithy.api#required": {} - } - }, - "targetModelName": { - "target": "com.amazonaws.bedrock#CustomModelName", - "traits": { - "smithy.api#documentation": "

A name for the copied model.

", - "smithy.api#required": {} - } - }, - "modelKmsKeyId": { - "target": "com.amazonaws.bedrock#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The ARN of the KMS key that you use to encrypt the model copy.

" - } - }, - "targetModelTags": { - "target": "com.amazonaws.bedrock#TagList", - "traits": { - "smithy.api#documentation": "

Tags to associate with the target model. For more information, see Tag resources in the Amazon Bedrock User Guide.

" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.bedrock#IdempotencyToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n\t Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#CreateModelCopyJobResponse": { - "type": "structure", - "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#ModelCopyJobArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model copy job.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#CreateModelCustomizationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#CreateModelCustomizationJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#CreateModelCustomizationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#TooManyTagsException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a fine-tuning job to customize a base model.

\n

You specify the base foundation model and the location of the training data.\n After the model-customization job completes successfully, your custom model resource will be ready to use. Amazon Bedrock returns validation loss metrics and output generations after the job completes.\n

\n

For information on the format of training and validation data, see Prepare the datasets.

\n

\n Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size.\n To monitor a job, use the GetModelCustomizationJob operation to retrieve the job status.

\n

For more information, see Custom models in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 201, - "method": "POST", - "uri": "/model-customization-jobs" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.bedrock#CreateModelCustomizationJobRequest": { - "type": "structure", - "members": { - "jobName": { - "target": "com.amazonaws.bedrock#JobName", - "traits": { - "smithy.api#documentation": "

A name for the fine-tuning job.

", - "smithy.api#required": {} - } - }, - "customModelName": { - "target": "com.amazonaws.bedrock#CustomModelName", - "traits": { - "smithy.api#documentation": "

A name for the resulting custom model.

", - "smithy.api#required": {} - } - }, - "roleArn": { - "target": "com.amazonaws.bedrock#RoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf.\n For example, during model training, Amazon Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket.\n To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission.\n

", - "smithy.api#required": {} - } - }, - "clientRequestToken": { - "target": "com.amazonaws.bedrock#IdempotencyToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "baseModelIdentifier": { - "target": "com.amazonaws.bedrock#BaseModelIdentifier", - "traits": { - "smithy.api#documentation": "

Name of the base model.

", - "smithy.api#required": {} - } - }, - "customizationType": { - "target": "com.amazonaws.bedrock#CustomizationType", - "traits": { - "smithy.api#documentation": "

The customization type.

" - } - }, - "customModelKmsKeyId": { - "target": "com.amazonaws.bedrock#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The custom model is encrypted at rest using this key.

" - } - }, - "jobTags": { - "target": "com.amazonaws.bedrock#TagList", - "traits": { - "smithy.api#documentation": "

Tags to attach to the job.

" - } - }, - "customModelTags": { - "target": "com.amazonaws.bedrock#TagList", - "traits": { - "smithy.api#documentation": "

Tags to attach to the resulting custom model.

" - } - }, - "trainingDataConfig": { - "target": "com.amazonaws.bedrock#TrainingDataConfig", - "traits": { - "smithy.api#documentation": "

Information about the training dataset.

", - "smithy.api#required": {} - } - }, - "validationDataConfig": { - "target": "com.amazonaws.bedrock#ValidationDataConfig", - "traits": { - "smithy.api#documentation": "

Information about the validation dataset.

" - } - }, - "outputDataConfig": { - "target": "com.amazonaws.bedrock#OutputDataConfig", - "traits": { - "smithy.api#documentation": "

S3 location for the output data.

", - "smithy.api#required": {} - } - }, - "hyperParameters": { - "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", - "traits": { - "smithy.api#documentation": "

Parameters related to tuning the model. For details on the format for different models, see Custom model hyperparameters.

", - "smithy.api#required": {} - } - }, - "vpcConfig": { - "target": "com.amazonaws.bedrock#VpcConfig", - "traits": { - "smithy.api#documentation": "

VPC configuration (optional). Configuration parameters for the\n private Virtual Private Cloud (VPC) that contains the resources you are using for this job.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#CreateModelCustomizationJobResponse": { - "type": "structure", - "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", - "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the fine tuning job

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#CreateModelInvocationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#CreateModelInvocationJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#CreateModelInvocationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a job to invoke a model on multiple prompts (batch inference). Format your data according to Format your inference data and upload it to an Amazon S3 bucket. For more information, see Create a batch inference job.

\n

The response returns a jobArn that you can use to stop or get details about the job. You can check the status of the job by sending a GetModelCustomizationJob request.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/model-invocation-job" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.bedrock#CreateModelInvocationJobRequest": { - "type": "structure", - "members": { - "jobName": { - "target": "com.amazonaws.bedrock#ModelInvocationJobName", - "traits": { - "smithy.api#documentation": "

A name to give the batch inference job.

", - "smithy.api#required": {} - } - }, - "roleArn": { - "target": "com.amazonaws.bedrock#RoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.

", - "smithy.api#required": {} - } - }, - "clientRequestToken": { - "target": "com.amazonaws.bedrock#ModelInvocationIdempotencyToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n\t Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", - "smithy.api#idempotencyToken": {} - } - }, - "modelId": { - "target": "com.amazonaws.bedrock#ModelId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the foundation model to use for the batch inference job.

", - "smithy.api#required": {} - } - }, - "inputDataConfig": { - "target": "com.amazonaws.bedrock#ModelInvocationJobInputDataConfig", - "traits": { - "smithy.api#documentation": "

Details about the location of the input to the batch inference job.

", - "smithy.api#required": {} - } - }, - "outputDataConfig": { - "target": "com.amazonaws.bedrock#ModelInvocationJobOutputDataConfig", - "traits": { - "smithy.api#documentation": "

Details about the location of the output of the batch inference job.

", - "smithy.api#required": {} - } - }, - "timeoutDurationInHours": { - "target": "com.amazonaws.bedrock#ModelInvocationJobTimeoutDurationInHours", - "traits": { - "smithy.api#documentation": "

The number of hours after which to force the batch inference job to time out.

" - } - }, - "tags": { - "target": "com.amazonaws.bedrock#TagList", - "traits": { - "smithy.api#documentation": "

Any tags to associate with the batch inference job. For more information, see Tagging Amazon Bedrock resources.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#CreateModelInvocationJobResponse": { - "type": "structure", - "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#ModelInvocationJobArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#CreateProvisionedModelThroughput": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughputRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughputResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#TooManyTagsException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify. For pricing details, see Amazon Bedrock Pricing. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 201, - "method": "POST", - "uri": "/provisioned-model-throughput" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.bedrock#CreateProvisionedModelThroughputRequest": { - "type": "structure", - "members": { - "clientRequestToken": { - "target": "com.amazonaws.bedrock#IdempotencyToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.

", - "smithy.api#idempotencyToken": {} - } - }, - "modelUnits": { - "target": "com.amazonaws.bedrock#PositiveInteger", - "traits": { - "smithy.api#documentation": "

Number of model units to allocate. A model unit delivers a specific throughput level for the specified model. The throughput level of a model unit specifies the total number of input and output tokens that it can process and generate within a span of one minute. By default, your account has no model units for purchasing Provisioned Throughputs with commitment. You must first visit the Amazon Web Services support center to request MUs.

\n

For model unit quotas, see Provisioned Throughput quotas in the Amazon Bedrock User Guide.

\n

For more information about what an MU specifies, contact your Amazon Web Services account manager.

", - "smithy.api#required": {} - } - }, - "provisionedModelName": { - "target": "com.amazonaws.bedrock#ProvisionedModelName", - "traits": { - "smithy.api#documentation": "

The name for this Provisioned Throughput.

", - "smithy.api#required": {} - } - }, - "modelId": { - "target": "com.amazonaws.bedrock#ModelIdentifier", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) or name of the model to associate with this Provisioned Throughput. For a list of models for which you can purchase Provisioned Throughput, see Amazon Bedrock model IDs for purchasing Provisioned Throughput in the Amazon Bedrock User Guide.

", - "smithy.api#required": {} - } - }, - "commitmentDuration": { - "target": "com.amazonaws.bedrock#CommitmentDuration", - "traits": { - "smithy.api#documentation": "

The commitment duration requested for the Provisioned Throughput. Billing occurs hourly and is discounted for longer commitment terms. To request a no-commit Provisioned Throughput, omit this field.

\n

Custom models support all levels of commitment. To see which base models support no commitment, see Supported regions and models for Provisioned Throughput in the Amazon Bedrock User Guide\n

" - } - }, - "tags": { - "target": "com.amazonaws.bedrock#TagList", - "traits": { - "smithy.api#documentation": "

Tags to associate with this Provisioned Throughput.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#CreateProvisionedModelThroughputResponse": { - "type": "structure", - "members": { - "provisionedModelArn": { - "target": "com.amazonaws.bedrock#ProvisionedModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for this Provisioned Throughput.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#CustomModelArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 1011 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12}$" - } - }, - "com.amazonaws.bedrock#CustomModelName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,63}$" - } - }, - "com.amazonaws.bedrock#CustomModelSummary": { - "type": "structure", - "members": { - "modelArn": { - "target": "com.amazonaws.bedrock#CustomModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom model.

", - "smithy.api#required": {} - } - }, - "modelName": { - "target": "com.amazonaws.bedrock#CustomModelName", - "traits": { - "smithy.api#documentation": "

The name of the custom model.

", - "smithy.api#required": {} - } - }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

Creation time of the model.

", - "smithy.api#required": {} - } - }, - "baseModelArn": { - "target": "com.amazonaws.bedrock#ModelArn", - "traits": { - "smithy.api#documentation": "

The base model Amazon Resource Name (ARN).

", - "smithy.api#required": {} - } - }, - "baseModelName": { - "target": "com.amazonaws.bedrock#ModelName", - "traits": { - "smithy.api#documentation": "

The base model name.

", - "smithy.api#required": {} - } - }, - "customizationType": { - "target": "com.amazonaws.bedrock#CustomizationType", - "traits": { - "smithy.api#documentation": "

Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.

" - } - }, - "ownerAccountId": { - "target": "com.amazonaws.bedrock#AccountId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the account that owns the model.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Summary information for a custom model.

" - } - }, - "com.amazonaws.bedrock#CustomModelSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#CustomModelSummary" - } - }, - "com.amazonaws.bedrock#CustomizationType": { - "type": "enum", - "members": { - "FINE_TUNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FINE_TUNING" - } - }, - "CONTINUED_PRE_TRAINING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTINUED_PRE_TRAINING" - } - } - } - }, - "com.amazonaws.bedrock#DeleteCustomModel": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#DeleteCustomModelRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#DeleteCustomModelResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/custom-models/{modelIdentifier}" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.bedrock#DeleteCustomModelRequest": { - "type": "structure", - "members": { - "modelIdentifier": { - "target": "com.amazonaws.bedrock#ModelIdentifier", - "traits": { - "smithy.api#documentation": "

Name of the model to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#DeleteCustomModelResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#DeleteGuardrail": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#DeleteGuardrailRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#DeleteGuardrailResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a guardrail.

\n ", - "smithy.api#http": { - "code": 202, - "method": "DELETE", - "uri": "/guardrails/{guardrailIdentifier}" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.bedrock#DeleteGuardrailRequest": { - "type": "structure", - "members": { - "guardrailIdentifier": { - "target": "com.amazonaws.bedrock#GuardrailIdentifier", - "traits": { - "smithy.api#documentation": "

The unique identifier of the guardrail. This can be an ID or the ARN.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "guardrailVersion": { - "target": "com.amazonaws.bedrock#GuardrailNumericalVersion", - "traits": { - "smithy.api#documentation": "

The version of the guardrail.

", - "smithy.api#httpQuery": "guardrailVersion" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#DeleteGuardrailResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Delete the invocation logging.

", - "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/logging/modelinvocations" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#DeleteProvisionedModelThroughput": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#DeleteProvisionedModelThroughputRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#DeleteProvisionedModelThroughputResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a Provisioned Throughput. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 200, - "method": "DELETE", - "uri": "/provisioned-model-throughput/{provisionedModelId}" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.bedrock#DeleteProvisionedModelThroughputRequest": { - "type": "structure", - "members": { - "provisionedModelId": { - "target": "com.amazonaws.bedrock#ProvisionedModelId", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) or name of the Provisioned Throughput.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#DeleteProvisionedModelThroughputResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#ErrorMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - } - } - }, - "com.amazonaws.bedrock#ErrorMessages": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#ErrorMessage" - }, - "traits": { - "smithy.api#length": { - "max": 20 - } - } - }, - "com.amazonaws.bedrock#EvaluationBedrockModel": { - "type": "structure", - "members": { - "modelIdentifier": { - "target": "com.amazonaws.bedrock#EvaluationModelIdentifier", - "traits": { - "smithy.api#documentation": "

The ARN of the Amazon Bedrock model specified.

", - "smithy.api#required": {} - } - }, - "inferenceParams": { - "target": "com.amazonaws.bedrock#EvaluationModelInferenceParams", - "traits": { - "smithy.api#documentation": "

Each Amazon Bedrock support different inference parameters that change how the model behaves during inference.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the ARN of the Amazon Bedrock models specified in your model evaluation job. Each Amazon Bedrock model supports different inferenceParams. To learn more about supported inference parameters for Amazon Bedrock models, see Inference parameters for foundation models.

\n

The inferenceParams are specified using JSON. To successfully insert JSON as string make sure that all quotations are properly escaped. For example, \"temperature\":\"0.25\" key value pair would need to be formatted as \\\"temperature\\\":\\\"0.25\\\" to successfully accepted in the request.

" - } - }, - "com.amazonaws.bedrock#EvaluationConfig": { - "type": "union", - "members": { - "automated": { - "target": "com.amazonaws.bedrock#AutomatedEvaluationConfig", - "traits": { - "smithy.api#documentation": "

Used to specify an automated model evaluation job.\n See AutomatedEvaluationConfig to view the required parameters.

" - } - }, - "human": { - "target": "com.amazonaws.bedrock#HumanEvaluationConfig", - "traits": { - "smithy.api#documentation": "

Used to specify a model evaluation job that uses human workers.See HumanEvaluationConfig to view the required parameters.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Used to specify either a AutomatedEvaluationConfig or HumanEvaluationConfig object.

" - } - }, - "com.amazonaws.bedrock#EvaluationDataset": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrock#EvaluationDatasetName", - "traits": { - "smithy.api#documentation": "

Used to specify supported built-in prompt datasets. Valid values are Builtin.Bold, Builtin.BoolQ, Builtin.NaturalQuestions, Builtin.Gigaword, Builtin.RealToxicityPrompts, Builtin.TriviaQa, Builtin.T-Rex, Builtin.WomensEcommerceClothingReviews and Builtin.Wikitext2.

", - "smithy.api#required": {} - } - }, - "datasetLocation": { - "target": "com.amazonaws.bedrock#EvaluationDatasetLocation", - "traits": { - "smithy.api#documentation": "

For custom prompt datasets, you must specify the location in Amazon S3 where the prompt dataset is saved.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Used to specify the name of a built-in prompt dataset and optionally, the Amazon S3 bucket where a custom prompt dataset is saved.

" - } - }, - "com.amazonaws.bedrock#EvaluationDatasetLocation": { - "type": "union", - "members": { - "s3Uri": { - "target": "com.amazonaws.bedrock#S3Uri", - "traits": { - "smithy.api#documentation": "

The S3 URI of the S3 bucket specified in the job.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The location in Amazon S3 where your prompt dataset is stored.

" - } - }, - "com.amazonaws.bedrock#EvaluationDatasetMetricConfig": { - "type": "structure", - "members": { - "taskType": { - "target": "com.amazonaws.bedrock#EvaluationTaskType", - "traits": { - "smithy.api#documentation": "

The task type you want the model to carry out.

", - "smithy.api#required": {} - } - }, - "dataset": { - "target": "com.amazonaws.bedrock#EvaluationDataset", - "traits": { - "smithy.api#documentation": "

Specifies the prompt dataset.

", - "smithy.api#required": {} - } - }, - "metricNames": { - "target": "com.amazonaws.bedrock#EvaluationMetricNames", - "traits": { - "smithy.api#documentation": "

The names of the metrics used. For automated model evaluation jobs valid values are \"Builtin.Accuracy\", \"Builtin.Robustness\", and \"Builtin.Toxicity\". In human-based model evaluation jobs the array of strings must match the name parameter specified in HumanEvaluationCustomMetric.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines the built-in prompt datasets, built-in metric names and custom metric names, and the task type.

" - } - }, - "com.amazonaws.bedrock#EvaluationDatasetMetricConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#EvaluationDatasetMetricConfig" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.bedrock#EvaluationDatasetName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[0-9a-zA-Z-_.]+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrock#EvaluationInferenceConfig": { - "type": "union", - "members": { - "models": { - "target": "com.amazonaws.bedrock#EvaluationModelConfigs", - "traits": { - "smithy.api#documentation": "

Used to specify the models.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Used to define the models you want used in your model evaluation job. Automated model evaluation jobs support only a single model. In a human-based model evaluation job, your annotator can compare the responses for up to two different models.

" - } - }, - "com.amazonaws.bedrock#EvaluationJobArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 1011 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12}$" - } - }, - "com.amazonaws.bedrock#EvaluationJobDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - }, - "smithy.api#pattern": "^.+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrock#EvaluationJobIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 1011 - }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12})$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrock#EvaluationJobName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-z0-9](-*[a-z0-9]){0,62}$" - } - }, - "com.amazonaws.bedrock#EvaluationJobResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrock#CreateEvaluationJob" - }, - { - "target": "com.amazonaws.bedrock#GetEvaluationJob" - }, - { - "target": "com.amazonaws.bedrock#ListEvaluationJobs" - }, - { - "target": "com.amazonaws.bedrock#StopEvaluationJob" - } - ] - }, - "com.amazonaws.bedrock#EvaluationJobStatus": { - "type": "enum", - "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "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" - } - } - } - }, - "com.amazonaws.bedrock#EvaluationJobType": { - "type": "enum", - "members": { - "HUMAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Human" - } - }, - "AUTOMATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Automated" - } - } - } - }, - "com.amazonaws.bedrock#EvaluationMetricDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^.+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrock#EvaluationMetricName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[0-9a-zA-Z-_.]+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrock#EvaluationMetricNames": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#EvaluationMetricName" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.bedrock#EvaluationModelConfig": { - "type": "union", - "members": { - "bedrockModel": { - "target": "com.amazonaws.bedrock#EvaluationBedrockModel", - "traits": { - "smithy.api#documentation": "

Defines the Amazon Bedrock model and inference parameters you want used.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines the models used in the model evaluation job.

" - } - }, - "com.amazonaws.bedrock#EvaluationModelConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#EvaluationModelConfig" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2 - } - } - }, - "com.amazonaws.bedrock#EvaluationModelIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$" - } - }, - "com.amazonaws.bedrock#EvaluationModelIdentifiers": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#EvaluationModelIdentifier" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2 - } - } - }, - "com.amazonaws.bedrock#EvaluationModelInferenceParams": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1023 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrock#EvaluationOutputDataConfig": { - "type": "structure", - "members": { - "s3Uri": { - "target": "com.amazonaws.bedrock#S3Uri", - "traits": { - "smithy.api#documentation": "

The Amazon S3 URI where the results of model evaluation job are saved.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The Amazon S3 location where the results of your model evaluation job are saved.

" - } - }, - "com.amazonaws.bedrock#EvaluationRatingMethod": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^[0-9a-zA-Z-_]+$" - } - }, - "com.amazonaws.bedrock#EvaluationSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#EvaluationSummary" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.bedrock#EvaluationSummary": { - "type": "structure", - "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#EvaluationJobArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model evaluation job.

", - "smithy.api#required": {} - } - }, - "jobName": { - "target": "com.amazonaws.bedrock#EvaluationJobName", - "traits": { - "smithy.api#documentation": "

The name of the model evaluation job.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrock#EvaluationJobStatus", - "traits": { - "smithy.api#documentation": "

The current status of the model evaluation job.

", - "smithy.api#required": {} - } - }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

When the model evaluation job was created.

", - "smithy.api#required": {} - } - }, - "jobType": { - "target": "com.amazonaws.bedrock#EvaluationJobType", - "traits": { - "smithy.api#documentation": "

The type, either human or automatic, of model evaluation job.

", - "smithy.api#required": {} - } - }, - "evaluationTaskTypes": { - "target": "com.amazonaws.bedrock#EvaluationTaskTypes", - "traits": { - "smithy.api#documentation": "

What task type was used in the model evaluation job.

", - "smithy.api#required": {} - } - }, - "modelIdentifiers": { - "target": "com.amazonaws.bedrock#EvaluationModelIdentifiers", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the model(s) used in the model evaluation job.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A summary of the model evaluation job.

" - } - }, - "com.amazonaws.bedrock#EvaluationTaskType": { - "type": "enum", - "members": { - "SUMMARIZATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Summarization" - } - }, - "CLASSIFICATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Classification" - } - }, - "QUESTION_AND_ANSWER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QuestionAndAnswer" - } - }, - "GENERATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Generation" - } - }, - "CUSTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Custom" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[A-Za-z0-9]+$" - } - }, - "com.amazonaws.bedrock#EvaluationTaskTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#EvaluationTaskType" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.bedrock#FineTuningJobStatus": { - "type": "enum", - "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "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" - } - } - } - }, - "com.amazonaws.bedrock#FoundationModelArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$" - } - }, - "com.amazonaws.bedrock#FoundationModelDetails": { - "type": "structure", - "members": { - "modelArn": { - "target": "com.amazonaws.bedrock#FoundationModelArn", - "traits": { - "smithy.api#documentation": "

The model Amazon Resource Name (ARN).

", - "smithy.api#required": {} - } - }, - "modelId": { - "target": "com.amazonaws.bedrock#BedrockModelId", - "traits": { - "smithy.api#documentation": "

The model identifier.

", - "smithy.api#required": {} - } - }, - "modelName": { - "target": "com.amazonaws.bedrock#BrandedName", - "traits": { - "smithy.api#documentation": "

The model name.

" - } - }, - "providerName": { - "target": "com.amazonaws.bedrock#BrandedName", - "traits": { - "smithy.api#documentation": "

The model's provider name.

" - } - }, - "inputModalities": { - "target": "com.amazonaws.bedrock#ModelModalityList", - "traits": { - "smithy.api#documentation": "

The input modalities that the model supports.

" - } - }, - "outputModalities": { - "target": "com.amazonaws.bedrock#ModelModalityList", - "traits": { - "smithy.api#documentation": "

The output modalities that the model supports.

" - } - }, - "responseStreamingSupported": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the model supports streaming.

" - } - }, - "customizationsSupported": { - "target": "com.amazonaws.bedrock#ModelCustomizationList", - "traits": { - "smithy.api#documentation": "

The customization that the model supports.

" - } - }, - "inferenceTypesSupported": { - "target": "com.amazonaws.bedrock#InferenceTypeList", - "traits": { - "smithy.api#documentation": "

The inference types that the model supports.

" - } - }, - "modelLifecycle": { - "target": "com.amazonaws.bedrock#FoundationModelLifecycle", - "traits": { - "smithy.api#documentation": "

Contains details about whether a model version is available or deprecated

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a foundation model.

" - } - }, - "com.amazonaws.bedrock#FoundationModelLifecycle": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.bedrock#FoundationModelLifecycleStatus", - "traits": { - "smithy.api#documentation": "

Specifies whether a model version is available (ACTIVE) or deprecated (LEGACY.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about whether a model version is available or deprecated.

" - } - }, - "com.amazonaws.bedrock#FoundationModelLifecycleStatus": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "LEGACY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LEGACY" - } - } - } - }, - "com.amazonaws.bedrock#FoundationModelSummary": { - "type": "structure", - "members": { - "modelArn": { - "target": "com.amazonaws.bedrock#FoundationModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the foundation model.

", - "smithy.api#required": {} - } - }, - "modelId": { - "target": "com.amazonaws.bedrock#BedrockModelId", - "traits": { - "smithy.api#documentation": "

The model ID of the foundation model.

", - "smithy.api#required": {} - } - }, - "modelName": { - "target": "com.amazonaws.bedrock#BrandedName", - "traits": { - "smithy.api#documentation": "

The name of the model.

" - } - }, - "providerName": { - "target": "com.amazonaws.bedrock#BrandedName", - "traits": { - "smithy.api#documentation": "

The model's provider name.

" - } - }, - "inputModalities": { - "target": "com.amazonaws.bedrock#ModelModalityList", - "traits": { - "smithy.api#documentation": "

The input modalities that the model supports.

" - } - }, - "outputModalities": { - "target": "com.amazonaws.bedrock#ModelModalityList", - "traits": { - "smithy.api#documentation": "

The output modalities that the model supports.

" - } - }, - "responseStreamingSupported": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates whether the model supports streaming.

" - } - }, - "customizationsSupported": { - "target": "com.amazonaws.bedrock#ModelCustomizationList", - "traits": { - "smithy.api#documentation": "

Whether the model supports fine-tuning or continual pre-training.

" - } - }, - "inferenceTypesSupported": { - "target": "com.amazonaws.bedrock#InferenceTypeList", - "traits": { - "smithy.api#documentation": "

The inference types that the model supports.

" - } - }, - "modelLifecycle": { - "target": "com.amazonaws.bedrock#FoundationModelLifecycle", - "traits": { - "smithy.api#documentation": "

Contains details about whether a model version is available or deprecated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Summary information for a foundation model.

" - } - }, - "com.amazonaws.bedrock#FoundationModelSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#FoundationModelSummary" - } - }, - "com.amazonaws.bedrock#GetCustomModel": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#GetCustomModelRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#GetCustomModelResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Get the properties associated with a Amazon Bedrock custom model that you have created.For more information, see Custom models in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/custom-models/{modelIdentifier}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.bedrock#GetCustomModelRequest": { - "type": "structure", - "members": { - "modelIdentifier": { - "target": "com.amazonaws.bedrock#ModelIdentifier", - "traits": { - "smithy.api#documentation": "

Name or Amazon Resource Name (ARN) of the custom model.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#GetCustomModelResponse": { - "type": "structure", - "members": { - "modelArn": { - "target": "com.amazonaws.bedrock#ModelArn", - "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) associated with this model.

", - "smithy.api#required": {} - } - }, - "modelName": { - "target": "com.amazonaws.bedrock#CustomModelName", - "traits": { - "smithy.api#documentation": "

Model name associated with this model.

", - "smithy.api#required": {} - } - }, - "jobName": { - "target": "com.amazonaws.bedrock#JobName", - "traits": { - "smithy.api#documentation": "

Job name associated with this model.

" - } - }, - "jobArn": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", - "traits": { - "smithy.api#documentation": "

Job Amazon Resource Name (ARN) associated with this model.

", - "smithy.api#required": {} - } - }, - "baseModelArn": { - "target": "com.amazonaws.bedrock#ModelArn", - "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the base model.

", - "smithy.api#required": {} - } - }, - "customizationType": { - "target": "com.amazonaws.bedrock#CustomizationType", - "traits": { - "smithy.api#documentation": "

The type of model customization.

" - } - }, - "modelKmsKeyArn": { - "target": "com.amazonaws.bedrock#KmsKeyArn", - "traits": { - "smithy.api#documentation": "

The custom model is encrypted at rest using this key.

" - } - }, - "hyperParameters": { - "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", - "traits": { - "smithy.api#documentation": "

Hyperparameter values associated with this model. For details on the format for different models, see Custom model hyperparameters.

" - } - }, - "trainingDataConfig": { - "target": "com.amazonaws.bedrock#TrainingDataConfig", - "traits": { - "smithy.api#documentation": "

Contains information about the training dataset.

", - "smithy.api#required": {} - } - }, - "validationDataConfig": { - "target": "com.amazonaws.bedrock#ValidationDataConfig", - "traits": { - "smithy.api#documentation": "

Contains information about the validation dataset.

" - } - }, - "outputDataConfig": { - "target": "com.amazonaws.bedrock#OutputDataConfig", - "traits": { - "smithy.api#documentation": "

Output data configuration associated with this custom model.

", - "smithy.api#required": {} - } - }, - "trainingMetrics": { - "target": "com.amazonaws.bedrock#TrainingMetrics", - "traits": { - "smithy.api#documentation": "

Contains training metrics from the job creation.

" - } - }, - "validationMetrics": { - "target": "com.amazonaws.bedrock#ValidationMetrics", - "traits": { - "smithy.api#documentation": "

The validation metrics from the job creation.

" - } - }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

Creation time of the model.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#GetEvaluationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#GetEvaluationJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#GetEvaluationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves the properties associated with a model evaluation job, including the\n status of the job. For more information, see Model evaluation.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/evaluation-jobs/{jobIdentifier}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.bedrock#GetEvaluationJobRequest": { - "type": "structure", - "members": { - "jobIdentifier": { - "target": "com.amazonaws.bedrock#EvaluationJobIdentifier", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model evaluation job.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#GetEvaluationJobResponse": { - "type": "structure", - "members": { - "jobName": { - "target": "com.amazonaws.bedrock#EvaluationJobName", - "traits": { - "smithy.api#documentation": "

The name of the model evaluation job.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrock#EvaluationJobStatus", - "traits": { - "smithy.api#documentation": "

The status of the model evaluation job.

", - "smithy.api#required": {} - } - }, - "jobArn": { - "target": "com.amazonaws.bedrock#EvaluationJobArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model evaluation job.

", - "smithy.api#required": {} - } - }, - "jobDescription": { - "target": "com.amazonaws.bedrock#EvaluationJobDescription", - "traits": { - "smithy.api#documentation": "

The description of the model evaluation job.

" - } - }, - "roleArn": { - "target": "com.amazonaws.bedrock#RoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM service role used in the model evaluation job.

", - "smithy.api#required": {} - } - }, - "customerEncryptionKeyId": { - "target": "com.amazonaws.bedrock#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customer managed key specified when the model evaluation job was created.

" - } - }, - "jobType": { - "target": "com.amazonaws.bedrock#EvaluationJobType", - "traits": { - "smithy.api#documentation": "

The type of model evaluation job.

", - "smithy.api#required": {} - } - }, - "evaluationConfig": { - "target": "com.amazonaws.bedrock#EvaluationConfig", - "traits": { - "smithy.api#documentation": "

Contains details about the type of model evaluation job, the metrics used, the task type selected, the datasets used, and any custom metrics you defined.

", - "smithy.api#required": {} - } - }, - "inferenceConfig": { - "target": "com.amazonaws.bedrock#EvaluationInferenceConfig", - "traits": { - "smithy.api#documentation": "

Details about the models you specified in your model evaluation job.

", - "smithy.api#required": {} - } - }, - "outputDataConfig": { - "target": "com.amazonaws.bedrock#EvaluationOutputDataConfig", - "traits": { - "smithy.api#documentation": "

Amazon S3 location for where output data is saved.

", - "smithy.api#required": {} - } - }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

When the model evaluation job was created.

", - "smithy.api#required": {} - } - }, - "lastModifiedTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

When the model evaluation job was last modified.

" - } - }, - "failureMessages": { - "target": "com.amazonaws.bedrock#ErrorMessages", - "traits": { - "smithy.api#documentation": "

An array of strings the specify why the model evaluation job has failed.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#GetFoundationModel": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#GetFoundationModelRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#GetFoundationModelResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Get details about a Amazon Bedrock foundation model.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/foundation-models/{modelIdentifier}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.bedrock#GetFoundationModelRequest": { - "type": "structure", - "members": { - "modelIdentifier": { - "target": "com.amazonaws.bedrock#ModelIdentifier", - "traits": { - "smithy.api#documentation": "

The model identifier.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#GetFoundationModelResponse": { - "type": "structure", - "members": { - "modelDetails": { - "target": "com.amazonaws.bedrock#FoundationModelDetails", - "traits": { - "smithy.api#documentation": "

Information about the foundation model.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#GetGuardrail": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#GetGuardrailRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#GetGuardrailResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets details about a guardrail. If you don't specify a version, the response returns details for the DRAFT version.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/guardrails/{guardrailIdentifier}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.bedrock#GetGuardrailRequest": { - "type": "structure", - "members": { - "guardrailIdentifier": { - "target": "com.amazonaws.bedrock#GuardrailIdentifier", - "traits": { - "smithy.api#documentation": "

The unique identifier of the guardrail for which to get details. This can be an ID or the ARN.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "guardrailVersion": { - "target": "com.amazonaws.bedrock#GuardrailVersion", - "traits": { - "smithy.api#documentation": "

The version of the guardrail for which to get details. If you don't specify a version, the response returns details for the DRAFT version.

", - "smithy.api#httpQuery": "guardrailVersion" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#GetGuardrailResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrock#GuardrailName", - "traits": { - "smithy.api#documentation": "

The name of the guardrail.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrock#GuardrailDescription", - "traits": { - "smithy.api#documentation": "

The description of the guardrail.

" - } - }, - "guardrailId": { - "target": "com.amazonaws.bedrock#GuardrailId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the guardrail.

", - "smithy.api#required": {} - } - }, - "guardrailArn": { - "target": "com.amazonaws.bedrock#GuardrailArn", - "traits": { - "smithy.api#documentation": "

The ARN of the guardrail.

", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrock#GuardrailVersion", - "traits": { - "smithy.api#documentation": "

The version of the guardrail.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrock#GuardrailStatus", - "traits": { - "smithy.api#documentation": "

The status of the guardrail.

", - "smithy.api#required": {} - } - }, - "topicPolicy": { - "target": "com.amazonaws.bedrock#GuardrailTopicPolicy", - "traits": { - "smithy.api#documentation": "

The topic policy that was configured for the guardrail.

" - } - }, - "contentPolicy": { - "target": "com.amazonaws.bedrock#GuardrailContentPolicy", - "traits": { - "smithy.api#documentation": "

The content policy that was configured for the guardrail.

" - } - }, - "wordPolicy": { - "target": "com.amazonaws.bedrock#GuardrailWordPolicy", - "traits": { - "smithy.api#documentation": "

The word policy that was configured for the guardrail.

" - } - }, - "sensitiveInformationPolicy": { - "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicy", - "traits": { - "smithy.api#documentation": "

The sensitive information policy that was configured for the guardrail.

" - } - }, - "contextualGroundingPolicy": { - "target": "com.amazonaws.bedrock#GuardrailContextualGroundingPolicy", - "traits": { - "smithy.api#documentation": "

The contextual grounding policy used in the guardrail.

" - } - }, - "createdAt": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time at which the guardrail was created.

", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time at which the guardrail was updated.

", - "smithy.api#required": {} - } - }, - "statusReasons": { - "target": "com.amazonaws.bedrock#GuardrailStatusReasons", - "traits": { - "smithy.api#documentation": "

Appears if the status is FAILED. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.

" - } - }, - "failureRecommendations": { - "target": "com.amazonaws.bedrock#GuardrailFailureRecommendations", - "traits": { - "smithy.api#documentation": "

Appears if the status of the guardrail is FAILED. A list of recommendations to carry out before retrying the request.

" - } - }, - "blockedInputMessaging": { - "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", - "traits": { - "smithy.api#documentation": "

The message that the guardrail returns when it blocks a prompt.

", - "smithy.api#required": {} - } - }, - "blockedOutputsMessaging": { - "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", - "traits": { - "smithy.api#documentation": "

The message that the guardrail returns when it blocks a model response.

", - "smithy.api#required": {} - } - }, - "kmsKeyArn": { - "target": "com.amazonaws.bedrock#KmsKeyArn", - "traits": { - "smithy.api#documentation": "

The ARN of the KMS key that encrypts the guardrail.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#GetModelCopyJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#GetModelCopyJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#GetModelCopyJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves information about a model copy job. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/model-copy-jobs/{jobArn}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.bedrock#GetModelCopyJobRequest": { - "type": "structure", - "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#ModelCopyJobArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model copy job.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#GetModelCopyJobResponse": { - "type": "structure", - "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#ModelCopyJobArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model copy job.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrock#ModelCopyJobStatus", - "traits": { - "smithy.api#documentation": "

The status of the model copy job.

", - "smithy.api#required": {} - } - }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the model copy job was created.

", - "smithy.api#required": {} - } - }, - "targetModelArn": { - "target": "com.amazonaws.bedrock#CustomModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the copied model.

", - "smithy.api#required": {} - } - }, - "targetModelName": { - "target": "com.amazonaws.bedrock#CustomModelName", - "traits": { - "smithy.api#documentation": "

The name of the copied model.

" - } - }, - "sourceAccountId": { - "target": "com.amazonaws.bedrock#AccountId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the account that the model being copied originated from.

", - "smithy.api#required": {} - } - }, - "sourceModelArn": { - "target": "com.amazonaws.bedrock#ModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the original model being copied.

", - "smithy.api#required": {} - } - }, - "targetModelKmsKeyArn": { - "target": "com.amazonaws.bedrock#KmsKeyArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key encrypting the copied model.

" - } - }, - "targetModelTags": { - "target": "com.amazonaws.bedrock#TagList", - "traits": { - "smithy.api#documentation": "

The tags associated with the copied model.

" - } - }, - "failureMessage": { - "target": "com.amazonaws.bedrock#ErrorMessage", - "traits": { - "smithy.api#documentation": "

An error message for why the model copy job failed.

" - } - }, - "sourceModelName": { - "target": "com.amazonaws.bedrock#CustomModelName", - "traits": { - "smithy.api#documentation": "

The name of the original model being copied.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#GetModelCustomizationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#GetModelCustomizationJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#GetModelCustomizationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves the properties associated with a model-customization job, including the status of the job.\n For more information, see Custom models in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/model-customization-jobs/{jobIdentifier}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.bedrock#GetModelCustomizationJobRequest": { - "type": "structure", - "members": { - "jobIdentifier": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobIdentifier", - "traits": { - "smithy.api#documentation": "

Identifier for the customization job.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#GetModelCustomizationJobResponse": { - "type": "structure", - "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customization job.

", - "smithy.api#required": {} - } - }, - "jobName": { - "target": "com.amazonaws.bedrock#JobName", - "traits": { - "smithy.api#documentation": "

The name of the customization job.

", - "smithy.api#required": {} - } - }, - "outputModelName": { - "target": "com.amazonaws.bedrock#CustomModelName", - "traits": { - "smithy.api#documentation": "

The name of the output model.

", - "smithy.api#required": {} - } - }, - "outputModelArn": { - "target": "com.amazonaws.bedrock#CustomModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the output model.

" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.bedrock#IdempotencyToken", - "traits": { - "smithy.api#documentation": "

The token that you specified in the CreateCustomizationJob request.

" - } - }, - "roleArn": { - "target": "com.amazonaws.bedrock#RoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobStatus", - "traits": { - "smithy.api#documentation": "

The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use.\n If the job failed, the failure message contains information about why the job failed.

" - } - }, - "failureMessage": { - "target": "com.amazonaws.bedrock#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Information about why the job failed.

" - } - }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

Time that the resource was created.

", - "smithy.api#required": {} - } - }, - "lastModifiedTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

Time that the resource was last modified.

" - } - }, - "endTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

Time that the resource transitioned to terminal state.

" - } - }, - "baseModelArn": { - "target": "com.amazonaws.bedrock#FoundationModelArn", - "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the base model.

", - "smithy.api#required": {} - } - }, - "hyperParameters": { - "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", - "traits": { - "smithy.api#documentation": "

The hyperparameter values for the job. For details on the format for different models, see Custom model hyperparameters.

", - "smithy.api#required": {} - } - }, - "trainingDataConfig": { - "target": "com.amazonaws.bedrock#TrainingDataConfig", - "traits": { - "smithy.api#documentation": "

Contains information about the training dataset.

", - "smithy.api#required": {} - } - }, - "validationDataConfig": { - "target": "com.amazonaws.bedrock#ValidationDataConfig", - "traits": { - "smithy.api#documentation": "

Contains information about the validation dataset.

", - "smithy.api#required": {} - } - }, - "outputDataConfig": { - "target": "com.amazonaws.bedrock#OutputDataConfig", - "traits": { - "smithy.api#documentation": "

Output data configuration

", - "smithy.api#required": {} - } - }, - "customizationType": { - "target": "com.amazonaws.bedrock#CustomizationType", - "traits": { - "smithy.api#documentation": "

The type of model customization.

" - } - }, - "outputModelKmsKeyArn": { - "target": "com.amazonaws.bedrock#KmsKeyArn", - "traits": { - "smithy.api#documentation": "

The custom model is encrypted at rest using this key.

" - } - }, - "trainingMetrics": { - "target": "com.amazonaws.bedrock#TrainingMetrics", - "traits": { - "smithy.api#documentation": "

Contains training metrics from the job creation.

" - } - }, - "validationMetrics": { - "target": "com.amazonaws.bedrock#ValidationMetrics", - "traits": { - "smithy.api#documentation": "

The loss metric for each validator that you provided in the createjob request.

" - } - }, - "vpcConfig": { - "target": "com.amazonaws.bedrock#VpcConfig", - "traits": { - "smithy.api#documentation": "

VPC configuration for the custom model job.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#GetModelInvocationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#GetModelInvocationJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#GetModelInvocationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets details about a batch inference job. For more information, see View details about a batch inference job\n

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/model-invocation-job/{jobIdentifier}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.bedrock#GetModelInvocationJobRequest": { - "type": "structure", - "members": { - "jobIdentifier": { - "target": "com.amazonaws.bedrock#ModelInvocationJobIdentifier", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#GetModelInvocationJobResponse": { - "type": "structure", - "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#ModelInvocationJobArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job.

", - "smithy.api#required": {} - } - }, - "jobName": { - "target": "com.amazonaws.bedrock#ModelInvocationJobName", - "traits": { - "smithy.api#documentation": "

The name of the batch inference job.

" - } - }, - "modelId": { - "target": "com.amazonaws.bedrock#ModelId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the foundation model used for model inference.

", - "smithy.api#required": {} - } - }, - "clientRequestToken": { - "target": "com.amazonaws.bedrock#ModelInvocationIdempotencyToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n\t Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

" - } - }, - "roleArn": { - "target": "com.amazonaws.bedrock#RoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrock#ModelInvocationJobStatus", - "traits": { - "smithy.api#documentation": "

The status of the batch inference job.

" - } - }, - "message": { - "target": "com.amazonaws.bedrock#Message", - "traits": { - "smithy.api#documentation": "

If the batch inference job failed, this field contains a message describing why the job failed.

" - } - }, - "submitTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the batch inference job was submitted.

", - "smithy.api#required": {} - } - }, - "lastModifiedTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the batch inference job was last modified.

" - } - }, - "endTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the batch inference job ended.

" - } - }, - "inputDataConfig": { - "target": "com.amazonaws.bedrock#ModelInvocationJobInputDataConfig", - "traits": { - "smithy.api#documentation": "

Details about the location of the input to the batch inference job.

", - "smithy.api#required": {} - } - }, - "outputDataConfig": { - "target": "com.amazonaws.bedrock#ModelInvocationJobOutputDataConfig", - "traits": { - "smithy.api#documentation": "

Details about the location of the output of the batch inference job.

", - "smithy.api#required": {} - } - }, - "timeoutDurationInHours": { - "target": "com.amazonaws.bedrock#ModelInvocationJobTimeoutDurationInHours", - "traits": { - "smithy.api#documentation": "

The number of hours after which batch inference job was set to time out.

" - } - }, - "jobExpirationTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the batch inference job times or timed out.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#GetModelInvocationLoggingConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Get the current configuration values for model invocation logging.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/logging/modelinvocations" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationResponse": { - "type": "structure", - "members": { - "loggingConfig": { - "target": "com.amazonaws.bedrock#LoggingConfig", - "traits": { - "smithy.api#documentation": "

The current configuration values.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#GetProvisionedModelThroughput": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#GetProvisionedModelThroughputRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#GetProvisionedModelThroughputResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/provisioned-model-throughput/{provisionedModelId}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.bedrock#GetProvisionedModelThroughputRequest": { - "type": "structure", - "members": { - "provisionedModelId": { - "target": "com.amazonaws.bedrock#ProvisionedModelId", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) or name of the Provisioned Throughput.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#GetProvisionedModelThroughputResponse": { - "type": "structure", - "members": { - "modelUnits": { - "target": "com.amazonaws.bedrock#PositiveInteger", - "traits": { - "smithy.api#documentation": "

The number of model units allocated to this Provisioned Throughput.

", - "smithy.api#required": {} - } - }, - "desiredModelUnits": { - "target": "com.amazonaws.bedrock#PositiveInteger", - "traits": { - "smithy.api#documentation": "

The number of model units that was requested for this Provisioned Throughput.

", - "smithy.api#required": {} - } - }, - "provisionedModelName": { - "target": "com.amazonaws.bedrock#ProvisionedModelName", - "traits": { - "smithy.api#documentation": "

The name of the Provisioned Throughput.

", - "smithy.api#required": {} - } - }, - "provisionedModelArn": { - "target": "com.amazonaws.bedrock#ProvisionedModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Provisioned Throughput.

", - "smithy.api#required": {} - } - }, - "modelArn": { - "target": "com.amazonaws.bedrock#ModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model associated with this Provisioned Throughput.

", - "smithy.api#required": {} - } - }, - "desiredModelArn": { - "target": "com.amazonaws.bedrock#ModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value differs from the modelArn if updating hasn't completed.

", - "smithy.api#required": {} - } - }, - "foundationModelArn": { - "target": "com.amazonaws.bedrock#FoundationModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrock#ProvisionedModelStatus", - "traits": { - "smithy.api#documentation": "

The status of the Provisioned Throughput.

", - "smithy.api#required": {} - } - }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp of the creation time for this Provisioned Throughput.

", - "smithy.api#required": {} - } - }, - "lastModifiedTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp of the last time that this Provisioned Throughput was modified.

", - "smithy.api#required": {} - } - }, - "failureMessage": { - "target": "com.amazonaws.bedrock#ErrorMessage", - "traits": { - "smithy.api#documentation": "

A failure message for any issues that occurred during creation, updating, or deletion of the Provisioned Throughput.

" - } - }, - "commitmentDuration": { - "target": "com.amazonaws.bedrock#CommitmentDuration", - "traits": { - "smithy.api#documentation": "

Commitment duration of the Provisioned Throughput.

" - } - }, - "commitmentExpirationTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp for when the commitment term for the Provisioned Throughput expires.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#GuardrailArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+$" - } - }, - "com.amazonaws.bedrock#GuardrailBlockedMessaging": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 500 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrock#GuardrailContentFilter": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.bedrock#GuardrailContentFilterType", - "traits": { - "smithy.api#documentation": "

The harmful category that the content filter is applied to.

", - "smithy.api#required": {} - } - }, - "inputStrength": { - "target": "com.amazonaws.bedrock#GuardrailFilterStrength", - "traits": { - "smithy.api#documentation": "

The strength of the content filter to apply to prompts. As you\n increase the filter strength, the likelihood of filtering harmful content increases\n and the probability of seeing harmful content in your application reduces.

", - "smithy.api#required": {} - } - }, - "outputStrength": { - "target": "com.amazonaws.bedrock#GuardrailFilterStrength", - "traits": { - "smithy.api#documentation": "

The strength of the content filter to apply to model responses. As you\n increase the filter strength, the likelihood of filtering harmful content increases\n and the probability of seeing harmful content in your application reduces.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.

\n \n

Content filtering depends on the confidence classification of user inputs and FM\n responses across each of the four harmful categories. All input and output statements are\n classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each\n harmful category. For example, if a statement is classified as\n Hate with HIGH confidence, the likelihood of the statement\n representing hateful content is high. A single statement can be classified across\n multiple categories with varying confidence levels. For example, a single statement\n can be classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual with NONE confidence, and Violence with MEDIUM confidence.

\n

For more information, see Guardrails content filters.

\n

This data type is used in the following API operations:

\n " - } - }, - "com.amazonaws.bedrock#GuardrailContentFilterConfig": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.bedrock#GuardrailContentFilterType", - "traits": { - "smithy.api#documentation": "

The harmful category that the content filter is applied to.

", - "smithy.api#required": {} - } - }, - "inputStrength": { - "target": "com.amazonaws.bedrock#GuardrailFilterStrength", - "traits": { - "smithy.api#documentation": "

The strength of the content filter to apply to prompts. As you\n increase the filter strength, the likelihood of filtering harmful content increases\n and the probability of seeing harmful content in your application reduces.

", - "smithy.api#required": {} - } - }, - "outputStrength": { - "target": "com.amazonaws.bedrock#GuardrailFilterStrength", - "traits": { - "smithy.api#documentation": "

The strength of the content filter to apply to model responses. As you\n increase the filter strength, the likelihood of filtering harmful content increases\n and the probability of seeing harmful content in your application reduces.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.

\n \n

Content filtering depends on the confidence classification of user inputs and FM\n responses across each of the four harmful categories. All input and output statements are\n classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each\n harmful category. For example, if a statement is classified as\n Hate with HIGH confidence, the likelihood of the statement\n representing hateful content is high. A single statement can be classified across\n multiple categories with varying confidence levels. For example, a single statement\n can be classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual with NONE confidence, and Violence with MEDIUM confidence.

\n

For more information, see Guardrails content filters.

" - } - }, - "com.amazonaws.bedrock#GuardrailContentFilterType": { - "type": "enum", - "members": { - "SEXUAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SEXUAL" - } - }, - "VIOLENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VIOLENCE" - } - }, - "HATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HATE" - } - }, - "INSULTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSULTS" - } - }, - "MISCONDUCT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MISCONDUCT" - } - }, - "PROMPT_ATTACK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROMPT_ATTACK" - } - } - } - }, - "com.amazonaws.bedrock#GuardrailContentFilters": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#GuardrailContentFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 6 - } - } - }, - "com.amazonaws.bedrock#GuardrailContentFiltersConfig": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#GuardrailContentFilterConfig" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 6 - } - } - }, - "com.amazonaws.bedrock#GuardrailContentPolicy": { - "type": "structure", - "members": { - "filters": { - "target": "com.amazonaws.bedrock#GuardrailContentFilters", - "traits": { - "smithy.api#documentation": "

Contains the type of the content filter and how strongly it should apply to prompts and model responses.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details about how to handle harmful content.

\n

This data type is used in the following API operations:

\n " - } - }, - "com.amazonaws.bedrock#GuardrailContentPolicyConfig": { - "type": "structure", - "members": { - "filtersConfig": { - "target": "com.amazonaws.bedrock#GuardrailContentFiltersConfig", - "traits": { - "smithy.api#documentation": "

Contains the type of the content filter and how strongly it should apply to prompts and model responses.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details about how to handle harmful content.

" - } - }, - "com.amazonaws.bedrock#GuardrailContextualGroundingFilter": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFilterType", - "traits": { - "smithy.api#documentation": "

The filter type details for the guardrails contextual grounding filter.

", - "smithy.api#required": {} - } - }, - "threshold": { - "target": "smithy.api#Double", - "traits": { - "smithy.api#documentation": "

The threshold details for the guardrails contextual grounding filter.

", - "smithy.api#range": { - "min": 0 - }, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The details for the guardrails contextual grounding filter.

" - } - }, - "com.amazonaws.bedrock#GuardrailContextualGroundingFilterConfig": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFilterType", - "traits": { - "smithy.api#documentation": "

The filter details for the guardrails contextual grounding filter.

", - "smithy.api#required": {} - } - }, - "threshold": { - "target": "smithy.api#Double", - "traits": { - "smithy.api#documentation": "

The threshold details for the guardrails contextual grounding filter.

", - "smithy.api#range": { - "min": 0 - }, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The filter configuration details for the guardrails contextual grounding filter.

" - } - }, - "com.amazonaws.bedrock#GuardrailContextualGroundingFilterType": { - "type": "enum", - "members": { - "GROUNDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GROUNDING" - } - }, - "RELEVANCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RELEVANCE" - } - } - } - }, - "com.amazonaws.bedrock#GuardrailContextualGroundingFilters": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.bedrock#GuardrailContextualGroundingFiltersConfig": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFilterConfig" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.bedrock#GuardrailContextualGroundingPolicy": { - "type": "structure", - "members": { - "filters": { - "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFilters", - "traits": { - "smithy.api#documentation": "

The filter details for the guardrails contextual grounding policy.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The details for the guardrails contextual grounding policy.

" - } - }, - "com.amazonaws.bedrock#GuardrailContextualGroundingPolicyConfig": { - "type": "structure", - "members": { - "filtersConfig": { - "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFiltersConfig", - "traits": { - "smithy.api#documentation": "

The filter configuration details for the guardrails contextual grounding policy.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The policy configuration details for the guardrails contextual grounding policy.

" - } - }, - "com.amazonaws.bedrock#GuardrailDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrock#GuardrailDraftVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 5, - "max": 5 - }, - "smithy.api#pattern": "^DRAFT$" - } - }, - "com.amazonaws.bedrock#GuardrailFailureRecommendation": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrock#GuardrailFailureRecommendations": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#GuardrailFailureRecommendation" - }, - "traits": { - "smithy.api#length": { - "max": 100 - } - } - }, - "com.amazonaws.bedrock#GuardrailFilterStrength": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "LOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LOW" - } - }, - "MEDIUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIUM" - } - }, - "HIGH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HIGH" - } - } - } - }, - "com.amazonaws.bedrock#GuardrailId": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 64 - }, - "smithy.api#pattern": "^[a-z0-9]+$" - } - }, - "com.amazonaws.bedrock#GuardrailIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$" - } - }, - "com.amazonaws.bedrock#GuardrailManagedWordLists": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#GuardrailManagedWords" - } - }, - "com.amazonaws.bedrock#GuardrailManagedWordListsConfig": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#GuardrailManagedWordsConfig" - } - }, - "com.amazonaws.bedrock#GuardrailManagedWords": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.bedrock#GuardrailManagedWordsType", - "traits": { - "smithy.api#documentation": "

ManagedWords$type\n The managed word type that was configured for the guardrail.\n (For now, we only offer profanity word list)

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The managed word list that was configured for the guardrail.\n (This is a list of words that are pre-defined and managed by guardrails only.)

" - } - }, - "com.amazonaws.bedrock#GuardrailManagedWordsConfig": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.bedrock#GuardrailManagedWordsType", - "traits": { - "smithy.api#documentation": "

The managed word type to configure for the guardrail.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The managed word list to configure for the guardrail.

" - } - }, - "com.amazonaws.bedrock#GuardrailManagedWordsType": { - "type": "enum", - "members": { - "PROFANITY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROFANITY" - } - } - } - }, - "com.amazonaws.bedrock#GuardrailName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - }, - "smithy.api#pattern": "^[0-9a-zA-Z-_]+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrock#GuardrailNumericalVersion": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[1-9][0-9]{0,7}$" - } - }, - "com.amazonaws.bedrock#GuardrailPiiEntities": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#GuardrailPiiEntity" - }, - "traits": { - "smithy.api#length": { - "min": 1 - }, - "smithy.api#uniqueItems": {} - } - }, - "com.amazonaws.bedrock#GuardrailPiiEntitiesConfig": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#GuardrailPiiEntityConfig" - }, - "traits": { - "smithy.api#length": { - "min": 1 - }, - "smithy.api#uniqueItems": {} - } - }, - "com.amazonaws.bedrock#GuardrailPiiEntity": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.bedrock#GuardrailPiiEntityType", - "traits": { - "smithy.api#documentation": "

The type of PII entity. For exampvle, Social Security Number.

", - "smithy.api#required": {} - } - }, - "action": { - "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", - "traits": { - "smithy.api#documentation": "

The configured guardrail action when PII entity is detected.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The PII entity configured for the guardrail.

" - } - }, - "com.amazonaws.bedrock#GuardrailPiiEntityConfig": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.bedrock#GuardrailPiiEntityType", - "traits": { - "smithy.api#documentation": "

Configure guardrail type when the PII entity is detected.

\n

The following PIIs are used to block or mask sensitive information:

\n ", - "smithy.api#required": {} - } - }, - "action": { - "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", - "traits": { - "smithy.api#documentation": "

Configure guardrail action when the PII entity is detected.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The PII entity to configure for the guardrail.

" - } - }, - "com.amazonaws.bedrock#GuardrailPiiEntityType": { - "type": "enum", - "members": { - "ADDRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ADDRESS" - } - }, - "AGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AGE" - } - }, - "AWS_ACCESS_KEY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AWS_ACCESS_KEY" - } - }, - "AWS_SECRET_KEY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AWS_SECRET_KEY" - } - }, - "CA_HEALTH_NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CA_HEALTH_NUMBER" - } - }, - "CA_SOCIAL_INSURANCE_NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CA_SOCIAL_INSURANCE_NUMBER" - } - }, - "CREDIT_DEBIT_CARD_CVV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREDIT_DEBIT_CARD_CVV" - } - }, - "CREDIT_DEBIT_CARD_EXPIRY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREDIT_DEBIT_CARD_EXPIRY" - } - }, - "CREDIT_DEBIT_CARD_NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREDIT_DEBIT_CARD_NUMBER" - } - }, - "DRIVER_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DRIVER_ID" - } - }, - "EMAIL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EMAIL" - } - }, - "INTERNATIONAL_BANK_ACCOUNT_NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNATIONAL_BANK_ACCOUNT_NUMBER" - } - }, - "IP_ADDRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IP_ADDRESS" - } - }, - "LICENSE_PLATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LICENSE_PLATE" - } - }, - "MAC_ADDRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAC_ADDRESS" - } - }, - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NAME" - } - }, - "PASSWORD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PASSWORD" - } - }, - "PHONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PHONE" - } - }, - "PIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PIN" - } - }, - "SWIFT_CODE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SWIFT_CODE" - } - }, - "UK_NATIONAL_HEALTH_SERVICE_NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UK_NATIONAL_HEALTH_SERVICE_NUMBER" - } - }, - "UK_NATIONAL_INSURANCE_NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UK_NATIONAL_INSURANCE_NUMBER" - } - }, - "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" - } - }, - "URL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "URL" - } - }, - "USERNAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "USERNAME" - } - }, - "US_BANK_ACCOUNT_NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "US_BANK_ACCOUNT_NUMBER" - } - }, - "US_BANK_ROUTING_NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "US_BANK_ROUTING_NUMBER" - } - }, - "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" - } - }, - "US_PASSPORT_NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "US_PASSPORT_NUMBER" - } - }, - "US_SOCIAL_SECURITY_NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "US_SOCIAL_SECURITY_NUMBER" - } - }, - "VEHICLE_IDENTIFICATION_NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VEHICLE_IDENTIFICATION_NUMBER" - } - } - } - }, - "com.amazonaws.bedrock#GuardrailRegex": { - "type": "structure", - "members": { - "name": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The name of the regular expression for the guardrail.

", - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#required": {} - } - }, - "description": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The description of the regular expression for the guardrail.

", - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, - "pattern": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The pattern of the regular expression configured for the guardrail.

", - "smithy.api#length": { - "min": 1, - "max": 500 - }, - "smithy.api#required": {} - } - }, - "action": { - "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", - "traits": { - "smithy.api#documentation": "

The action taken when a match to the regular expression is detected.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The regular expression configured for the guardrail.

" - } - }, - "com.amazonaws.bedrock#GuardrailRegexConfig": { - "type": "structure", - "members": { - "name": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The name of the regular expression to configure for the guardrail.

", - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#required": {} - } - }, - "description": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The description of the regular expression to configure for the guardrail.

", - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, - "pattern": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The regular expression pattern to configure for the guardrail.

", - "smithy.api#length": { - "min": 1, - "max": 500 - }, - "smithy.api#required": {} - } - }, - "action": { - "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", - "traits": { - "smithy.api#documentation": "

The guardrail action to configure when matching regular expression is detected.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The regular expression to configure for the guardrail.

" - } - }, - "com.amazonaws.bedrock#GuardrailRegexes": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#GuardrailRegex" - } - }, - "com.amazonaws.bedrock#GuardrailRegexesConfig": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#GuardrailRegexConfig" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.bedrock#GuardrailSensitiveInformationAction": { - "type": "enum", - "members": { - "BLOCK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BLOCK" - } - }, - "ANONYMIZE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ANONYMIZE" - } - } - } - }, - "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicy": { - "type": "structure", - "members": { - "piiEntities": { - "target": "com.amazonaws.bedrock#GuardrailPiiEntities", - "traits": { - "smithy.api#documentation": "

The list of PII entities configured for the guardrail.

" - } - }, - "regexes": { - "target": "com.amazonaws.bedrock#GuardrailRegexes", - "traits": { - "smithy.api#documentation": "

The list of regular expressions configured for the guardrail.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details about PII entities and regular expressions configured for the guardrail.

" - } - }, - "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicyConfig": { - "type": "structure", - "members": { - "piiEntitiesConfig": { - "target": "com.amazonaws.bedrock#GuardrailPiiEntitiesConfig", - "traits": { - "smithy.api#documentation": "

A list of PII entities to configure to the guardrail.

" - } - }, - "regexesConfig": { - "target": "com.amazonaws.bedrock#GuardrailRegexesConfig", - "traits": { - "smithy.api#documentation": "

A list of regular expressions to configure to the guardrail.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details about PII entities and regular expressions to configure for the guardrail.

" - } - }, - "com.amazonaws.bedrock#GuardrailStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "VERSIONING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VERSIONING" - } - }, - "READY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READY" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - } - } - }, - "com.amazonaws.bedrock#GuardrailStatusReason": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrock#GuardrailStatusReasons": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#GuardrailStatusReason" - }, - "traits": { - "smithy.api#length": { - "max": 100 - } - } - }, - "com.amazonaws.bedrock#GuardrailSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#GuardrailSummary" - }, - "traits": { - "smithy.api#length": { - "max": 1000 - } - } - }, - "com.amazonaws.bedrock#GuardrailSummary": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.bedrock#GuardrailId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the guardrail.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.bedrock#GuardrailArn", - "traits": { - "smithy.api#documentation": "

The ARN of the guardrail.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrock#GuardrailStatus", - "traits": { - "smithy.api#documentation": "

The status of the guardrail.

", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.bedrock#GuardrailName", - "traits": { - "smithy.api#documentation": "

The name of the guardrail.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrock#GuardrailDescription", - "traits": { - "smithy.api#documentation": "

A description of the guardrail.

" - } - }, - "version": { - "target": "com.amazonaws.bedrock#GuardrailVersion", - "traits": { - "smithy.api#documentation": "

The version of the guardrail.

", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time at which the guardrail was created.

", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time at which the guardrail was last updated.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details about a guardrail.

\n

This data type is used in the following API operations:

\n " - } - }, - "com.amazonaws.bedrock#GuardrailTopic": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrock#GuardrailTopicName", - "traits": { - "smithy.api#documentation": "

The name of the topic to deny.

", - "smithy.api#required": {} - } - }, - "definition": { - "target": "com.amazonaws.bedrock#GuardrailTopicDefinition", - "traits": { - "smithy.api#documentation": "

A definition of the topic to deny.

", - "smithy.api#required": {} - } - }, - "examples": { - "target": "com.amazonaws.bedrock#GuardrailTopicExamples", - "traits": { - "smithy.api#documentation": "

A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

" - } - }, - "type": { - "target": "com.amazonaws.bedrock#GuardrailTopicType", - "traits": { - "smithy.api#documentation": "

Specifies to deny the topic.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about topics for the guardrail to identify and deny.

\n

This data type is used in the following API operations:

\n " - } - }, - "com.amazonaws.bedrock#GuardrailTopicConfig": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrock#GuardrailTopicName", - "traits": { - "smithy.api#documentation": "

The name of the topic to deny.

", - "smithy.api#required": {} - } - }, - "definition": { - "target": "com.amazonaws.bedrock#GuardrailTopicDefinition", - "traits": { - "smithy.api#documentation": "

A definition of the topic to deny.

", - "smithy.api#required": {} - } - }, - "examples": { - "target": "com.amazonaws.bedrock#GuardrailTopicExamples", - "traits": { - "smithy.api#documentation": "

A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

" - } - }, - "type": { - "target": "com.amazonaws.bedrock#GuardrailTopicType", - "traits": { - "smithy.api#documentation": "

Specifies to deny the topic.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about topics for the guardrail to identify and deny.

" - } - }, - "com.amazonaws.bedrock#GuardrailTopicDefinition": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrock#GuardrailTopicExample": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrock#GuardrailTopicExamples": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#GuardrailTopicExample" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.bedrock#GuardrailTopicName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^[0-9a-zA-Z-_ !?.]+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrock#GuardrailTopicPolicy": { - "type": "structure", - "members": { - "topics": { - "target": "com.amazonaws.bedrock#GuardrailTopics", - "traits": { - "smithy.api#documentation": "

A list of policies related to topics that the guardrail should deny.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details about topics that the guardrail should identify and deny.

\n

This data type is used in the following API operations:

\n " - } - }, - "com.amazonaws.bedrock#GuardrailTopicPolicyConfig": { - "type": "structure", - "members": { - "topicsConfig": { - "target": "com.amazonaws.bedrock#GuardrailTopicsConfig", - "traits": { - "smithy.api#documentation": "

A list of policies related to topics that the guardrail should deny.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details about topics that the guardrail should identify and deny.

" - } - }, - "com.amazonaws.bedrock#GuardrailTopicType": { - "type": "enum", - "members": { - "DENY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DENY" - } - } - } - }, - "com.amazonaws.bedrock#GuardrailTopics": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#GuardrailTopic" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 30 - } - } - }, - "com.amazonaws.bedrock#GuardrailTopicsConfig": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#GuardrailTopicConfig" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 30 - } - } - }, - "com.amazonaws.bedrock#GuardrailVersion": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(([1-9][0-9]{0,7})|(DRAFT))$" - } - }, - "com.amazonaws.bedrock#GuardrailWord": { - "type": "structure", - "members": { - "text": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Text of the word configured for the guardrail to block.

", - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A word configured for the guardrail.

" - } - }, - "com.amazonaws.bedrock#GuardrailWordConfig": { - "type": "structure", - "members": { - "text": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Text of the word configured for the guardrail to block.

", - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A word to configure for the guardrail.

" - } - }, - "com.amazonaws.bedrock#GuardrailWordPolicy": { - "type": "structure", - "members": { - "words": { - "target": "com.amazonaws.bedrock#GuardrailWords", - "traits": { - "smithy.api#documentation": "

A list of words configured for the guardrail.

" - } - }, - "managedWordLists": { - "target": "com.amazonaws.bedrock#GuardrailManagedWordLists", - "traits": { - "smithy.api#documentation": "

A list of managed words configured for the guardrail.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details about the word policy configured for the guardrail.

" - } - }, - "com.amazonaws.bedrock#GuardrailWordPolicyConfig": { - "type": "structure", - "members": { - "wordsConfig": { - "target": "com.amazonaws.bedrock#GuardrailWordsConfig", - "traits": { - "smithy.api#documentation": "

A list of words to configure for the guardrail.

" - } - }, - "managedWordListsConfig": { - "target": "com.amazonaws.bedrock#GuardrailManagedWordListsConfig", - "traits": { - "smithy.api#documentation": "

A list of managed words to configure for the guardrail.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details about the word policy to configured for the guardrail.

" - } - }, - "com.amazonaws.bedrock#GuardrailWords": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#GuardrailWord" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10000 - } - } - }, - "com.amazonaws.bedrock#GuardrailWordsConfig": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#GuardrailWordConfig" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10000 - } - } - }, - "com.amazonaws.bedrock#GuardrailsResource": { - "type": "resource", - "identifiers": { - "guardrailIdentifier": { - "target": "com.amazonaws.bedrock#GuardrailIdentifier" - } - }, - "create": { - "target": "com.amazonaws.bedrock#CreateGuardrail" - }, - "read": { - "target": "com.amazonaws.bedrock#GetGuardrail" - }, - "update": { - "target": "com.amazonaws.bedrock#UpdateGuardrail" - }, - "delete": { - "target": "com.amazonaws.bedrock#DeleteGuardrail" - }, - "list": { - "target": "com.amazonaws.bedrock#ListGuardrails" - }, - "operations": [ - { - "target": "com.amazonaws.bedrock#CreateGuardrailVersion" - } - ], - "traits": { - "aws.cloudformation#cfnResource": { - "name": "Guardrail" - } - } - }, - "com.amazonaws.bedrock#HumanEvaluationConfig": { - "type": "structure", - "members": { - "humanWorkflowConfig": { - "target": "com.amazonaws.bedrock#HumanWorkflowConfig", - "traits": { - "smithy.api#documentation": "

The parameters of the human workflow.

" - } - }, - "customMetrics": { - "target": "com.amazonaws.bedrock#HumanEvaluationCustomMetrics", - "traits": { - "smithy.api#documentation": "

A HumanEvaluationCustomMetric object. It contains the names the metrics, how the metrics are to be evaluated, an optional description.

" - } - }, - "datasetMetricConfigs": { - "target": "com.amazonaws.bedrock#EvaluationDatasetMetricConfigs", - "traits": { - "smithy.api#documentation": "

Use to specify the metrics, task, and prompt dataset to be used in your model evaluation job.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the custom metrics, how tasks will be rated, the flow definition ARN, and your custom prompt datasets. Model evaluation jobs use human workers only support the use of custom prompt datasets. To learn more about custom prompt datasets and the required format, see Custom prompt datasets.

\n

When you create custom metrics in HumanEvaluationCustomMetric you must specify the metric's name. The list of names specified in the HumanEvaluationCustomMetric array, must match the metricNames array of strings specified in EvaluationDatasetMetricConfig. For example, if in the HumanEvaluationCustomMetric array your specified the names \"accuracy\", \"toxicity\", \"readability\" as custom metrics then the metricNames array would need to look like the following [\"accuracy\", \"toxicity\", \"readability\"] in EvaluationDatasetMetricConfig.

" - } - }, - "com.amazonaws.bedrock#HumanEvaluationCustomMetric": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.bedrock#EvaluationMetricName", - "traits": { - "smithy.api#documentation": "

The name of the metric. Your human evaluators will see this name in the evaluation UI.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrock#EvaluationMetricDescription", - "traits": { - "smithy.api#documentation": "

An optional description of the metric. Use this parameter to provide more details about the metric.

" - } - }, - "ratingMethod": { - "target": "com.amazonaws.bedrock#EvaluationRatingMethod", - "traits": { - "smithy.api#documentation": "

Choose how you want your human workers to evaluation your model. Valid values for rating methods are ThumbsUpDown, IndividualLikertScale,ComparisonLikertScale, ComparisonChoice, and ComparisonRank\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

In a model evaluation job that uses human workers you must \n define the name of the metric, and how you want that metric rated\n ratingMethod, and an optional description of the metric.

" - } - }, - "com.amazonaws.bedrock#HumanEvaluationCustomMetrics": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#HumanEvaluationCustomMetric" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.bedrock#HumanTaskInstructions": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5000 - }, - "smithy.api#pattern": "^[\\S\\s]+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrock#HumanWorkflowConfig": { - "type": "structure", - "members": { - "flowDefinitionArn": { - "target": "com.amazonaws.bedrock#SageMakerFlowDefinitionArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) for the flow definition

", - "smithy.api#required": {} - } - }, - "instructions": { - "target": "com.amazonaws.bedrock#HumanTaskInstructions", - "traits": { - "smithy.api#documentation": "

Instructions for the flow definition

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains SageMakerFlowDefinition object. The object is used to specify the prompt dataset, task type, rating method and metric names.

" - } - }, - "com.amazonaws.bedrock#IdempotencyToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" - } - }, - "com.amazonaws.bedrock#InferenceType": { - "type": "enum", - "members": { - "ON_DEMAND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ON_DEMAND" - } - }, - "PROVISIONED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROVISIONED" - } - } - } - }, - "com.amazonaws.bedrock#InferenceTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#InferenceType" - } - }, - "com.amazonaws.bedrock#InternalServerException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrock#NonBlankString" - } - }, - "traits": { - "smithy.api#documentation": "

An internal server error occurred. Retry your request.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.bedrock#JobName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9\\+\\-\\.])*$" - } - }, - "com.amazonaws.bedrock#KeyPrefix": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 1024 - } - } - }, - "com.amazonaws.bedrock#KmsKeyArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" - } - }, - "com.amazonaws.bedrock#KmsKeyId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+))$" - } - }, - "com.amazonaws.bedrock#ListCustomModels": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#ListCustomModelsRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#ListCustomModelsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of the custom models that you have created with the CreateModelCustomizationJob operation.

\n

For more information, see Custom models in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/custom-models" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "modelSummaries" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.bedrock#ListCustomModelsRequest": { - "type": "structure", - "members": { - "creationTimeBefore": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

Return custom models created before the specified time.

", - "smithy.api#httpQuery": "creationTimeBefore" - } - }, - "creationTimeAfter": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

Return custom models created after the specified time.

", - "smithy.api#httpQuery": "creationTimeAfter" - } - }, - "nameContains": { - "target": "com.amazonaws.bedrock#CustomModelName", - "traits": { - "smithy.api#documentation": "

Return custom models only if the job name contains these characters.

", - "smithy.api#httpQuery": "nameContains" - } - }, - "baseModelArnEquals": { - "target": "com.amazonaws.bedrock#ModelArn", - "traits": { - "smithy.api#documentation": "

Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.

", - "smithy.api#httpQuery": "baseModelArnEquals" - } - }, - "foundationModelArnEquals": { - "target": "com.amazonaws.bedrock#FoundationModelArn", - "traits": { - "smithy.api#documentation": "

Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.

", - "smithy.api#httpQuery": "foundationModelArnEquals" - } - }, - "maxResults": { - "target": "com.amazonaws.bedrock#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.bedrock#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "sortBy": { - "target": "com.amazonaws.bedrock#SortModelsBy", - "traits": { - "smithy.api#documentation": "

The field to sort by in the returned list of models.

", - "smithy.api#httpQuery": "sortBy" - } - }, - "sortOrder": { - "target": "com.amazonaws.bedrock#SortOrder", - "traits": { - "smithy.api#documentation": "

The sort order of the results.

", - "smithy.api#httpQuery": "sortOrder" - } - }, - "isOwned": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Return custom models depending on if the current account owns them (true) or if they were shared with the current account (false).

", - "smithy.api#httpQuery": "isOwned" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#ListCustomModelsResponse": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.bedrock#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

" - } - }, - "modelSummaries": { - "target": "com.amazonaws.bedrock#CustomModelSummaryList", - "traits": { - "smithy.api#documentation": "

Model summaries.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#ListEvaluationJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#ListEvaluationJobsRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#ListEvaluationJobsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists model evaluation jobs.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/evaluation-jobs" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "jobSummaries" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.bedrock#ListEvaluationJobsRequest": { - "type": "structure", - "members": { - "creationTimeAfter": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

A filter that includes model evaluation jobs created after the time specified.

", - "smithy.api#httpQuery": "creationTimeAfter" - } - }, - "creationTimeBefore": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

A filter that includes model evaluation jobs created prior to the time specified.

", - "smithy.api#httpQuery": "creationTimeBefore" - } - }, - "statusEquals": { - "target": "com.amazonaws.bedrock#EvaluationJobStatus", - "traits": { - "smithy.api#documentation": "

Only return jobs where the status condition is met.

", - "smithy.api#httpQuery": "statusEquals" - } - }, - "nameContains": { - "target": "com.amazonaws.bedrock#EvaluationJobName", - "traits": { - "smithy.api#documentation": "

Query parameter string for model evaluation job names.

", - "smithy.api#httpQuery": "nameContains" - } - }, - "maxResults": { - "target": "com.amazonaws.bedrock#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.bedrock#PaginationToken", - "traits": { - "smithy.api#documentation": "

Continuation token from the previous response, for Amazon Bedrock to list the next set of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "sortBy": { - "target": "com.amazonaws.bedrock#SortJobsBy", - "traits": { - "smithy.api#documentation": "

Allows you to sort model evaluation jobs by when they were created.

", - "smithy.api#httpQuery": "sortBy" - } - }, - "sortOrder": { - "target": "com.amazonaws.bedrock#SortOrder", - "traits": { - "smithy.api#documentation": "

How you want the order of jobs sorted.

", - "smithy.api#httpQuery": "sortOrder" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#ListEvaluationJobsResponse": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.bedrock#PaginationToken", - "traits": { - "smithy.api#documentation": "

Continuation token from the previous response, for Amazon Bedrock to list the next set of results.

" - } - }, - "jobSummaries": { - "target": "com.amazonaws.bedrock#EvaluationSummaries", - "traits": { - "smithy.api#documentation": "

A summary of the model evaluation jobs.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#ListFoundationModels": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#ListFoundationModelsRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#ListFoundationModelsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters. For more information, see Foundation models in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/foundation-models" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.bedrock#ListFoundationModelsRequest": { - "type": "structure", - "members": { - "byProvider": { - "target": "com.amazonaws.bedrock#Provider", - "traits": { - "smithy.api#documentation": "

Return models belonging to the model provider that you specify.

", - "smithy.api#httpQuery": "byProvider" - } - }, - "byCustomizationType": { - "target": "com.amazonaws.bedrock#ModelCustomization", - "traits": { - "smithy.api#documentation": "

Return models that support the customization type that you specify. For more information, see Custom models in the Amazon Bedrock User Guide.

", - "smithy.api#httpQuery": "byCustomizationType" - } - }, - "byOutputModality": { - "target": "com.amazonaws.bedrock#ModelModality", - "traits": { - "smithy.api#documentation": "

Return models that support the output modality that you specify.

", - "smithy.api#httpQuery": "byOutputModality" - } - }, - "byInferenceType": { - "target": "com.amazonaws.bedrock#InferenceType", - "traits": { - "smithy.api#documentation": "

Return models that support the inference type that you specify. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

", - "smithy.api#httpQuery": "byInferenceType" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#ListFoundationModelsResponse": { - "type": "structure", - "members": { - "modelSummaries": { - "target": "com.amazonaws.bedrock#FoundationModelSummaryList", - "traits": { - "smithy.api#documentation": "

A list of Amazon Bedrock foundation models.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#ListGuardrails": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#ListGuardrailsRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#ListGuardrailsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists details about all the guardrails in an account. To list the DRAFT version of all your guardrails, don't specify the guardrailIdentifier field. To list all versions of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier field.

\n

You can set the maximum number of results to return in a response in the maxResults field. If there are more results than the number you set, the response returns a nextToken that you can send in another ListGuardrails request to see the next batch of results.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/guardrails" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "guardrails" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.bedrock#ListGuardrailsRequest": { - "type": "structure", - "members": { - "guardrailIdentifier": { - "target": "com.amazonaws.bedrock#GuardrailIdentifier", - "traits": { - "smithy.api#documentation": "

The unique identifier of the guardrail. This can be an ID or the ARN.

", - "smithy.api#httpQuery": "guardrailIdentifier" - } - }, - "maxResults": { - "target": "com.amazonaws.bedrock#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.bedrock#PaginationToken", - "traits": { - "smithy.api#documentation": "

If there are more results than were returned in the response, the response returns a nextToken that you can send in another ListGuardrails request to see the next batch of results.

", - "smithy.api#httpQuery": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#ListGuardrailsResponse": { - "type": "structure", - "members": { - "guardrails": { - "target": "com.amazonaws.bedrock#GuardrailSummaries", - "traits": { - "smithy.api#documentation": "

A list of objects, each of which contains details about a guardrail.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.bedrock#PaginationToken", - "traits": { - "smithy.api#documentation": "

If there are more results than were returned in the response, the response returns a nextToken that you can send in another ListGuardrails request to see the next batch of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#ListModelCopyJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#ListModelCopyJobsRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#ListModelCopyJobsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of model copy jobs that you have submitted. You can filter the jobs to return based on\n one or more criteria. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/model-copy-jobs" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "modelCopyJobSummaries" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.bedrock#ListModelCopyJobsRequest": { - "type": "structure", - "members": { - "creationTimeAfter": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

Filters for model copy jobs created after the specified time.

", - "smithy.api#httpQuery": "creationTimeAfter" - } - }, - "creationTimeBefore": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

Filters for model copy jobs created before the specified time.

", - "smithy.api#httpQuery": "creationTimeBefore" - } - }, - "statusEquals": { - "target": "com.amazonaws.bedrock#ModelCopyJobStatus", - "traits": { - "smithy.api#documentation": "

Filters for model copy jobs whose status matches the value that you specify.

", - "smithy.api#httpQuery": "statusEquals" - } - }, - "sourceAccountEquals": { - "target": "com.amazonaws.bedrock#AccountId", - "traits": { - "smithy.api#documentation": "

Filters for model copy jobs in which the account that the source model belongs to is equal to the value that you specify.

", - "smithy.api#httpQuery": "sourceAccountEquals" - } - }, - "sourceModelArnEquals": { - "target": "com.amazonaws.bedrock#ModelArn", - "traits": { - "smithy.api#documentation": "

Filters for model copy jobs in which the Amazon Resource Name (ARN) of the source model to is equal to the value that you specify.

", - "smithy.api#httpQuery": "sourceModelArnEquals" - } - }, - "targetModelNameContains": { - "target": "com.amazonaws.bedrock#CustomModelName", - "traits": { - "smithy.api#documentation": "

Filters for model copy jobs in which the name of the copied model contains the string that you specify.

", - "smithy.api#httpQuery": "outputModelNameContains" - } - }, - "maxResults": { - "target": "com.amazonaws.bedrock#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.bedrock#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "sortBy": { - "target": "com.amazonaws.bedrock#SortJobsBy", - "traits": { - "smithy.api#documentation": "

The field to sort by in the returned list of model copy jobs.

", - "smithy.api#httpQuery": "sortBy" - } - }, - "sortOrder": { - "target": "com.amazonaws.bedrock#SortOrder", - "traits": { - "smithy.api#documentation": "

Specifies whether to sort the results in ascending or descending order.

", - "smithy.api#httpQuery": "sortOrder" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#ListModelCopyJobsResponse": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.bedrock#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

" - } - }, - "modelCopyJobSummaries": { - "target": "com.amazonaws.bedrock#ModelCopyJobSummaries", - "traits": { - "smithy.api#documentation": "

A list of information about each model copy job.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#ListModelCustomizationJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#ListModelCustomizationJobsRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#ListModelCustomizationJobsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on\n one or more criteria.

\n

For more information, see Custom models in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/model-customization-jobs" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "modelCustomizationJobSummaries" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.bedrock#ListModelCustomizationJobsRequest": { - "type": "structure", - "members": { - "creationTimeAfter": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

Return customization jobs created after the specified time.

", - "smithy.api#httpQuery": "creationTimeAfter" - } - }, - "creationTimeBefore": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

Return customization jobs created before the specified time.

", - "smithy.api#httpQuery": "creationTimeBefore" - } - }, - "statusEquals": { - "target": "com.amazonaws.bedrock#FineTuningJobStatus", - "traits": { - "smithy.api#documentation": "

Return customization jobs with the specified status.

", - "smithy.api#httpQuery": "statusEquals" - } - }, - "nameContains": { - "target": "com.amazonaws.bedrock#JobName", - "traits": { - "smithy.api#documentation": "

Return customization jobs only if the job name contains these characters.

", - "smithy.api#httpQuery": "nameContains" - } - }, - "maxResults": { - "target": "com.amazonaws.bedrock#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.bedrock#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "sortBy": { - "target": "com.amazonaws.bedrock#SortJobsBy", - "traits": { - "smithy.api#documentation": "

The field to sort by in the returned list of jobs.

", - "smithy.api#httpQuery": "sortBy" - } - }, - "sortOrder": { - "target": "com.amazonaws.bedrock#SortOrder", - "traits": { - "smithy.api#documentation": "

The sort order of the results.

", - "smithy.api#httpQuery": "sortOrder" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#ListModelCustomizationJobsResponse": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.bedrock#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

" - } - }, - "modelCustomizationJobSummaries": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobSummaries", - "traits": { - "smithy.api#documentation": "

Job summaries.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#ListModelInvocationJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#ListModelInvocationJobsRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#ListModelInvocationJobsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all batch inference jobs in the account. For more information, see View details about a batch inference job.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/model-invocation-jobs" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "invocationJobSummaries" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.bedrock#ListModelInvocationJobsRequest": { - "type": "structure", - "members": { - "submitTimeAfter": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

Specify a time to filter for batch inference jobs that were submitted after the time you specify.

", - "smithy.api#httpQuery": "submitTimeAfter" - } - }, - "submitTimeBefore": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

Specify a time to filter for batch inference jobs that were submitted before the time you specify.

", - "smithy.api#httpQuery": "submitTimeBefore" - } - }, - "statusEquals": { - "target": "com.amazonaws.bedrock#ModelInvocationJobStatus", - "traits": { - "smithy.api#documentation": "

Specify a status to filter for batch inference jobs whose statuses match the string you specify.

", - "smithy.api#httpQuery": "statusEquals" - } - }, - "nameContains": { - "target": "com.amazonaws.bedrock#ModelInvocationJobName", - "traits": { - "smithy.api#documentation": "

Specify a string to filter for batch inference jobs whose names contain the string.

", - "smithy.api#httpQuery": "nameContains" - } - }, - "maxResults": { - "target": "com.amazonaws.bedrock#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return. If there are more results than the number that you specify, a nextToken value is returned. Use the nextToken in a request to return the next batch of results.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.bedrock#PaginationToken", - "traits": { - "smithy.api#documentation": "

If there were more results than the value you specified\n in the maxResults field in a previous ListModelInvocationJobs request, the response would have returned a nextToken\n value. To see the next batch of results, send the\n nextToken value in another\n request.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "sortBy": { - "target": "com.amazonaws.bedrock#SortJobsBy", - "traits": { - "smithy.api#documentation": "

An attribute by which to sort the results.

", - "smithy.api#httpQuery": "sortBy" - } - }, - "sortOrder": { - "target": "com.amazonaws.bedrock#SortOrder", - "traits": { - "smithy.api#documentation": "

Specifies whether to sort the results by ascending or descending order.

", - "smithy.api#httpQuery": "sortOrder" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#ListModelInvocationJobsResponse": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.bedrock#PaginationToken", - "traits": { - "smithy.api#documentation": "

If there are more results than can fit in the response, a nextToken is returned. Use the nextToken in a request to return the next batch of results.

" - } - }, - "invocationJobSummaries": { - "target": "com.amazonaws.bedrock#ModelInvocationJobSummaries", - "traits": { - "smithy.api#documentation": "

A list of items, each of which contains a summary about a batch inference job.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#ListProvisionedModelThroughputs": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#ListProvisionedModelThroughputsRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#ListProvisionedModelThroughputsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/provisioned-model-throughputs" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "provisionedModelSummaries" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.bedrock#ListProvisionedModelThroughputsRequest": { - "type": "structure", - "members": { - "creationTimeAfter": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

A filter that returns Provisioned Throughputs created after the specified time.

", - "smithy.api#httpQuery": "creationTimeAfter" - } - }, - "creationTimeBefore": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

A filter that returns Provisioned Throughputs created before the specified time.

", - "smithy.api#httpQuery": "creationTimeBefore" - } - }, - "statusEquals": { - "target": "com.amazonaws.bedrock#ProvisionedModelStatus", - "traits": { - "smithy.api#documentation": "

A filter that returns Provisioned Throughputs if their statuses matches the value that you specify.

", - "smithy.api#httpQuery": "statusEquals" - } - }, - "modelArnEquals": { - "target": "com.amazonaws.bedrock#ModelArn", - "traits": { - "smithy.api#documentation": "

A filter that returns Provisioned Throughputs whose model Amazon Resource Name (ARN) is equal to the value that you specify.

", - "smithy.api#httpQuery": "modelArnEquals" - } - }, - "nameContains": { - "target": "com.amazonaws.bedrock#ProvisionedModelName", - "traits": { - "smithy.api#documentation": "

A filter that returns Provisioned Throughputs if their name contains the expression that you specify.

", - "smithy.api#httpQuery": "nameContains" - } - }, - "maxResults": { - "target": "com.amazonaws.bedrock#MaxResults", - "traits": { - "smithy.api#documentation": "

THe maximum number of results to return in the response. If there are more results than the number you specified, the response returns a nextToken\n value. To see the next batch of results, send the nextToken value in another list request.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.bedrock#PaginationToken", - "traits": { - "smithy.api#documentation": "

If there are more results than the number you specified in the maxResults field, the response returns a nextToken\n value. To see the next batch of results, specify the nextToken value in this field.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "sortBy": { - "target": "com.amazonaws.bedrock#SortByProvisionedModels", - "traits": { - "smithy.api#documentation": "

The field by which to sort the returned list of Provisioned Throughputs.

", - "smithy.api#httpQuery": "sortBy" - } - }, - "sortOrder": { - "target": "com.amazonaws.bedrock#SortOrder", - "traits": { - "smithy.api#documentation": "

The sort order of the results.

", - "smithy.api#httpQuery": "sortOrder" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#ListProvisionedModelThroughputsResponse": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.bedrock#PaginationToken", - "traits": { - "smithy.api#documentation": "

If there are more results than the number you specified in the maxResults field, this value is returned. To see the next batch of results, include this value in the nextToken field in another list request.

" - } - }, - "provisionedModelSummaries": { - "target": "com.amazonaws.bedrock#ProvisionedModelSummaries", - "traits": { - "smithy.api#documentation": "

A list of summaries, one for each Provisioned Throughput in the response.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

List the tags associated with the specified resource.

\n

For more information, see Tagging resources in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/listTagsForResource" - } - } - }, - "com.amazonaws.bedrock#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "resourceARN": { - "target": "com.amazonaws.bedrock#TaggableResourcesArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.bedrock#TagList", - "traits": { - "smithy.api#documentation": "

An array of the tags associated with this resource.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#LogGroupName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.bedrock#LoggingConfig": { - "type": "structure", - "members": { - "cloudWatchConfig": { - "target": "com.amazonaws.bedrock#CloudWatchConfig", - "traits": { - "smithy.api#documentation": "

CloudWatch logging configuration.

" - } - }, - "s3Config": { - "target": "com.amazonaws.bedrock#S3Config", - "traits": { - "smithy.api#documentation": "

S3 configuration for storing log data.

" - } - }, - "textDataDeliveryEnabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Set to include text data in the log delivery.

" - } - }, - "imageDataDeliveryEnabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Set to include image data in the log delivery.

" - } - }, - "embeddingDataDeliveryEnabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Set to include embeddings data in the log delivery.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration fields for invocation logging.

" - } - }, - "com.amazonaws.bedrock#LoggingResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfiguration" - }, - { - "target": "com.amazonaws.bedrock#GetModelInvocationLoggingConfiguration" - }, - { - "target": "com.amazonaws.bedrock#PutModelInvocationLoggingConfiguration" - } - ] - }, - "com.amazonaws.bedrock#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.bedrock#Message": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.bedrock#MetricFloat": { - "type": "float" - }, - "com.amazonaws.bedrock#ModelArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 1011 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))$" - } - }, - "com.amazonaws.bedrock#ModelCopyJobArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 1011 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-copy-job/[a-z0-9]{12}$" - } - }, - "com.amazonaws.bedrock#ModelCopyJobStatus": { - "type": "enum", - "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - } - } - }, - "com.amazonaws.bedrock#ModelCopyJobSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#ModelCopyJobSummary" - } - }, - "com.amazonaws.bedrock#ModelCopyJobSummary": { - "type": "structure", - "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#ModelCopyJobArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resoource Name (ARN) of the model copy job.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrock#ModelCopyJobStatus", - "traits": { - "smithy.api#documentation": "

The status of the model copy job.

", - "smithy.api#required": {} - } - }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the model copy job was created.

", - "smithy.api#required": {} - } - }, - "targetModelArn": { - "target": "com.amazonaws.bedrock#CustomModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the copied model.

", - "smithy.api#required": {} - } - }, - "targetModelName": { - "target": "com.amazonaws.bedrock#CustomModelName", - "traits": { - "smithy.api#documentation": "

The name of the copied model.

" - } - }, - "sourceAccountId": { - "target": "com.amazonaws.bedrock#AccountId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the account that the model being copied originated from.

", - "smithy.api#required": {} - } - }, - "sourceModelArn": { - "target": "com.amazonaws.bedrock#ModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the original model being copied.

", - "smithy.api#required": {} - } - }, - "targetModelKmsKeyArn": { - "target": "com.amazonaws.bedrock#KmsKeyArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the copied model.

" - } - }, - "targetModelTags": { - "target": "com.amazonaws.bedrock#TagList", - "traits": { - "smithy.api#documentation": "

Tags associated with the copied model.

" - } - }, - "failureMessage": { - "target": "com.amazonaws.bedrock#ErrorMessage", - "traits": { - "smithy.api#documentation": "

If a model fails to be copied, a message describing why the job failed is included here.

" - } - }, - "sourceModelName": { - "target": "com.amazonaws.bedrock#CustomModelName", - "traits": { - "smithy.api#documentation": "

The name of the original model being copied.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details about each model copy job.

\n

This data type is used in the following API operations:

\n " - } - }, - "com.amazonaws.bedrock#ModelCopyResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrock#CreateModelCopyJob" - }, - { - "target": "com.amazonaws.bedrock#GetModelCopyJob" - }, - { - "target": "com.amazonaws.bedrock#ListModelCopyJobs" - } - ] - }, - "com.amazonaws.bedrock#ModelCustomization": { - "type": "enum", - "members": { - "FINE_TUNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FINE_TUNING" - } - }, - "CONTINUED_PRE_TRAINING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTINUED_PRE_TRAINING" - } - } - } - }, - "com.amazonaws.bedrock#ModelCustomizationHyperParameters": { - "type": "map", - "key": { - "target": "smithy.api#String" - }, - "value": { - "target": "smithy.api#String" - } - }, - "com.amazonaws.bedrock#ModelCustomizationJobArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 1011 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-customization-job/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12}$" - } - }, - "com.amazonaws.bedrock#ModelCustomizationJobIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 1011 - }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-customization-job/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9\\+\\-\\.])*)$" - } - }, - "com.amazonaws.bedrock#ModelCustomizationJobStatus": { - "type": "enum", - "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "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" - } - } - } - }, - "com.amazonaws.bedrock#ModelCustomizationJobSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobSummary" - } - }, - "com.amazonaws.bedrock#ModelCustomizationJobSummary": { - "type": "structure", - "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", - "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the customization job.

", - "smithy.api#required": {} - } - }, - "baseModelArn": { - "target": "com.amazonaws.bedrock#ModelArn", - "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the base model.

", - "smithy.api#required": {} - } - }, - "jobName": { - "target": "com.amazonaws.bedrock#JobName", - "traits": { - "smithy.api#documentation": "

Name of the customization job.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobStatus", - "traits": { - "smithy.api#documentation": "

Status of the customization job.

", - "smithy.api#required": {} - } - }, - "lastModifiedTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

Time that the customization job was last modified.

" - } - }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

Creation time of the custom model.

", - "smithy.api#required": {} - } - }, - "endTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

Time that the customization job ended.

" - } - }, - "customModelArn": { - "target": "com.amazonaws.bedrock#CustomModelArn", - "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) of the custom model.

" - } - }, - "customModelName": { - "target": "com.amazonaws.bedrock#CustomModelName", - "traits": { - "smithy.api#documentation": "

Name of the custom model.

" - } - }, - "customizationType": { - "target": "com.amazonaws.bedrock#CustomizationType", - "traits": { - "smithy.api#documentation": "

Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about one customization job

" - } - }, - "com.amazonaws.bedrock#ModelCustomizationList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#ModelCustomization" - } - }, - "com.amazonaws.bedrock#ModelId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-:]{1,63}/[a-z0-9]{12}$)|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}$)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$" - } - }, - "com.amazonaws.bedrock#ModelIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$" - } - }, - "com.amazonaws.bedrock#ModelInvocationIdempotencyToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]{1,256}(-*[a-zA-Z0-9]){0,256}$" - } - }, - "com.amazonaws.bedrock#ModelInvocationJobArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 1011 - }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-invocation-job/[a-z0-9]{12})$" - } - }, - "com.amazonaws.bedrock#ModelInvocationJobIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 1011 - }, - "smithy.api#pattern": "^((arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-invocation-job/)?[a-z0-9]{12})$" - } - }, - "com.amazonaws.bedrock#ModelInvocationJobInputDataConfig": { - "type": "union", - "members": { - "s3InputDataConfig": { - "target": "com.amazonaws.bedrock#ModelInvocationJobS3InputDataConfig", - "traits": { - "smithy.api#documentation": "

Contains the configuration of the S3 location of the input data.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the location of the input to the batch inference job.

" - } - }, - "com.amazonaws.bedrock#ModelInvocationJobName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]{1,63}(-*[a-zA-Z0-9\\+\\-\\.]){0,63}$" - } - }, - "com.amazonaws.bedrock#ModelInvocationJobOutputDataConfig": { - "type": "union", - "members": { - "s3OutputDataConfig": { - "target": "com.amazonaws.bedrock#ModelInvocationJobS3OutputDataConfig", - "traits": { - "smithy.api#documentation": "

Contains the configuration of the S3 location of the output data.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the configuration of the S3 location of the output data.

" - } - }, - "com.amazonaws.bedrock#ModelInvocationJobResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrock#CreateModelInvocationJob" - }, - { - "target": "com.amazonaws.bedrock#GetModelInvocationJob" - }, - { - "target": "com.amazonaws.bedrock#ListModelInvocationJobs" - }, - { - "target": "com.amazonaws.bedrock#StopModelInvocationJob" - } - ] - }, - "com.amazonaws.bedrock#ModelInvocationJobS3InputDataConfig": { - "type": "structure", - "members": { - "s3InputFormat": { - "target": "com.amazonaws.bedrock#S3InputFormat", - "traits": { - "smithy.api#documentation": "

The format of the input data.

" - } - }, - "s3Uri": { - "target": "com.amazonaws.bedrock#S3Uri", - "traits": { - "smithy.api#documentation": "

The S3 location of the input data.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the configuration of the S3 location of the output data.

" - } - }, - "com.amazonaws.bedrock#ModelInvocationJobS3OutputDataConfig": { - "type": "structure", - "members": { - "s3Uri": { - "target": "com.amazonaws.bedrock#S3Uri", - "traits": { - "smithy.api#documentation": "

The S3 location of the output data.

", - "smithy.api#required": {} - } - }, - "s3EncryptionKeyId": { - "target": "com.amazonaws.bedrock#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the key that encrypts the S3 location of the output data.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the configuration of the S3 location of the output data.

" - } - }, - "com.amazonaws.bedrock#ModelInvocationJobStatus": { - "type": "enum", - "members": { - "SUBMITTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Submitted" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Completed" - } - }, - "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" - } - }, - "PARTIALLY_COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PartiallyCompleted" - } - }, - "EXPIRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Expired" - } - }, - "VALIDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Validating" - } - }, - "SCHEDULED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Scheduled" - } - } - } - }, - "com.amazonaws.bedrock#ModelInvocationJobSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#ModelInvocationJobSummary" - } - }, - "com.amazonaws.bedrock#ModelInvocationJobSummary": { - "type": "structure", - "members": { - "jobArn": { - "target": "com.amazonaws.bedrock#ModelInvocationJobArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job.

", - "smithy.api#required": {} - } - }, - "jobName": { - "target": "com.amazonaws.bedrock#ModelInvocationJobName", - "traits": { - "smithy.api#documentation": "

The name of the batch inference job.

", - "smithy.api#required": {} - } - }, - "modelId": { - "target": "com.amazonaws.bedrock#ModelId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the foundation model used for model inference.

", - "smithy.api#required": {} - } - }, - "clientRequestToken": { - "target": "com.amazonaws.bedrock#ModelInvocationIdempotencyToken", - "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n\t Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

" - } - }, - "roleArn": { - "target": "com.amazonaws.bedrock#RoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrock#ModelInvocationJobStatus", - "traits": { - "smithy.api#documentation": "

The status of the batch inference job.

" - } - }, - "message": { - "target": "com.amazonaws.bedrock#Message", - "traits": { - "smithy.api#documentation": "

If the batch inference job failed, this field contains a message describing why the job failed.

" - } - }, - "submitTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the batch inference job was submitted.

", - "smithy.api#required": {} - } - }, - "lastModifiedTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the batch inference job was last modified.

" - } - }, - "endTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the batch inference job ended.

" - } - }, - "inputDataConfig": { - "target": "com.amazonaws.bedrock#ModelInvocationJobInputDataConfig", - "traits": { - "smithy.api#documentation": "

Details about the location of the input to the batch inference job.

", - "smithy.api#required": {} - } - }, - "outputDataConfig": { - "target": "com.amazonaws.bedrock#ModelInvocationJobOutputDataConfig", - "traits": { - "smithy.api#documentation": "

Details about the location of the output of the batch inference job.

", - "smithy.api#required": {} - } - }, - "timeoutDurationInHours": { - "target": "com.amazonaws.bedrock#ModelInvocationJobTimeoutDurationInHours", - "traits": { - "smithy.api#documentation": "

The number of hours after which the batch inference job was set to time out.

" - } - }, - "jobExpirationTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The time at which the batch inference job times or timed out.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A summary of a batch inference job.

" - } - }, - "com.amazonaws.bedrock#ModelInvocationJobTimeoutDurationInHours": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 24, - "max": 168 - } - } - }, - "com.amazonaws.bedrock#ModelModality": { - "type": "enum", - "members": { - "TEXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TEXT" - } - }, - "IMAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMAGE" - } - }, - "EMBEDDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EMBEDDING" - } - } - } - }, - "com.amazonaws.bedrock#ModelModalityList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#ModelModality" - } - }, - "com.amazonaws.bedrock#ModelName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63})$" - } - }, - "com.amazonaws.bedrock#ModelResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrock#DeleteCustomModel" - }, - { - "target": "com.amazonaws.bedrock#GetCustomModel" - }, - { - "target": "com.amazonaws.bedrock#GetFoundationModel" - }, - { - "target": "com.amazonaws.bedrock#ListCustomModels" - }, - { - "target": "com.amazonaws.bedrock#ListFoundationModels" - } - ] - }, - "com.amazonaws.bedrock#NonBlankString": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[\\s\\S]*$" - } - }, - "com.amazonaws.bedrock#OutputDataConfig": { - "type": "structure", - "members": { - "s3Uri": { - "target": "com.amazonaws.bedrock#S3Uri", - "traits": { - "smithy.api#documentation": "

The S3 URI where the output data is stored.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

S3 Location of the output data.

" - } - }, - "com.amazonaws.bedrock#PaginationToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^\\S*$" - } - }, - "com.amazonaws.bedrock#PositiveInteger": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.bedrock#Provider": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[A-Za-z0-9- ]{1,63}$" - } - }, - "com.amazonaws.bedrock#ProvisionedModelArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}$" - } - }, - "com.amazonaws.bedrock#ProvisionedModelId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^((([0-9a-zA-Z][_-]?)+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}))$" - } - }, - "com.amazonaws.bedrock#ProvisionedModelName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^([0-9a-zA-Z][_-]?)+$" - } - }, - "com.amazonaws.bedrock#ProvisionedModelStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Creating" - } - }, - "IN_SERVICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InService" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Updating" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - } - } - }, - "com.amazonaws.bedrock#ProvisionedModelSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#ProvisionedModelSummary" - } - }, - "com.amazonaws.bedrock#ProvisionedModelSummary": { - "type": "structure", - "members": { - "provisionedModelName": { - "target": "com.amazonaws.bedrock#ProvisionedModelName", - "traits": { - "smithy.api#documentation": "

The name of the Provisioned Throughput.

", - "smithy.api#required": {} - } - }, - "provisionedModelArn": { - "target": "com.amazonaws.bedrock#ProvisionedModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Provisioned Throughput.

", - "smithy.api#required": {} - } - }, - "modelArn": { - "target": "com.amazonaws.bedrock#ModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model associated with the Provisioned Throughput.

", - "smithy.api#required": {} - } - }, - "desiredModelArn": { - "target": "com.amazonaws.bedrock#ModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value differs from the modelArn if updating hasn't completed.

", - "smithy.api#required": {} - } - }, - "foundationModelArn": { - "target": "com.amazonaws.bedrock#FoundationModelArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized.

", - "smithy.api#required": {} - } - }, - "modelUnits": { - "target": "com.amazonaws.bedrock#PositiveInteger", - "traits": { - "smithy.api#documentation": "

The number of model units allocated to the Provisioned Throughput.

", - "smithy.api#required": {} - } - }, - "desiredModelUnits": { - "target": "com.amazonaws.bedrock#PositiveInteger", - "traits": { - "smithy.api#documentation": "

The number of model units that was requested to be allocated to the Provisioned Throughput.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.bedrock#ProvisionedModelStatus", - "traits": { - "smithy.api#documentation": "

The status of the Provisioned Throughput.

", - "smithy.api#required": {} - } - }, - "commitmentDuration": { - "target": "com.amazonaws.bedrock#CommitmentDuration", - "traits": { - "smithy.api#documentation": "

The duration for which the Provisioned Throughput was committed.

" - } - }, - "commitmentExpirationTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp for when the commitment term of the Provisioned Throughput expires.

" - } - }, - "creationTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the Provisioned Throughput was created.

", - "smithy.api#required": {} - } - }, - "lastModifiedTime": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the Provisioned Throughput was last modified.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A summary of information about a Provisioned Throughput.

\n

This data type is used in the following API operations:

\n " - } - }, - "com.amazonaws.bedrock#ProvisionedModelThroughputResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughput" - }, - { - "target": "com.amazonaws.bedrock#DeleteProvisionedModelThroughput" - }, - { - "target": "com.amazonaws.bedrock#GetProvisionedModelThroughput" - }, - { - "target": "com.amazonaws.bedrock#ListProvisionedModelThroughputs" - }, - { - "target": "com.amazonaws.bedrock#UpdateProvisionedModelThroughput" - } - ] - }, - "com.amazonaws.bedrock#PutModelInvocationLoggingConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#PutModelInvocationLoggingConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#PutModelInvocationLoggingConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Set the configuration values for model invocation logging.

", - "smithy.api#http": { - "code": 200, - "method": "PUT", - "uri": "/logging/modelinvocations" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.bedrock#PutModelInvocationLoggingConfigurationRequest": { - "type": "structure", - "members": { - "loggingConfig": { - "target": "com.amazonaws.bedrock#LoggingConfig", - "traits": { - "smithy.api#documentation": "

The logging configuration values to set.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#PutModelInvocationLoggingConfigurationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrock#NonBlankString" - } - }, - "traits": { - "smithy.api#documentation": "

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.bedrock#RoleArn": { - "type": "string", - "traits": { - "smithy.api#documentation": "ARN of a IAM role", - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$" - } - }, - "com.amazonaws.bedrock#S3Config": { - "type": "structure", - "members": { - "bucketName": { - "target": "com.amazonaws.bedrock#BucketName", - "traits": { - "smithy.api#documentation": "

S3 bucket name.

", - "smithy.api#required": {} - } - }, - "keyPrefix": { - "target": "com.amazonaws.bedrock#KeyPrefix", - "traits": { - "smithy.api#documentation": "

S3 prefix.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

S3 configuration for storing log data.

" - } - }, - "com.amazonaws.bedrock#S3InputFormat": { - "type": "enum", - "members": { - "JSONL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JSONL" - } - } - } - }, - "com.amazonaws.bedrock#S3Uri": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?$" - } - }, - "com.amazonaws.bedrock#SageMakerFlowDefinitionArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 1024 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:sagemaker:[a-z0-9-]{1,20}:[0-9]{12}:flow-definition/.*$" - } - }, - "com.amazonaws.bedrock#SecurityGroupId": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 32 - }, - "smithy.api#pattern": "^[-0-9a-zA-Z]+$" - } - }, - "com.amazonaws.bedrock#SecurityGroupIds": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#SecurityGroupId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.bedrock#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrock#NonBlankString" - } - }, - "traits": { - "smithy.api#documentation": "

The number of requests exceeds the service quota. Resubmit your request later.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.bedrock#SortByProvisionedModels": { - "type": "enum", - "members": { - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - } - } - }, - "com.amazonaws.bedrock#SortJobsBy": { - "type": "enum", - "members": { - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - } - } - }, - "com.amazonaws.bedrock#SortModelsBy": { - "type": "enum", - "members": { - "CREATION_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationTime" - } - } - } - }, - "com.amazonaws.bedrock#SortOrder": { - "type": "enum", - "members": { - "ASCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ascending" - } - }, - "DESCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Descending" - } - } - } - }, - "com.amazonaws.bedrock#StopEvaluationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#StopEvaluationJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#StopEvaluationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Stops an in progress model evaluation job.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/evaluation-job/{jobIdentifier}/stop" - } - } - }, - "com.amazonaws.bedrock#StopEvaluationJobRequest": { - "type": "structure", - "members": { - "jobIdentifier": { - "target": "com.amazonaws.bedrock#EvaluationJobIdentifier", - "traits": { - "smithy.api#documentation": "

The ARN of the model evaluation job you want to stop.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#StopEvaluationJobResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#StopModelCustomizationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#StopModelCustomizationJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#StopModelCustomizationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Stops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/model-customization-jobs/{jobIdentifier}/stop" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.bedrock#StopModelCustomizationJobRequest": { - "type": "structure", - "members": { - "jobIdentifier": { - "target": "com.amazonaws.bedrock#ModelCustomizationJobIdentifier", - "traits": { - "smithy.api#documentation": "

Job identifier of the job to stop.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#StopModelCustomizationJobResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#StopModelInvocationJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#StopModelInvocationJobRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#StopModelInvocationJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Stops a batch inference job. You're only charged for tokens that were already processed. For more information, see Stop a batch inference job.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/model-invocation-job/{jobIdentifier}/stop" - } - } - }, - "com.amazonaws.bedrock#StopModelInvocationJobRequest": { - "type": "structure", - "members": { - "jobIdentifier": { - "target": "com.amazonaws.bedrock#ModelInvocationJobIdentifier", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job to stop.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#StopModelInvocationJobResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#SubnetId": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 32 - }, - "smithy.api#pattern": "^[-0-9a-zA-Z]+$" - } - }, - "com.amazonaws.bedrock#SubnetIds": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#SubnetId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16 - } - } - }, - "com.amazonaws.bedrock#SubscriptionResource": { - "type": "resource" - }, - "com.amazonaws.bedrock#Tag": { - "type": "structure", - "members": { - "key": { - "target": "com.amazonaws.bedrock#TagKey", - "traits": { - "smithy.api#documentation": "

Key for the tag.

", - "smithy.api#required": {} - } - }, - "value": { - "target": "com.amazonaws.bedrock#TagValue", - "traits": { - "smithy.api#documentation": "

Value for the tag.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Definition of the key/value pair for a tag.

" - } - }, - "com.amazonaws.bedrock#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" - } - }, - "com.amazonaws.bedrock#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.bedrock#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#Tag" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.bedrock#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#TooManyTagsException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/tagResource" - } - } - }, - "com.amazonaws.bedrock#TagResourceRequest": { - "type": "structure", - "members": { - "resourceARN": { - "target": "com.amazonaws.bedrock#TaggableResourcesArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to tag.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.bedrock#TagList", - "traits": { - "smithy.api#documentation": "

Tags to associate with the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" - } - }, - "com.amazonaws.bedrock#TaggableResourcesArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 1011 - }, - "smithy.api#pattern": "(^[a-zA-Z0-9][a-zA-Z0-9\\-]*$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:([0-9]{12}|)((:(fine-tuning-job|model-customization-job|custom-model)/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12})$)|(:guardrail/[a-z0-9]+$)|(:(provisioned-model|model-invocation-job|model-evaluation-job|evaluation-job|model-import-job|imported-model)/[a-z0-9]{12}$)))" - } - }, - "com.amazonaws.bedrock#TaggingResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrock#ListTagsForResource" - }, - { - "target": "com.amazonaws.bedrock#TagResource" - }, - { - "target": "com.amazonaws.bedrock#UntagResource" - } - ] - }, - "com.amazonaws.bedrock#ThrottlingException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrock#NonBlankString" - } - }, - "traits": { - "smithy.api#documentation": "

The number of requests exceeds the limit. Resubmit your request later.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.bedrock#Timestamp": { - "type": "timestamp", - "traits": { - "smithy.api#timestampFormat": "date-time" - } - }, - "com.amazonaws.bedrock#TooManyTagsException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrock#NonBlankString" - }, - "resourceName": { - "target": "com.amazonaws.bedrock#TaggableResourcesArn", - "traits": { - "smithy.api#documentation": "

The name of the resource with too many tags.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The request contains more tags than can be associated with a resource (50 tags per resource). \n The maximum number of tags includes both existing tags and those included in your current request.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.bedrock#TrainingDataConfig": { - "type": "structure", - "members": { - "s3Uri": { - "target": "com.amazonaws.bedrock#S3Uri", - "traits": { - "smithy.api#documentation": "

The S3 URI where the training data is stored.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

S3 Location of the training data.

" - } - }, - "com.amazonaws.bedrock#TrainingMetrics": { - "type": "structure", - "members": { - "trainingLoss": { - "target": "com.amazonaws.bedrock#MetricFloat", - "traits": { - "smithy.api#documentation": "

Loss metric associated with the custom job.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metrics associated with the custom job.

" - } - }, - "com.amazonaws.bedrock#TrainingResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrock#CreateModelCustomizationJob" - }, - { - "target": "com.amazonaws.bedrock#GetModelCustomizationJob" - }, - { - "target": "com.amazonaws.bedrock#ListModelCustomizationJobs" - }, - { - "target": "com.amazonaws.bedrock#StopModelCustomizationJob" - } - ] - }, - "com.amazonaws.bedrock#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Remove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/untagResource" - } - } - }, - "com.amazonaws.bedrock#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceARN": { - "target": "com.amazonaws.bedrock#TaggableResourcesArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to untag.

", - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.bedrock#TagKeyList", - "traits": { - "smithy.api#documentation": "

Tag keys of the tags to remove from the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#UpdateGuardrail": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#UpdateGuardrailRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#UpdateGuardrailResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#ConflictException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a guardrail with the values you specify.

\n ", - "smithy.api#http": { - "code": 202, - "method": "PUT", - "uri": "/guardrails/{guardrailIdentifier}" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.bedrock#UpdateGuardrailRequest": { - "type": "structure", - "members": { - "guardrailIdentifier": { - "target": "com.amazonaws.bedrock#GuardrailIdentifier", - "traits": { - "smithy.api#documentation": "

The unique identifier of the guardrail. This can be an ID or the ARN.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.bedrock#GuardrailName", - "traits": { - "smithy.api#documentation": "

A name for the guardrail.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.bedrock#GuardrailDescription", - "traits": { - "smithy.api#documentation": "

A description of the guardrail.

" - } - }, - "topicPolicyConfig": { - "target": "com.amazonaws.bedrock#GuardrailTopicPolicyConfig", - "traits": { - "smithy.api#documentation": "

The topic policy to configure for the guardrail.

" - } - }, - "contentPolicyConfig": { - "target": "com.amazonaws.bedrock#GuardrailContentPolicyConfig", - "traits": { - "smithy.api#documentation": "

The content policy to configure for the guardrail.

" - } - }, - "wordPolicyConfig": { - "target": "com.amazonaws.bedrock#GuardrailWordPolicyConfig", - "traits": { - "smithy.api#documentation": "

The word policy to configure for the guardrail.

" - } - }, - "sensitiveInformationPolicyConfig": { - "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicyConfig", - "traits": { - "smithy.api#documentation": "

The sensitive information policy to configure for the guardrail.

" - } - }, - "contextualGroundingPolicyConfig": { - "target": "com.amazonaws.bedrock#GuardrailContextualGroundingPolicyConfig", - "traits": { - "smithy.api#documentation": "

The contextual grounding policy configuration used to update a guardrail.

" - } - }, - "blockedInputMessaging": { - "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", - "traits": { - "smithy.api#documentation": "

The message to return when the guardrail blocks a prompt.

", - "smithy.api#required": {} - } - }, - "blockedOutputsMessaging": { - "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", - "traits": { - "smithy.api#documentation": "

The message to return when the guardrail blocks a model response.

", - "smithy.api#required": {} - } - }, - "kmsKeyId": { - "target": "com.amazonaws.bedrock#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The ARN of the KMS key with which to encrypt the guardrail.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#UpdateGuardrailResponse": { - "type": "structure", - "members": { - "guardrailId": { - "target": "com.amazonaws.bedrock#GuardrailId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the guardrail

", - "smithy.api#required": {} - } - }, - "guardrailArn": { - "target": "com.amazonaws.bedrock#GuardrailArn", - "traits": { - "smithy.api#documentation": "

The ARN of the guardrail.

", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.bedrock#GuardrailDraftVersion", - "traits": { - "smithy.api#documentation": "

The version of the guardrail.

", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.bedrock#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time at which the guardrail was updated.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#UpdateProvisionedModelThroughput": { - "type": "operation", - "input": { - "target": "com.amazonaws.bedrock#UpdateProvisionedModelThroughputRequest" - }, - "output": { - "target": "com.amazonaws.bedrock#UpdateProvisionedModelThroughputResponse" - }, - "errors": [ - { - "target": "com.amazonaws.bedrock#AccessDeniedException" - }, - { - "target": "com.amazonaws.bedrock#InternalServerException" - }, - { - "target": "com.amazonaws.bedrock#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.bedrock#ThrottlingException" - }, - { - "target": "com.amazonaws.bedrock#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

", - "smithy.api#http": { - "code": 200, - "method": "PATCH", - "uri": "/provisioned-model-throughput/{provisionedModelId}" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.bedrock#UpdateProvisionedModelThroughputRequest": { - "type": "structure", - "members": { - "provisionedModelId": { - "target": "com.amazonaws.bedrock#ProvisionedModelId", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) or name of the Provisioned Throughput to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "desiredProvisionedModelName": { - "target": "com.amazonaws.bedrock#ProvisionedModelName", - "traits": { - "smithy.api#documentation": "

The new name for this Provisioned Throughput.

" - } - }, - "desiredModelId": { - "target": "com.amazonaws.bedrock#ModelIdentifier", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the new model to associate with this Provisioned Throughput. You can't specify this field if this Provisioned Throughput is associated with a base model.

\n

If this Provisioned Throughput is associated with a custom model, you can specify one of the following options:

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrock#UpdateProvisionedModelThroughputResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.bedrock#ValidationDataConfig": { - "type": "structure", - "members": { - "validators": { - "target": "com.amazonaws.bedrock#Validators", - "traits": { - "smithy.api#documentation": "

Information about the validators.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Array of up to 10 validators.

" - } - }, - "com.amazonaws.bedrock#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrock#NonBlankString" - } - }, - "traits": { - "smithy.api#documentation": "

Input validation failed. Check your request parameters and retry the request.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.bedrock#ValidationMetrics": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#ValidatorMetric" - } - }, - "com.amazonaws.bedrock#Validator": { - "type": "structure", - "members": { - "s3Uri": { - "target": "com.amazonaws.bedrock#S3Uri", - "traits": { - "smithy.api#documentation": "

The S3 URI where the validation data is stored.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a validator.

" - } - }, - "com.amazonaws.bedrock#ValidatorMetric": { - "type": "structure", - "members": { - "validationLoss": { - "target": "com.amazonaws.bedrock#MetricFloat", - "traits": { - "smithy.api#documentation": "

The validation loss associated with this validator.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The metric for the validator.

" - } - }, - "com.amazonaws.bedrock#Validators": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrock#Validator" - }, - "traits": { - "smithy.api#length": { - "max": 10 - } - } - }, - "com.amazonaws.bedrock#VpcConfig": { - "type": "structure", - "members": { - "subnetIds": { - "target": "com.amazonaws.bedrock#SubnetIds", - "traits": { - "smithy.api#documentation": "

VPC configuration subnets.

", - "smithy.api#required": {} - } - }, - "securityGroupIds": { - "target": "com.amazonaws.bedrock#SecurityGroupIds", - "traits": { - "smithy.api#documentation": "

VPC configuration security group Ids.

", - "smithy.api#required": {} - } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.bedrock#AutomatedEvaluationConfig": { + "type": "structure", + "members": { + "datasetMetricConfigs": { + "target": "com.amazonaws.bedrock#EvaluationDatasetMetricConfigs", + "traits": { + "smithy.api#documentation": "

Specifies the required elements for an automatic model evaluation job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Use to specify a automatic model evaluation job. The EvaluationDatasetMetricConfig object is used to specify the prompt datasets, task type, and metric names.

" + } + }, + "com.amazonaws.bedrock#BaseModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$" + } + }, + "com.amazonaws.bedrock#BatchDeleteEvaluationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a batch deletion job. A model evaluation job can only be deleted if it has following status FAILED, COMPLETED, and STOPPED. You can request up to 25 model evaluation jobs be deleted in a single request.

", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/evaluation-jobs/batch-delete" + } + } + }, + "com.amazonaws.bedrock#BatchDeleteEvaluationJobError": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationJobIdentifier", + "traits": { + "smithy.api#documentation": "

The ARN of the model evaluation job being deleted.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A HTTP status code of the model evaluation job being deleted.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A status message about the model evaluation job deletion.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A JSON array that provides the status of the model evaluation jobs being deleted.

" + } + }, + "com.amazonaws.bedrock#BatchDeleteEvaluationJobErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobError" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.bedrock#BatchDeleteEvaluationJobItem": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationJobIdentifier", + "traits": { + "smithy.api#documentation": "

The ARN of model evaluation job to be deleted.

", + "smithy.api#required": {} + } + }, + "jobStatus": { + "target": "com.amazonaws.bedrock#EvaluationJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the job's deletion.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An array of model evaluation jobs to be deleted, and their associated statuses.

" + } + }, + "com.amazonaws.bedrock#BatchDeleteEvaluationJobItems": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobItem" + } + }, + "com.amazonaws.bedrock#BatchDeleteEvaluationJobRequest": { + "type": "structure", + "members": { + "jobIdentifiers": { + "target": "com.amazonaws.bedrock#EvaluationJobIdentifiers", + "traits": { + "smithy.api#documentation": "

An array of model evaluation job ARNs to be deleted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#BatchDeleteEvaluationJobResponse": { + "type": "structure", + "members": { + "errors": { + "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobErrors", + "traits": { + "smithy.api#documentation": "

A JSON object containing the HTTP status codes and the ARNs of model evaluation jobs that failed to be deleted.

", + "smithy.api#required": {} + } + }, + "evaluationJobs": { + "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJobItems", + "traits": { + "smithy.api#documentation": "

The list of model evaluation jobs to be deleted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#BedrockModelId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 140 + }, + "smithy.api#pattern": "^[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)$" + } + }, + "com.amazonaws.bedrock#BrandedName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.bedrock#BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + } + } + }, + "com.amazonaws.bedrock#CloudWatchConfig": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.bedrock#LogGroupName", + "traits": { + "smithy.api#documentation": "

The log group name.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "

The role Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + }, + "largeDataDeliveryS3Config": { + "target": "com.amazonaws.bedrock#S3Config", + "traits": { + "smithy.api#documentation": "

S3 configuration for delivering a large amount of data.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

CloudWatch logging configuration.

" + } + }, + "com.amazonaws.bedrock#CommitmentDuration": { + "type": "enum", + "members": { + "ONE_MONTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OneMonth" + } + }, + "SIX_MONTHS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SixMonths" + } + } + } + }, + "com.amazonaws.bedrock#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrock#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "

Error occurred because of a conflict while performing an operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrock#CreateEvaluationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateEvaluationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateEvaluationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers. To learn more about the requirements for creating a model evaluation job see, Model evaluation.

", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/evaluation-jobs" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#CreateEvaluationJobRequest": { + "type": "structure", + "members": { + "jobName": { + "target": "com.amazonaws.bedrock#EvaluationJobName", + "traits": { + "smithy.api#documentation": "

The name of the model evaluation job. Model evaluation job names must unique with your AWS account, and your account's AWS region.

", + "smithy.api#required": {} + } + }, + "jobDescription": { + "target": "com.amazonaws.bedrock#EvaluationJobDescription", + "traits": { + "smithy.api#documentation": "

A description of the model evaluation job.

" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. The service role must have Amazon Bedrock as the service principal, and provide access to any Amazon S3 buckets specified in the EvaluationConfig object. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission. To learn more about the required permissions, see Required permissions.

", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "

Specify your customer managed key ARN that will be used to encrypt your model evaluation job.

" + } + }, + "jobTags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "

Tags to attach to the model evaluation job.

" + } + }, + "evaluationConfig": { + "target": "com.amazonaws.bedrock#EvaluationConfig", + "traits": { + "smithy.api#documentation": "

Specifies whether the model evaluation job is automatic or uses human worker.

", + "smithy.api#required": {} + } + }, + "inferenceConfig": { + "target": "com.amazonaws.bedrock#EvaluationInferenceConfig", + "traits": { + "smithy.api#documentation": "

Specify the models you want to use in your model evaluation job. Automatic model evaluation jobs support a single model, and model evaluation job that use human workers support two models.

", + "smithy.api#required": {} + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#EvaluationOutputDataConfig", + "traits": { + "smithy.api#documentation": "

An object that defines where the results of model evaluation job will be saved in Amazon S3.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateEvaluationJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#EvaluationJobArn", + "traits": { + "smithy.api#documentation": "

The ARN of the model evaluation job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateGuardrail": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateGuardrailRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateGuardrailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a guardrail to block topics and to implement safeguards for your generative AI applications.

\n

You can configure the following policies in a guardrail to avoid undesirable and harmful content, filter \n out denied topics and words, and remove sensitive information for privacy protection.

\n \n

In addition to the above policies, you can also configure the messages to be returned to \n the user if a user input or model response is in violation of the policies defined in the guardrail.

\n

For more information, see Guardrails for Amazon Bedrock in\n the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/guardrails" + } + } + }, + "com.amazonaws.bedrock#CreateGuardrailRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#GuardrailName", + "traits": { + "smithy.api#documentation": "

The name to give the guardrail.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#GuardrailDescription", + "traits": { + "smithy.api#documentation": "

A description of the guardrail.

" + } + }, + "topicPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailTopicPolicyConfig", + "traits": { + "smithy.api#documentation": "

The topic policies to configure for the guardrail.

" + } + }, + "contentPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailContentPolicyConfig", + "traits": { + "smithy.api#documentation": "

The content filter policies to configure for the guardrail.

" + } + }, + "wordPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailWordPolicyConfig", + "traits": { + "smithy.api#documentation": "

The word policy you configure for the guardrail.

" + } + }, + "sensitiveInformationPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicyConfig", + "traits": { + "smithy.api#documentation": "

The sensitive information policy to configure for the guardrail.

" + } + }, + "contextualGroundingPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingPolicyConfig", + "traits": { + "smithy.api#documentation": "

The contextual grounding policy configuration used to create a guardrail.

" + } + }, + "blockedInputMessaging": { + "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", + "traits": { + "smithy.api#documentation": "

The message to return when the guardrail blocks a prompt.

", + "smithy.api#required": {} + } + }, + "blockedOutputsMessaging": { + "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", + "traits": { + "smithy.api#documentation": "

The message to return when the guardrail blocks a model response.

", + "smithy.api#required": {} + } + }, + "kmsKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key that you use to encrypt the guardrail.

" + } + }, + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "

The tags that you want to attach to the guardrail.

" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request \n completes no more than once. If this token matches a previous request, \n Amazon Bedrock ignores the request, but does not return an error. \n For more information, see Ensuring \n idempotency in the Amazon S3 User Guide.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateGuardrailResponse": { + "type": "structure", + "members": { + "guardrailId": { + "target": "com.amazonaws.bedrock#GuardrailId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the guardrail that was created.

", + "smithy.api#required": {} + } + }, + "guardrailArn": { + "target": "com.amazonaws.bedrock#GuardrailArn", + "traits": { + "smithy.api#documentation": "

The ARN of the guardrail.

", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrock#GuardrailDraftVersion", + "traits": { + "smithy.api#documentation": "

The version of the guardrail that was created. \n This value will always be DRAFT.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the guardrail was created.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateGuardrailVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateGuardrailVersionRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateGuardrailVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a version of the guardrail. Use this API to create a snapshot of the \n guardrail when you are satisfied with a configuration, or to compare the configuration with another version.

", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/guardrails/{guardrailIdentifier}" + } + } + }, + "com.amazonaws.bedrock#CreateGuardrailVersionRequest": { + "type": "structure", + "members": { + "guardrailIdentifier": { + "target": "com.amazonaws.bedrock#GuardrailIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the guardrail. This can be an ID or the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#GuardrailDescription", + "traits": { + "smithy.api#documentation": "

A description of the guardrail version.

" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request \n completes no more than once. If this token matches a previous request, \n Amazon Bedrock ignores the request, but does not return an error. \n For more information, see Ensuring \n idempotency in the Amazon S3 User Guide.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateGuardrailVersionResponse": { + "type": "structure", + "members": { + "guardrailId": { + "target": "com.amazonaws.bedrock#GuardrailId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the guardrail.

", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrock#GuardrailNumericalVersion", + "traits": { + "smithy.api#documentation": "

The number of the version of the guardrail.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateModelCopyJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateModelCopyJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateModelCopyJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + } + ], + "traits": { + "smithy.api#documentation": "

Copies a model to another region so that it can be used there. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/model-copy-jobs" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#CreateModelCopyJobRequest": { + "type": "structure", + "members": { + "sourceModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model to be copied.

", + "smithy.api#required": {} + } + }, + "targetModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "

A name for the copied model.

", + "smithy.api#required": {} + } + }, + "modelKmsKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key that you use to encrypt the model copy.

" + } + }, + "targetModelTags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "

Tags to associate with the target model. For more information, see Tag resources in the Amazon Bedrock User Guide.

" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n\t Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateModelCopyJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCopyJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model copy job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateModelCustomizationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateModelCustomizationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateModelCustomizationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a fine-tuning job to customize a base model.

\n

You specify the base foundation model and the location of the training data.\n After the model-customization job completes successfully, your custom model resource will be ready to use. Amazon Bedrock returns validation loss metrics and output generations after the job completes.\n

\n

For information on the format of training and validation data, see Prepare the datasets.

\n

\n Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size.\n To monitor a job, use the GetModelCustomizationJob operation to retrieve the job status.

\n

For more information, see Custom models in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/model-customization-jobs" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#CreateModelCustomizationJobRequest": { + "type": "structure", + "members": { + "jobName": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "

A name for the fine-tuning job.

", + "smithy.api#required": {} + } + }, + "customModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "

A name for the resulting custom model.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf.\n For example, during model training, Amazon Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket.\n To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission.\n

", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "baseModelIdentifier": { + "target": "com.amazonaws.bedrock#BaseModelIdentifier", + "traits": { + "smithy.api#documentation": "

Name of the base model.

", + "smithy.api#required": {} + } + }, + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", + "traits": { + "smithy.api#documentation": "

The customization type.

" + } + }, + "customModelKmsKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The custom model is encrypted at rest using this key.

" + } + }, + "jobTags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "

Tags to attach to the job.

" + } + }, + "customModelTags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "

Tags to attach to the resulting custom model.

" + } + }, + "trainingDataConfig": { + "target": "com.amazonaws.bedrock#TrainingDataConfig", + "traits": { + "smithy.api#documentation": "

Information about the training dataset.

", + "smithy.api#required": {} + } + }, + "validationDataConfig": { + "target": "com.amazonaws.bedrock#ValidationDataConfig", + "traits": { + "smithy.api#documentation": "

Information about the validation dataset.

" + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

S3 location for the output data.

", + "smithy.api#required": {} + } + }, + "hyperParameters": { + "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", + "traits": { + "smithy.api#documentation": "

Parameters related to tuning the model. For details on the format for different models, see Custom model hyperparameters.

", + "smithy.api#required": {} + } + }, + "vpcConfig": { + "target": "com.amazonaws.bedrock#VpcConfig", + "traits": { + "smithy.api#documentation": "

VPC configuration (optional). Configuration parameters for the\n private Virtual Private Cloud (VPC) that contains the resources you are using for this job.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateModelCustomizationJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the fine tuning job

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateModelImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateModelImportJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateModelImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a model import job to import model that you have customized in other environments, such as Amazon SageMaker. For more information, \n see Import a customized model\n

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/model-import-jobs" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#CreateModelImportJobRequest": { + "type": "structure", + "members": { + "jobName": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "

The name of the import job.

", + "smithy.api#required": {} + } + }, + "importedModelName": { + "target": "com.amazonaws.bedrock#ImportedModelName", + "traits": { + "smithy.api#documentation": "

The name of the imported model.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model import job.

", + "smithy.api#required": {} + } + }, + "modelDataSource": { + "target": "com.amazonaws.bedrock#ModelDataSource", + "traits": { + "smithy.api#documentation": "

The data source for the imported model.

", + "smithy.api#required": {} + } + }, + "jobTags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "

Tags to attach to this import job.

" + } + }, + "importedModelTags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "

Tags to attach to the imported model.

" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, \n see Ensuring idempotency.

" + } + }, + "vpcConfig": { + "target": "com.amazonaws.bedrock#VpcConfig", + "traits": { + "smithy.api#documentation": "

VPC configuration parameters for the\n private Virtual Private Cloud (VPC) that contains the resources you are using for the import job.

" + } + }, + "importedModelKmsKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The imported model is encrypted at rest using this key.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateModelImportJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelImportJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model import job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateModelInvocationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateModelInvocationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateModelInvocationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a job to invoke a model on multiple prompts (batch inference). Format your data according to Format your inference data and upload it to an Amazon S3 bucket. For more information, see Create a batch inference job.

\n

The response returns a jobArn that you can use to stop or get details about the job. You can check the status of the job by sending a GetModelCustomizationJob request.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/model-invocation-job" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#CreateModelInvocationJobRequest": { + "type": "structure", + "members": { + "jobName": { + "target": "com.amazonaws.bedrock#ModelInvocationJobName", + "traits": { + "smithy.api#documentation": "

A name to give the batch inference job.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.

", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#ModelInvocationIdempotencyToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n\t Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrock#ModelId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the foundation model to use for the batch inference job.

", + "smithy.api#required": {} + } + }, + "inputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobInputDataConfig", + "traits": { + "smithy.api#documentation": "

Details about the location of the input to the batch inference job.

", + "smithy.api#required": {} + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobOutputDataConfig", + "traits": { + "smithy.api#documentation": "

Details about the location of the output of the batch inference job.

", + "smithy.api#required": {} + } + }, + "timeoutDurationInHours": { + "target": "com.amazonaws.bedrock#ModelInvocationJobTimeoutDurationInHours", + "traits": { + "smithy.api#documentation": "

The number of hours after which to force the batch inference job to time out.

" + } + }, + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "

Any tags to associate with the batch inference job. For more information, see Tagging Amazon Bedrock resources.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateModelInvocationJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelInvocationJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CreateProvisionedModelThroughput": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughputRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughputResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify. For pricing details, see Amazon Bedrock Pricing. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/provisioned-model-throughput" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#CreateProvisionedModelThroughputRequest": { + "type": "structure", + "members": { + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.

", + "smithy.api#idempotencyToken": {} + } + }, + "modelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", + "traits": { + "smithy.api#documentation": "

Number of model units to allocate. A model unit delivers a specific throughput level for the specified model. The throughput level of a model unit specifies the total number of input and output tokens that it can process and generate within a span of one minute. By default, your account has no model units for purchasing Provisioned Throughputs with commitment. You must first visit the Amazon Web Services support center to request MUs.

\n

For model unit quotas, see Provisioned Throughput quotas in the Amazon Bedrock User Guide.

\n

For more information about what an MU specifies, contact your Amazon Web Services account manager.

", + "smithy.api#required": {} + } + }, + "provisionedModelName": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", + "traits": { + "smithy.api#documentation": "

The name for this Provisioned Throughput.

", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrock#ModelIdentifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or name of the model to associate with this Provisioned Throughput. For a list of models for which you can purchase Provisioned Throughput, see Amazon Bedrock model IDs for purchasing Provisioned Throughput in the Amazon Bedrock User Guide.

", + "smithy.api#required": {} + } + }, + "commitmentDuration": { + "target": "com.amazonaws.bedrock#CommitmentDuration", + "traits": { + "smithy.api#documentation": "

The commitment duration requested for the Provisioned Throughput. Billing occurs hourly and is discounted for longer commitment terms. To request a no-commit Provisioned Throughput, omit this field.

\n

Custom models support all levels of commitment. To see which base models support no commitment, see Supported regions and models for Provisioned Throughput in the Amazon Bedrock User Guide\n

" + } + }, + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "

Tags to associate with this Provisioned Throughput.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#CreateProvisionedModelThroughputResponse": { + "type": "structure", + "members": { + "provisionedModelArn": { + "target": "com.amazonaws.bedrock#ProvisionedModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for this Provisioned Throughput.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#CustomModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#CustomModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,63}$" + } + }, + "com.amazonaws.bedrock#CustomModelSummary": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the custom model.

", + "smithy.api#required": {} + } + }, + "modelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "

The name of the custom model.

", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Creation time of the model.

", + "smithy.api#required": {} + } + }, + "baseModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "

The base model Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + }, + "baseModelName": { + "target": "com.amazonaws.bedrock#ModelName", + "traits": { + "smithy.api#documentation": "

The base model name.

", + "smithy.api#required": {} + } + }, + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", + "traits": { + "smithy.api#documentation": "

Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.

" + } + }, + "ownerAccountId": { + "target": "com.amazonaws.bedrock#AccountId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the account that owns the model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary information for a custom model.

" + } + }, + "com.amazonaws.bedrock#CustomModelSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#CustomModelSummary" + } + }, + "com.amazonaws.bedrock#CustomizationType": { + "type": "enum", + "members": { + "FINE_TUNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FINE_TUNING" + } + }, + "CONTINUED_PRE_TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTINUED_PRE_TRAINING" + } + } + } + }, + "com.amazonaws.bedrock#DeleteCustomModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeleteCustomModelRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeleteCustomModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/custom-models/{modelIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#DeleteCustomModelRequest": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#ModelIdentifier", + "traits": { + "smithy.api#documentation": "

Name of the model to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteCustomModelResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DeleteGuardrail": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeleteGuardrailRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeleteGuardrailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a guardrail.

\n ", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/guardrails/{guardrailIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#DeleteGuardrailRequest": { + "type": "structure", + "members": { + "guardrailIdentifier": { + "target": "com.amazonaws.bedrock#GuardrailIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the guardrail. This can be an ID or the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "guardrailVersion": { + "target": "com.amazonaws.bedrock#GuardrailNumericalVersion", + "traits": { + "smithy.api#documentation": "

The version of the guardrail.

", + "smithy.api#httpQuery": "guardrailVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteGuardrailResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DeleteImportedModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeleteImportedModelRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeleteImportedModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a custom model that you imported earlier. For more information, \n see Import a customized model in the Amazon Bedrock User Guide.\n

", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/imported-models/{modelIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#DeleteImportedModelRequest": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#ImportedModelIdentifier", + "traits": { + "smithy.api#documentation": "

Name of the imported model to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteImportedModelResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete the invocation logging.

", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/logging/modelinvocations" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#DeleteProvisionedModelThroughput": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#DeleteProvisionedModelThroughputRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#DeleteProvisionedModelThroughputResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a Provisioned Throughput. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/provisioned-model-throughput/{provisionedModelId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#DeleteProvisionedModelThroughputRequest": { + "type": "structure", + "members": { + "provisionedModelId": { + "target": "com.amazonaws.bedrock#ProvisionedModelId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or name of the Provisioned Throughput.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#DeleteProvisionedModelThroughputResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + } + } + }, + "com.amazonaws.bedrock#ErrorMessages": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ErrorMessage" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.bedrock#EvaluationBedrockModel": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationModelIdentifier", + "traits": { + "smithy.api#documentation": "

The ARN of the Amazon Bedrock model specified.

", + "smithy.api#required": {} + } + }, + "inferenceParams": { + "target": "com.amazonaws.bedrock#EvaluationModelInferenceParams", + "traits": { + "smithy.api#documentation": "

Each Amazon Bedrock support different inference parameters that change how the model behaves during inference.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the ARN of the Amazon Bedrock models specified in your model evaluation job. Each Amazon Bedrock model supports different inferenceParams. To learn more about supported inference parameters for Amazon Bedrock models, see Inference parameters for foundation models.

\n

The inferenceParams are specified using JSON. To successfully insert JSON as string make sure that all quotations are properly escaped. For example, \"temperature\":\"0.25\" key value pair would need to be formatted as \\\"temperature\\\":\\\"0.25\\\" to successfully accepted in the request.

" + } + }, + "com.amazonaws.bedrock#EvaluationConfig": { + "type": "union", + "members": { + "automated": { + "target": "com.amazonaws.bedrock#AutomatedEvaluationConfig", + "traits": { + "smithy.api#documentation": "

Used to specify an automated model evaluation job.\n See AutomatedEvaluationConfig to view the required parameters.

" + } + }, + "human": { + "target": "com.amazonaws.bedrock#HumanEvaluationConfig", + "traits": { + "smithy.api#documentation": "

Used to specify a model evaluation job that uses human workers.See HumanEvaluationConfig to view the required parameters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Used to specify either a AutomatedEvaluationConfig or HumanEvaluationConfig object.

" + } + }, + "com.amazonaws.bedrock#EvaluationDataset": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#EvaluationDatasetName", + "traits": { + "smithy.api#documentation": "

Used to specify supported built-in prompt datasets. Valid values are Builtin.Bold, Builtin.BoolQ, Builtin.NaturalQuestions, Builtin.Gigaword, Builtin.RealToxicityPrompts, Builtin.TriviaQA, Builtin.T-Rex, Builtin.WomensEcommerceClothingReviews and Builtin.Wikitext2.

", + "smithy.api#required": {} + } + }, + "datasetLocation": { + "target": "com.amazonaws.bedrock#EvaluationDatasetLocation", + "traits": { + "smithy.api#documentation": "

For custom prompt datasets, you must specify the location in Amazon S3 where the prompt dataset is saved.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Used to specify the name of a built-in prompt dataset and optionally, the Amazon S3 bucket where a custom prompt dataset is saved.

" + } + }, + "com.amazonaws.bedrock#EvaluationDatasetLocation": { + "type": "union", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", + "traits": { + "smithy.api#documentation": "

The S3 URI of the S3 bucket specified in the job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The location in Amazon S3 where your prompt dataset is stored.

" + } + }, + "com.amazonaws.bedrock#EvaluationDatasetMetricConfig": { + "type": "structure", + "members": { + "taskType": { + "target": "com.amazonaws.bedrock#EvaluationTaskType", + "traits": { + "smithy.api#documentation": "

The task type you want the model to carry out.

", + "smithy.api#required": {} + } + }, + "dataset": { + "target": "com.amazonaws.bedrock#EvaluationDataset", + "traits": { + "smithy.api#documentation": "

Specifies the prompt dataset.

", + "smithy.api#required": {} + } + }, + "metricNames": { + "target": "com.amazonaws.bedrock#EvaluationMetricNames", + "traits": { + "smithy.api#documentation": "

The names of the metrics used. For automated model evaluation jobs valid values are \"Builtin.Accuracy\", \"Builtin.Robustness\", and \"Builtin.Toxicity\". In human-based model evaluation jobs the array of strings must match the name parameter specified in HumanEvaluationCustomMetric.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the built-in prompt datasets, built-in metric names and custom metric names, and the task type.

" + } + }, + "com.amazonaws.bedrock#EvaluationDatasetMetricConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationDatasetMetricConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrock#EvaluationDatasetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-_.]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationInferenceConfig": { + "type": "union", + "members": { + "models": { + "target": "com.amazonaws.bedrock#EvaluationModelConfigs", + "traits": { + "smithy.api#documentation": "

Used to specify the models.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Used to define the models you want used in your model evaluation job. Automated model evaluation jobs support only a single model. In a human-based model evaluation job, your annotator can compare the responses for up to two different models.

" + } + }, + "com.amazonaws.bedrock#EvaluationJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#EvaluationJobDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^.+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationJobIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12})$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationJobIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationJobIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.bedrock#EvaluationJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9](-*[a-z0-9]){0,62}$" + } + }, + "com.amazonaws.bedrock#EvaluationJobResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#BatchDeleteEvaluationJob" + }, + { + "target": "com.amazonaws.bedrock#CreateEvaluationJob" + }, + { + "target": "com.amazonaws.bedrock#GetEvaluationJob" + }, + { + "target": "com.amazonaws.bedrock#ListEvaluationJobs" + }, + { + "target": "com.amazonaws.bedrock#StopEvaluationJob" + } + ] + }, + "com.amazonaws.bedrock#EvaluationJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "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" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + } + }, + "com.amazonaws.bedrock#EvaluationJobType": { + "type": "enum", + "members": { + "HUMAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Human" + } + }, + "AUTOMATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Automated" + } + } + } + }, + "com.amazonaws.bedrock#EvaluationMetricDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^.+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationMetricName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-_.]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationMetricNames": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationMetricName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrock#EvaluationModelConfig": { + "type": "union", + "members": { + "bedrockModel": { + "target": "com.amazonaws.bedrock#EvaluationBedrockModel", + "traits": { + "smithy.api#documentation": "

Defines the Amazon Bedrock model and inference parameters you want used.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the models used in the model evaluation job.

" + } + }, + "com.amazonaws.bedrock#EvaluationModelConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationModelConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.bedrock#EvaluationModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$" + } + }, + "com.amazonaws.bedrock#EvaluationModelIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationModelIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.bedrock#EvaluationModelInferenceParams": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1023 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#EvaluationOutputDataConfig": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI where the results of model evaluation job are saved.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon S3 location where the results of your model evaluation job are saved.

" + } + }, + "com.amazonaws.bedrock#EvaluationRatingMethod": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-_]+$" + } + }, + "com.amazonaws.bedrock#EvaluationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationSummary" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrock#EvaluationSummary": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#EvaluationJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model evaluation job.

", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#EvaluationJobName", + "traits": { + "smithy.api#documentation": "

The name of the model evaluation job.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#EvaluationJobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the model evaluation job.

", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

When the model evaluation job was created.

", + "smithy.api#required": {} + } + }, + "jobType": { + "target": "com.amazonaws.bedrock#EvaluationJobType", + "traits": { + "smithy.api#documentation": "

The type, either human or automatic, of model evaluation job.

", + "smithy.api#required": {} + } + }, + "evaluationTaskTypes": { + "target": "com.amazonaws.bedrock#EvaluationTaskTypes", + "traits": { + "smithy.api#documentation": "

What task type was used in the model evaluation job.

", + "smithy.api#required": {} + } + }, + "modelIdentifiers": { + "target": "com.amazonaws.bedrock#EvaluationModelIdentifiers", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the model(s) used in the model evaluation job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the model evaluation job.

" + } + }, + "com.amazonaws.bedrock#EvaluationTaskType": { + "type": "enum", + "members": { + "SUMMARIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Summarization" + } + }, + "CLASSIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Classification" + } + }, + "QUESTION_AND_ANSWER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QuestionAndAnswer" + } + }, + "GENERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Generation" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Custom" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[A-Za-z0-9]+$" + } + }, + "com.amazonaws.bedrock#EvaluationTaskTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#EvaluationTaskType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrock#FineTuningJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "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" + } + } + } + }, + "com.amazonaws.bedrock#FoundationModelArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$" + } + }, + "com.amazonaws.bedrock#FoundationModelDetails": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "

The model Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrock#BedrockModelId", + "traits": { + "smithy.api#documentation": "

The model identifier.

", + "smithy.api#required": {} + } + }, + "modelName": { + "target": "com.amazonaws.bedrock#BrandedName", + "traits": { + "smithy.api#documentation": "

The model name.

" + } + }, + "providerName": { + "target": "com.amazonaws.bedrock#BrandedName", + "traits": { + "smithy.api#documentation": "

The model's provider name.

" + } + }, + "inputModalities": { + "target": "com.amazonaws.bedrock#ModelModalityList", + "traits": { + "smithy.api#documentation": "

The input modalities that the model supports.

" + } + }, + "outputModalities": { + "target": "com.amazonaws.bedrock#ModelModalityList", + "traits": { + "smithy.api#documentation": "

The output modalities that the model supports.

" + } + }, + "responseStreamingSupported": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the model supports streaming.

" + } + }, + "customizationsSupported": { + "target": "com.amazonaws.bedrock#ModelCustomizationList", + "traits": { + "smithy.api#documentation": "

The customization that the model supports.

" + } + }, + "inferenceTypesSupported": { + "target": "com.amazonaws.bedrock#InferenceTypeList", + "traits": { + "smithy.api#documentation": "

The inference types that the model supports.

" + } + }, + "modelLifecycle": { + "target": "com.amazonaws.bedrock#FoundationModelLifecycle", + "traits": { + "smithy.api#documentation": "

Contains details about whether a model version is available or deprecated

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a foundation model.

" + } + }, + "com.amazonaws.bedrock#FoundationModelLifecycle": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrock#FoundationModelLifecycleStatus", + "traits": { + "smithy.api#documentation": "

Specifies whether a model version is available (ACTIVE) or deprecated (LEGACY.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about whether a model version is available or deprecated.

" + } + }, + "com.amazonaws.bedrock#FoundationModelLifecycleStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "LEGACY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEGACY" + } + } + } + }, + "com.amazonaws.bedrock#FoundationModelSummary": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the foundation model.

", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrock#BedrockModelId", + "traits": { + "smithy.api#documentation": "

The model ID of the foundation model.

", + "smithy.api#required": {} + } + }, + "modelName": { + "target": "com.amazonaws.bedrock#BrandedName", + "traits": { + "smithy.api#documentation": "

The name of the model.

" + } + }, + "providerName": { + "target": "com.amazonaws.bedrock#BrandedName", + "traits": { + "smithy.api#documentation": "

The model's provider name.

" + } + }, + "inputModalities": { + "target": "com.amazonaws.bedrock#ModelModalityList", + "traits": { + "smithy.api#documentation": "

The input modalities that the model supports.

" + } + }, + "outputModalities": { + "target": "com.amazonaws.bedrock#ModelModalityList", + "traits": { + "smithy.api#documentation": "

The output modalities that the model supports.

" + } + }, + "responseStreamingSupported": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the model supports streaming.

" + } + }, + "customizationsSupported": { + "target": "com.amazonaws.bedrock#ModelCustomizationList", + "traits": { + "smithy.api#documentation": "

Whether the model supports fine-tuning or continual pre-training.

" + } + }, + "inferenceTypesSupported": { + "target": "com.amazonaws.bedrock#InferenceTypeList", + "traits": { + "smithy.api#documentation": "

The inference types that the model supports.

" + } + }, + "modelLifecycle": { + "target": "com.amazonaws.bedrock#FoundationModelLifecycle", + "traits": { + "smithy.api#documentation": "

Contains details about whether a model version is available or deprecated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary information for a foundation model.

" + } + }, + "com.amazonaws.bedrock#FoundationModelSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#FoundationModelSummary" + } + }, + "com.amazonaws.bedrock#GetCustomModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetCustomModelRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetCustomModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get the properties associated with a Amazon Bedrock custom model that you have created.For more information, see Custom models in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/custom-models/{modelIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetCustomModelRequest": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#ModelIdentifier", + "traits": { + "smithy.api#documentation": "

Name or Amazon Resource Name (ARN) of the custom model.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetCustomModelResponse": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) associated with this model.

", + "smithy.api#required": {} + } + }, + "modelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "

Model name associated with this model.

", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "

Job name associated with this model.

" + } + }, + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", + "traits": { + "smithy.api#documentation": "

Job Amazon Resource Name (ARN) associated with this model.

", + "smithy.api#required": {} + } + }, + "baseModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the base model.

", + "smithy.api#required": {} + } + }, + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", + "traits": { + "smithy.api#documentation": "

The type of model customization.

" + } + }, + "modelKmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The custom model is encrypted at rest using this key.

" + } + }, + "hyperParameters": { + "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", + "traits": { + "smithy.api#documentation": "

Hyperparameter values associated with this model. For details on the format for different models, see Custom model hyperparameters.

" + } + }, + "trainingDataConfig": { + "target": "com.amazonaws.bedrock#TrainingDataConfig", + "traits": { + "smithy.api#documentation": "

Contains information about the training dataset.

", + "smithy.api#required": {} + } + }, + "validationDataConfig": { + "target": "com.amazonaws.bedrock#ValidationDataConfig", + "traits": { + "smithy.api#documentation": "

Contains information about the validation dataset.

" + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

Output data configuration associated with this custom model.

", + "smithy.api#required": {} + } + }, + "trainingMetrics": { + "target": "com.amazonaws.bedrock#TrainingMetrics", + "traits": { + "smithy.api#documentation": "

Contains training metrics from the job creation.

" + } + }, + "validationMetrics": { + "target": "com.amazonaws.bedrock#ValidationMetrics", + "traits": { + "smithy.api#documentation": "

The validation metrics from the job creation.

" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Creation time of the model.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetEvaluationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetEvaluationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetEvaluationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the properties associated with a model evaluation job, including the\n status of the job. For more information, see Model evaluation.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/evaluation-jobs/{jobIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetEvaluationJobRequest": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationJobIdentifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model evaluation job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetEvaluationJobResponse": { + "type": "structure", + "members": { + "jobName": { + "target": "com.amazonaws.bedrock#EvaluationJobName", + "traits": { + "smithy.api#documentation": "

The name of the model evaluation job.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#EvaluationJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the model evaluation job.

", + "smithy.api#required": {} + } + }, + "jobArn": { + "target": "com.amazonaws.bedrock#EvaluationJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model evaluation job.

", + "smithy.api#required": {} + } + }, + "jobDescription": { + "target": "com.amazonaws.bedrock#EvaluationJobDescription", + "traits": { + "smithy.api#documentation": "

The description of the model evaluation job.

" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM service role used in the model evaluation job.

", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customer managed key specified when the model evaluation job was created.

" + } + }, + "jobType": { + "target": "com.amazonaws.bedrock#EvaluationJobType", + "traits": { + "smithy.api#documentation": "

The type of model evaluation job.

", + "smithy.api#required": {} + } + }, + "evaluationConfig": { + "target": "com.amazonaws.bedrock#EvaluationConfig", + "traits": { + "smithy.api#documentation": "

Contains details about the type of model evaluation job, the metrics used, the task type selected, the datasets used, and any custom metrics you defined.

", + "smithy.api#required": {} + } + }, + "inferenceConfig": { + "target": "com.amazonaws.bedrock#EvaluationInferenceConfig", + "traits": { + "smithy.api#documentation": "

Details about the models you specified in your model evaluation job.

", + "smithy.api#required": {} + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#EvaluationOutputDataConfig", + "traits": { + "smithy.api#documentation": "

Amazon S3 location for where output data is saved.

", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

When the model evaluation job was created.

", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

When the model evaluation job was last modified.

" + } + }, + "failureMessages": { + "target": "com.amazonaws.bedrock#ErrorMessages", + "traits": { + "smithy.api#documentation": "

An array of strings the specify why the model evaluation job has failed.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetFoundationModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetFoundationModelRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetFoundationModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get details about a Amazon Bedrock foundation model.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/foundation-models/{modelIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetFoundationModelRequest": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#ModelIdentifier", + "traits": { + "smithy.api#documentation": "

The model identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetFoundationModelResponse": { + "type": "structure", + "members": { + "modelDetails": { + "target": "com.amazonaws.bedrock#FoundationModelDetails", + "traits": { + "smithy.api#documentation": "

Information about the foundation model.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetGuardrail": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetGuardrailRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetGuardrailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets details about a guardrail. If you don't specify a version, the response returns details for the DRAFT version.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/guardrails/{guardrailIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetGuardrailRequest": { + "type": "structure", + "members": { + "guardrailIdentifier": { + "target": "com.amazonaws.bedrock#GuardrailIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the guardrail for which to get details. This can be an ID or the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "guardrailVersion": { + "target": "com.amazonaws.bedrock#GuardrailVersion", + "traits": { + "smithy.api#documentation": "

The version of the guardrail for which to get details. If you don't specify a version, the response returns details for the DRAFT version.

", + "smithy.api#httpQuery": "guardrailVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetGuardrailResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#GuardrailName", + "traits": { + "smithy.api#documentation": "

The name of the guardrail.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#GuardrailDescription", + "traits": { + "smithy.api#documentation": "

The description of the guardrail.

" + } + }, + "guardrailId": { + "target": "com.amazonaws.bedrock#GuardrailId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the guardrail.

", + "smithy.api#required": {} + } + }, + "guardrailArn": { + "target": "com.amazonaws.bedrock#GuardrailArn", + "traits": { + "smithy.api#documentation": "

The ARN of the guardrail.

", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrock#GuardrailVersion", + "traits": { + "smithy.api#documentation": "

The version of the guardrail.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#GuardrailStatus", + "traits": { + "smithy.api#documentation": "

The status of the guardrail.

", + "smithy.api#required": {} + } + }, + "topicPolicy": { + "target": "com.amazonaws.bedrock#GuardrailTopicPolicy", + "traits": { + "smithy.api#documentation": "

The topic policy that was configured for the guardrail.

" + } + }, + "contentPolicy": { + "target": "com.amazonaws.bedrock#GuardrailContentPolicy", + "traits": { + "smithy.api#documentation": "

The content policy that was configured for the guardrail.

" + } + }, + "wordPolicy": { + "target": "com.amazonaws.bedrock#GuardrailWordPolicy", + "traits": { + "smithy.api#documentation": "

The word policy that was configured for the guardrail.

" + } + }, + "sensitiveInformationPolicy": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicy", + "traits": { + "smithy.api#documentation": "

The sensitive information policy that was configured for the guardrail.

" + } + }, + "contextualGroundingPolicy": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingPolicy", + "traits": { + "smithy.api#documentation": "

The contextual grounding policy used in the guardrail.

" + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time at which the guardrail was created.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time at which the guardrail was updated.

", + "smithy.api#required": {} + } + }, + "statusReasons": { + "target": "com.amazonaws.bedrock#GuardrailStatusReasons", + "traits": { + "smithy.api#documentation": "

Appears if the status is FAILED. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.

" + } + }, + "failureRecommendations": { + "target": "com.amazonaws.bedrock#GuardrailFailureRecommendations", + "traits": { + "smithy.api#documentation": "

Appears if the status of the guardrail is FAILED. A list of recommendations to carry out before retrying the request.

" + } + }, + "blockedInputMessaging": { + "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", + "traits": { + "smithy.api#documentation": "

The message that the guardrail returns when it blocks a prompt.

", + "smithy.api#required": {} + } + }, + "blockedOutputsMessaging": { + "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", + "traits": { + "smithy.api#documentation": "

The message that the guardrail returns when it blocks a model response.

", + "smithy.api#required": {} + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key that encrypts the guardrail.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetImportedModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetImportedModelRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetImportedModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets properties associated with a customized model you imported.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/imported-models/{modelIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetImportedModelRequest": { + "type": "structure", + "members": { + "modelIdentifier": { + "target": "com.amazonaws.bedrock#ImportedModelIdentifier", + "traits": { + "smithy.api#documentation": "

Name or Amazon Resource Name (ARN) of the imported model.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetImportedModelResponse": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#ImportedModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with this imported model.

" + } + }, + "modelName": { + "target": "com.amazonaws.bedrock#ImportedModelName", + "traits": { + "smithy.api#documentation": "

The name of the imported model.

" + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "

Job name associated with the imported model.

" + } + }, + "jobArn": { + "target": "com.amazonaws.bedrock#ModelImportJobArn", + "traits": { + "smithy.api#documentation": "

Job Amazon Resource Name (ARN) associated with the imported model.

" + } + }, + "modelDataSource": { + "target": "com.amazonaws.bedrock#ModelDataSource", + "traits": { + "smithy.api#documentation": "

The data source for this imported model.

" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Creation time of the imported model.

" + } + }, + "modelArchitecture": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The architecture of the imported model.

" + } + }, + "modelKmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The imported model is encrypted at rest using this key.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetModelCopyJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetModelCopyJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetModelCopyJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about a model copy job. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-copy-jobs/{jobArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetModelCopyJobRequest": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCopyJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model copy job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetModelCopyJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCopyJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model copy job.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ModelCopyJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the model copy job.

", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the model copy job was created.

", + "smithy.api#required": {} + } + }, + "targetModelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the copied model.

", + "smithy.api#required": {} + } + }, + "targetModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "

The name of the copied model.

" + } + }, + "sourceAccountId": { + "target": "com.amazonaws.bedrock#AccountId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the account that the model being copied originated from.

", + "smithy.api#required": {} + } + }, + "sourceModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the original model being copied.

", + "smithy.api#required": {} + } + }, + "targetModelKmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key encrypting the copied model.

" + } + }, + "targetModelTags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "

The tags associated with the copied model.

" + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "

An error message for why the model copy job failed.

" + } + }, + "sourceModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "

The name of the original model being copied.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetModelCustomizationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetModelCustomizationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetModelCustomizationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the properties associated with a model-customization job, including the status of the job.\n For more information, see Custom models in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-customization-jobs/{jobIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetModelCustomizationJobRequest": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobIdentifier", + "traits": { + "smithy.api#documentation": "

Identifier for the customization job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetModelCustomizationJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customization job.

", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "

The name of the customization job.

", + "smithy.api#required": {} + } + }, + "outputModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "

The name of the output model.

", + "smithy.api#required": {} + } + }, + "outputModelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the output model.

" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

The token that you specified in the CreateCustomizationJob request.

" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use.\n If the job failed, the failure message contains information about why the job failed.

" + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Information about why the job failed.

" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Time that the resource was created.

", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Time that the resource was last modified.

" + } + }, + "endTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Time that the resource transitioned to terminal state.

" + } + }, + "baseModelArn": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the base model.

", + "smithy.api#required": {} + } + }, + "hyperParameters": { + "target": "com.amazonaws.bedrock#ModelCustomizationHyperParameters", + "traits": { + "smithy.api#documentation": "

The hyperparameter values for the job. For details on the format for different models, see Custom model hyperparameters.

", + "smithy.api#required": {} + } + }, + "trainingDataConfig": { + "target": "com.amazonaws.bedrock#TrainingDataConfig", + "traits": { + "smithy.api#documentation": "

Contains information about the training dataset.

", + "smithy.api#required": {} + } + }, + "validationDataConfig": { + "target": "com.amazonaws.bedrock#ValidationDataConfig", + "traits": { + "smithy.api#documentation": "

Contains information about the validation dataset.

", + "smithy.api#required": {} + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#OutputDataConfig", + "traits": { + "smithy.api#documentation": "

Output data configuration

", + "smithy.api#required": {} + } + }, + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", + "traits": { + "smithy.api#documentation": "

The type of model customization.

" + } + }, + "outputModelKmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The custom model is encrypted at rest using this key.

" + } + }, + "trainingMetrics": { + "target": "com.amazonaws.bedrock#TrainingMetrics", + "traits": { + "smithy.api#documentation": "

Contains training metrics from the job creation.

" + } + }, + "validationMetrics": { + "target": "com.amazonaws.bedrock#ValidationMetrics", + "traits": { + "smithy.api#documentation": "

The loss metric for each validator that you provided in the createjob request.

" + } + }, + "vpcConfig": { + "target": "com.amazonaws.bedrock#VpcConfig", + "traits": { + "smithy.api#documentation": "

VPC configuration for the custom model job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetModelImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetModelImportJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetModelImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the properties associated with import model job, including the status of the \n job. For more information, \n see Import a customized model in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-import-jobs/{jobIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetModelImportJobRequest": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#ModelImportJobIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the import job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetModelImportJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelImportJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the import job.

" + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "

The name of the import job.

" + } + }, + "importedModelName": { + "target": "com.amazonaws.bedrock#ImportedModelName", + "traits": { + "smithy.api#documentation": "

The name of the imported model.

" + } + }, + "importedModelArn": { + "target": "com.amazonaws.bedrock#ImportedModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the imported model.

" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role associated with this job.

" + } + }, + "modelDataSource": { + "target": "com.amazonaws.bedrock#ModelDataSource", + "traits": { + "smithy.api#documentation": "

The data source for the imported model.

" + } + }, + "status": { + "target": "com.amazonaws.bedrock#ModelImportJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the job. A successful job transitions from in-progress to completed when the imported model is ready to use.\n If the job failed, the failure message contains information about why the job failed.

" + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Information about why the import job failed.

" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the resource was created.

" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Time the resource was last modified.

" + } + }, + "endTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Time that the resource transitioned to terminal state.

" + } + }, + "vpcConfig": { + "target": "com.amazonaws.bedrock#VpcConfig", + "traits": { + "smithy.api#documentation": "

The Virtual Private Cloud (VPC) configuration of the import model job.

" + } + }, + "importedModelKmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The imported model is encrypted at rest using this key.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetModelInvocationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetModelInvocationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetModelInvocationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets details about a batch inference job. For more information, see View details about a batch inference job\n

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-invocation-job/{jobIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetModelInvocationJobRequest": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#ModelInvocationJobIdentifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetModelInvocationJobResponse": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelInvocationJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job.

", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#ModelInvocationJobName", + "traits": { + "smithy.api#documentation": "

The name of the batch inference job.

" + } + }, + "modelId": { + "target": "com.amazonaws.bedrock#ModelId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the foundation model used for model inference.

", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#ModelInvocationIdempotencyToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n\t Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ModelInvocationJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the batch inference job.

" + } + }, + "message": { + "target": "com.amazonaws.bedrock#Message", + "traits": { + "smithy.api#documentation": "

If the batch inference job failed, this field contains a message describing why the job failed.

" + } + }, + "submitTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the batch inference job was submitted.

", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the batch inference job was last modified.

" + } + }, + "endTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the batch inference job ended.

" + } + }, + "inputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobInputDataConfig", + "traits": { + "smithy.api#documentation": "

Details about the location of the input to the batch inference job.

", + "smithy.api#required": {} + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobOutputDataConfig", + "traits": { + "smithy.api#documentation": "

Details about the location of the output of the batch inference job.

", + "smithy.api#required": {} + } + }, + "timeoutDurationInHours": { + "target": "com.amazonaws.bedrock#ModelInvocationJobTimeoutDurationInHours", + "traits": { + "smithy.api#documentation": "

The number of hours after which batch inference job was set to time out.

" + } + }, + "jobExpirationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the batch inference job times or timed out.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetModelInvocationLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Get the current configuration values for model invocation logging.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/logging/modelinvocations" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetModelInvocationLoggingConfigurationResponse": { + "type": "structure", + "members": { + "loggingConfig": { + "target": "com.amazonaws.bedrock#LoggingConfig", + "traits": { + "smithy.api#documentation": "

The current configuration values.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GetProvisionedModelThroughput": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#GetProvisionedModelThroughputRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#GetProvisionedModelThroughputResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/provisioned-model-throughput/{provisionedModelId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#GetProvisionedModelThroughputRequest": { + "type": "structure", + "members": { + "provisionedModelId": { + "target": "com.amazonaws.bedrock#ProvisionedModelId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or name of the Provisioned Throughput.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#GetProvisionedModelThroughputResponse": { + "type": "structure", + "members": { + "modelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The number of model units allocated to this Provisioned Throughput.

", + "smithy.api#required": {} + } + }, + "desiredModelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The number of model units that was requested for this Provisioned Throughput.

", + "smithy.api#required": {} + } + }, + "provisionedModelName": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", + "traits": { + "smithy.api#documentation": "

The name of the Provisioned Throughput.

", + "smithy.api#required": {} + } + }, + "provisionedModelArn": { + "target": "com.amazonaws.bedrock#ProvisionedModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Provisioned Throughput.

", + "smithy.api#required": {} + } + }, + "modelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model associated with this Provisioned Throughput.

", + "smithy.api#required": {} + } + }, + "desiredModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value differs from the modelArn if updating hasn't completed.

", + "smithy.api#required": {} + } + }, + "foundationModelArn": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ProvisionedModelStatus", + "traits": { + "smithy.api#documentation": "

The status of the Provisioned Throughput.

", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the creation time for this Provisioned Throughput.

", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of the last time that this Provisioned Throughput was modified.

", + "smithy.api#required": {} + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "

A failure message for any issues that occurred during creation, updating, or deletion of the Provisioned Throughput.

" + } + }, + "commitmentDuration": { + "target": "com.amazonaws.bedrock#CommitmentDuration", + "traits": { + "smithy.api#documentation": "

Commitment duration of the Provisioned Throughput.

" + } + }, + "commitmentExpirationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp for when the commitment term for the Provisioned Throughput expires.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#GuardrailArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+$" + } + }, + "com.amazonaws.bedrock#GuardrailBlockedMessaging": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailContentFilter": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#GuardrailContentFilterType", + "traits": { + "smithy.api#documentation": "

The harmful category that the content filter is applied to.

", + "smithy.api#required": {} + } + }, + "inputStrength": { + "target": "com.amazonaws.bedrock#GuardrailFilterStrength", + "traits": { + "smithy.api#documentation": "

The strength of the content filter to apply to prompts. As you\n increase the filter strength, the likelihood of filtering harmful content increases\n and the probability of seeing harmful content in your application reduces.

", + "smithy.api#required": {} + } + }, + "outputStrength": { + "target": "com.amazonaws.bedrock#GuardrailFilterStrength", + "traits": { + "smithy.api#documentation": "

The strength of the content filter to apply to model responses. As you\n increase the filter strength, the likelihood of filtering harmful content increases\n and the probability of seeing harmful content in your application reduces.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.

\n \n

Content filtering depends on the confidence classification of user inputs and FM\n responses across each of the four harmful categories. All input and output statements are\n classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each\n harmful category. For example, if a statement is classified as\n Hate with HIGH confidence, the likelihood of the statement\n representing hateful content is high. A single statement can be classified across\n multiple categories with varying confidence levels. For example, a single statement\n can be classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual with NONE confidence, and Violence with MEDIUM confidence.

\n

For more information, see Guardrails content filters.

\n

This data type is used in the following API operations:

\n " + } + }, + "com.amazonaws.bedrock#GuardrailContentFilterConfig": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#GuardrailContentFilterType", + "traits": { + "smithy.api#documentation": "

The harmful category that the content filter is applied to.

", + "smithy.api#required": {} + } + }, + "inputStrength": { + "target": "com.amazonaws.bedrock#GuardrailFilterStrength", + "traits": { + "smithy.api#documentation": "

The strength of the content filter to apply to prompts. As you\n increase the filter strength, the likelihood of filtering harmful content increases\n and the probability of seeing harmful content in your application reduces.

", + "smithy.api#required": {} + } + }, + "outputStrength": { + "target": "com.amazonaws.bedrock#GuardrailFilterStrength", + "traits": { + "smithy.api#documentation": "

The strength of the content filter to apply to model responses. As you\n increase the filter strength, the likelihood of filtering harmful content increases\n and the probability of seeing harmful content in your application reduces.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.

\n \n

Content filtering depends on the confidence classification of user inputs and FM\n responses across each of the four harmful categories. All input and output statements are\n classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each\n harmful category. For example, if a statement is classified as\n Hate with HIGH confidence, the likelihood of the statement\n representing hateful content is high. A single statement can be classified across\n multiple categories with varying confidence levels. For example, a single statement\n can be classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual with NONE confidence, and Violence with MEDIUM confidence.

\n

For more information, see Guardrails content filters.

" + } + }, + "com.amazonaws.bedrock#GuardrailContentFilterType": { + "type": "enum", + "members": { + "SEXUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEXUAL" + } + }, + "VIOLENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIOLENCE" + } + }, + "HATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HATE" + } + }, + "INSULTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSULTS" + } + }, + "MISCONDUCT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISCONDUCT" + } + }, + "PROMPT_ATTACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROMPT_ATTACK" + } + } + } + }, + "com.amazonaws.bedrock#GuardrailContentFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailContentFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6 + } + } + }, + "com.amazonaws.bedrock#GuardrailContentFiltersConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailContentFilterConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6 + } + } + }, + "com.amazonaws.bedrock#GuardrailContentPolicy": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.bedrock#GuardrailContentFilters", + "traits": { + "smithy.api#documentation": "

Contains the type of the content filter and how strongly it should apply to prompts and model responses.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about how to handle harmful content.

\n

This data type is used in the following API operations:

\n " + } + }, + "com.amazonaws.bedrock#GuardrailContentPolicyConfig": { + "type": "structure", + "members": { + "filtersConfig": { + "target": "com.amazonaws.bedrock#GuardrailContentFiltersConfig", + "traits": { + "smithy.api#documentation": "

Contains the type of the content filter and how strongly it should apply to prompts and model responses.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about how to handle harmful content.

" + } + }, + "com.amazonaws.bedrock#GuardrailContextualGroundingFilter": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFilterType", + "traits": { + "smithy.api#documentation": "

The filter type details for the guardrails contextual grounding filter.

", + "smithy.api#required": {} + } + }, + "threshold": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The threshold details for the guardrails contextual grounding filter.

", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The details for the guardrails contextual grounding filter.

" + } + }, + "com.amazonaws.bedrock#GuardrailContextualGroundingFilterConfig": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFilterType", + "traits": { + "smithy.api#documentation": "

The filter details for the guardrails contextual grounding filter.

", + "smithy.api#required": {} + } + }, + "threshold": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The threshold details for the guardrails contextual grounding filter.

", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The filter configuration details for the guardrails contextual grounding filter.

" + } + }, + "com.amazonaws.bedrock#GuardrailContextualGroundingFilterType": { + "type": "enum", + "members": { + "GROUNDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GROUNDING" + } + }, + "RELEVANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RELEVANCE" + } + } + } + }, + "com.amazonaws.bedrock#GuardrailContextualGroundingFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrock#GuardrailContextualGroundingFiltersConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFilterConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrock#GuardrailContextualGroundingPolicy": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFilters", + "traits": { + "smithy.api#documentation": "

The filter details for the guardrails contextual grounding policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The details for the guardrails contextual grounding policy.

" + } + }, + "com.amazonaws.bedrock#GuardrailContextualGroundingPolicyConfig": { + "type": "structure", + "members": { + "filtersConfig": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingFiltersConfig", + "traits": { + "smithy.api#documentation": "

The filter configuration details for the guardrails contextual grounding policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The policy configuration details for the guardrails contextual grounding policy.

" + } + }, + "com.amazonaws.bedrock#GuardrailDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailDraftVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 5 + }, + "smithy.api#pattern": "^DRAFT$" + } + }, + "com.amazonaws.bedrock#GuardrailFailureRecommendation": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailFailureRecommendations": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailFailureRecommendation" + }, + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, + "com.amazonaws.bedrock#GuardrailFilterStrength": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + } + } + }, + "com.amazonaws.bedrock#GuardrailId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 64 + }, + "smithy.api#pattern": "^[a-z0-9]+$" + } + }, + "com.amazonaws.bedrock#GuardrailIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$" + } + }, + "com.amazonaws.bedrock#GuardrailManagedWordLists": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailManagedWords" + } + }, + "com.amazonaws.bedrock#GuardrailManagedWordListsConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailManagedWordsConfig" + } + }, + "com.amazonaws.bedrock#GuardrailManagedWords": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#GuardrailManagedWordsType", + "traits": { + "smithy.api#documentation": "

ManagedWords$type\n The managed word type that was configured for the guardrail.\n (For now, we only offer profanity word list)

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The managed word list that was configured for the guardrail.\n (This is a list of words that are pre-defined and managed by guardrails only.)

" + } + }, + "com.amazonaws.bedrock#GuardrailManagedWordsConfig": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#GuardrailManagedWordsType", + "traits": { + "smithy.api#documentation": "

The managed word type to configure for the guardrail.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The managed word list to configure for the guardrail.

" + } + }, + "com.amazonaws.bedrock#GuardrailManagedWordsType": { + "type": "enum", + "members": { + "PROFANITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROFANITY" + } + } + } + }, + "com.amazonaws.bedrock#GuardrailName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-_]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailNumericalVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[1-9][0-9]{0,7}$" + } + }, + "com.amazonaws.bedrock#GuardrailPiiEntities": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailPiiEntity" + }, + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.bedrock#GuardrailPiiEntitiesConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailPiiEntityConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.bedrock#GuardrailPiiEntity": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#GuardrailPiiEntityType", + "traits": { + "smithy.api#documentation": "

The type of PII entity. For exampvle, Social Security Number.

", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "

The configured guardrail action when PII entity is detected.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The PII entity configured for the guardrail.

" + } + }, + "com.amazonaws.bedrock#GuardrailPiiEntityConfig": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrock#GuardrailPiiEntityType", + "traits": { + "smithy.api#documentation": "

Configure guardrail type when the PII entity is detected.

\n

The following PIIs are used to block or mask sensitive information:

\n ", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "

Configure guardrail action when the PII entity is detected.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The PII entity to configure for the guardrail.

" + } + }, + "com.amazonaws.bedrock#GuardrailPiiEntityType": { + "type": "enum", + "members": { + "ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADDRESS" + } + }, + "AGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGE" + } + }, + "AWS_ACCESS_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_ACCESS_KEY" + } + }, + "AWS_SECRET_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_SECRET_KEY" + } + }, + "CA_HEALTH_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_HEALTH_NUMBER" + } + }, + "CA_SOCIAL_INSURANCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CA_SOCIAL_INSURANCE_NUMBER" + } + }, + "CREDIT_DEBIT_CARD_CVV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREDIT_DEBIT_CARD_CVV" + } + }, + "CREDIT_DEBIT_CARD_EXPIRY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREDIT_DEBIT_CARD_EXPIRY" + } + }, + "CREDIT_DEBIT_CARD_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREDIT_DEBIT_CARD_NUMBER" + } + }, + "DRIVER_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRIVER_ID" + } + }, + "EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMAIL" + } + }, + "INTERNATIONAL_BANK_ACCOUNT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNATIONAL_BANK_ACCOUNT_NUMBER" + } + }, + "IP_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_ADDRESS" + } + }, + "LICENSE_PLATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LICENSE_PLATE" + } + }, + "MAC_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAC_ADDRESS" + } + }, + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAME" + } + }, + "PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSWORD" + } + }, + "PHONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PHONE" + } + }, + "PIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PIN" + } + }, + "SWIFT_CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SWIFT_CODE" + } + }, + "UK_NATIONAL_HEALTH_SERVICE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_NATIONAL_HEALTH_SERVICE_NUMBER" + } + }, + "UK_NATIONAL_INSURANCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_NATIONAL_INSURANCE_NUMBER" + } + }, + "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" + } + }, + "URL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "URL" + } + }, + "USERNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USERNAME" + } + }, + "US_BANK_ACCOUNT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_BANK_ACCOUNT_NUMBER" + } + }, + "US_BANK_ROUTING_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_BANK_ROUTING_NUMBER" + } + }, + "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" + } + }, + "US_PASSPORT_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_PASSPORT_NUMBER" + } + }, + "US_SOCIAL_SECURITY_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_SOCIAL_SECURITY_NUMBER" + } + }, + "VEHICLE_IDENTIFICATION_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VEHICLE_IDENTIFICATION_NUMBER" + } + } + } + }, + "com.amazonaws.bedrock#GuardrailRegex": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the regular expression for the guardrail.

", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The description of the regular expression for the guardrail.

", + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "pattern": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The pattern of the regular expression configured for the guardrail.

", + "smithy.api#length": { + "min": 1, + "max": 500 + }, + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "

The action taken when a match to the regular expression is detected.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The regular expression configured for the guardrail.

" + } + }, + "com.amazonaws.bedrock#GuardrailRegexConfig": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the regular expression to configure for the guardrail.

", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The description of the regular expression to configure for the guardrail.

", + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "pattern": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The regular expression pattern to configure for the guardrail.

", + "smithy.api#length": { + "min": 1, + "max": 500 + }, + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationAction", + "traits": { + "smithy.api#documentation": "

The guardrail action to configure when matching regular expression is detected.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The regular expression to configure for the guardrail.

" + } + }, + "com.amazonaws.bedrock#GuardrailRegexes": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailRegex" + } + }, + "com.amazonaws.bedrock#GuardrailRegexesConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailRegexConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrock#GuardrailSensitiveInformationAction": { + "type": "enum", + "members": { + "BLOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BLOCK" + } + }, + "ANONYMIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANONYMIZE" + } + } + } + }, + "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicy": { + "type": "structure", + "members": { + "piiEntities": { + "target": "com.amazonaws.bedrock#GuardrailPiiEntities", + "traits": { + "smithy.api#documentation": "

The list of PII entities configured for the guardrail.

" + } + }, + "regexes": { + "target": "com.amazonaws.bedrock#GuardrailRegexes", + "traits": { + "smithy.api#documentation": "

The list of regular expressions configured for the guardrail.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about PII entities and regular expressions configured for the guardrail.

" + } + }, + "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicyConfig": { + "type": "structure", + "members": { + "piiEntitiesConfig": { + "target": "com.amazonaws.bedrock#GuardrailPiiEntitiesConfig", + "traits": { + "smithy.api#documentation": "

A list of PII entities to configure to the guardrail.

" + } + }, + "regexesConfig": { + "target": "com.amazonaws.bedrock#GuardrailRegexesConfig", + "traits": { + "smithy.api#documentation": "

A list of regular expressions to configure to the guardrail.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about PII entities and regular expressions to configure for the guardrail.

" + } + }, + "com.amazonaws.bedrock#GuardrailStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "VERSIONING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERSIONING" + } + }, + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } + } + }, + "com.amazonaws.bedrock#GuardrailStatusReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailStatusReasons": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailStatusReason" + }, + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, + "com.amazonaws.bedrock#GuardrailSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailSummary" + }, + "traits": { + "smithy.api#length": { + "max": 1000 + } + } + }, + "com.amazonaws.bedrock#GuardrailSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.bedrock#GuardrailId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the guardrail.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.bedrock#GuardrailArn", + "traits": { + "smithy.api#documentation": "

The ARN of the guardrail.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#GuardrailStatus", + "traits": { + "smithy.api#documentation": "

The status of the guardrail.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrock#GuardrailName", + "traits": { + "smithy.api#documentation": "

The name of the guardrail.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#GuardrailDescription", + "traits": { + "smithy.api#documentation": "

A description of the guardrail.

" + } + }, + "version": { + "target": "com.amazonaws.bedrock#GuardrailVersion", + "traits": { + "smithy.api#documentation": "

The version of the guardrail.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time at which the guardrail was created.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time at which the guardrail was last updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about a guardrail.

\n

This data type is used in the following API operations:

\n " + } + }, + "com.amazonaws.bedrock#GuardrailTopic": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#GuardrailTopicName", + "traits": { + "smithy.api#documentation": "

The name of the topic to deny.

", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.bedrock#GuardrailTopicDefinition", + "traits": { + "smithy.api#documentation": "

A definition of the topic to deny.

", + "smithy.api#required": {} + } + }, + "examples": { + "target": "com.amazonaws.bedrock#GuardrailTopicExamples", + "traits": { + "smithy.api#documentation": "

A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

" + } + }, + "type": { + "target": "com.amazonaws.bedrock#GuardrailTopicType", + "traits": { + "smithy.api#documentation": "

Specifies to deny the topic.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about topics for the guardrail to identify and deny.

\n

This data type is used in the following API operations:

\n " + } + }, + "com.amazonaws.bedrock#GuardrailTopicConfig": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#GuardrailTopicName", + "traits": { + "smithy.api#documentation": "

The name of the topic to deny.

", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.bedrock#GuardrailTopicDefinition", + "traits": { + "smithy.api#documentation": "

A definition of the topic to deny.

", + "smithy.api#required": {} + } + }, + "examples": { + "target": "com.amazonaws.bedrock#GuardrailTopicExamples", + "traits": { + "smithy.api#documentation": "

A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

" + } + }, + "type": { + "target": "com.amazonaws.bedrock#GuardrailTopicType", + "traits": { + "smithy.api#documentation": "

Specifies to deny the topic.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about topics for the guardrail to identify and deny.

" + } + }, + "com.amazonaws.bedrock#GuardrailTopicDefinition": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailTopicExample": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailTopicExamples": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailTopicExample" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.bedrock#GuardrailTopicName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-_ !?.]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#GuardrailTopicPolicy": { + "type": "structure", + "members": { + "topics": { + "target": "com.amazonaws.bedrock#GuardrailTopics", + "traits": { + "smithy.api#documentation": "

A list of policies related to topics that the guardrail should deny.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about topics that the guardrail should identify and deny.

\n

This data type is used in the following API operations:

\n " + } + }, + "com.amazonaws.bedrock#GuardrailTopicPolicyConfig": { + "type": "structure", + "members": { + "topicsConfig": { + "target": "com.amazonaws.bedrock#GuardrailTopicsConfig", + "traits": { + "smithy.api#documentation": "

A list of policies related to topics that the guardrail should deny.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about topics that the guardrail should identify and deny.

" + } + }, + "com.amazonaws.bedrock#GuardrailTopicType": { + "type": "enum", + "members": { + "DENY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DENY" + } + } + } + }, + "com.amazonaws.bedrock#GuardrailTopics": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailTopic" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.bedrock#GuardrailTopicsConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailTopicConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.bedrock#GuardrailVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(([1-9][0-9]{0,7})|(DRAFT))$" + } + }, + "com.amazonaws.bedrock#GuardrailWord": { + "type": "structure", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Text of the word configured for the guardrail to block.

", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A word configured for the guardrail.

" + } + }, + "com.amazonaws.bedrock#GuardrailWordConfig": { + "type": "structure", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Text of the word configured for the guardrail to block.

", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A word to configure for the guardrail.

" + } + }, + "com.amazonaws.bedrock#GuardrailWordPolicy": { + "type": "structure", + "members": { + "words": { + "target": "com.amazonaws.bedrock#GuardrailWords", + "traits": { + "smithy.api#documentation": "

A list of words configured for the guardrail.

" + } + }, + "managedWordLists": { + "target": "com.amazonaws.bedrock#GuardrailManagedWordLists", + "traits": { + "smithy.api#documentation": "

A list of managed words configured for the guardrail.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about the word policy configured for the guardrail.

" + } + }, + "com.amazonaws.bedrock#GuardrailWordPolicyConfig": { + "type": "structure", + "members": { + "wordsConfig": { + "target": "com.amazonaws.bedrock#GuardrailWordsConfig", + "traits": { + "smithy.api#documentation": "

A list of words to configure for the guardrail.

" + } + }, + "managedWordListsConfig": { + "target": "com.amazonaws.bedrock#GuardrailManagedWordListsConfig", + "traits": { + "smithy.api#documentation": "

A list of managed words to configure for the guardrail.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about the word policy to configured for the guardrail.

" + } + }, + "com.amazonaws.bedrock#GuardrailWords": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailWord" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.bedrock#GuardrailWordsConfig": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#GuardrailWordConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.bedrock#GuardrailsResource": { + "type": "resource", + "identifiers": { + "guardrailIdentifier": { + "target": "com.amazonaws.bedrock#GuardrailIdentifier" + } + }, + "create": { + "target": "com.amazonaws.bedrock#CreateGuardrail" + }, + "read": { + "target": "com.amazonaws.bedrock#GetGuardrail" + }, + "update": { + "target": "com.amazonaws.bedrock#UpdateGuardrail" + }, + "delete": { + "target": "com.amazonaws.bedrock#DeleteGuardrail" + }, + "list": { + "target": "com.amazonaws.bedrock#ListGuardrails" + }, + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateGuardrailVersion" + } + ], + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Guardrail" + } + } + }, + "com.amazonaws.bedrock#HumanEvaluationConfig": { + "type": "structure", + "members": { + "humanWorkflowConfig": { + "target": "com.amazonaws.bedrock#HumanWorkflowConfig", + "traits": { + "smithy.api#documentation": "

The parameters of the human workflow.

" + } + }, + "customMetrics": { + "target": "com.amazonaws.bedrock#HumanEvaluationCustomMetrics", + "traits": { + "smithy.api#documentation": "

A HumanEvaluationCustomMetric object. It contains the names the metrics, how the metrics are to be evaluated, an optional description.

" + } + }, + "datasetMetricConfigs": { + "target": "com.amazonaws.bedrock#EvaluationDatasetMetricConfigs", + "traits": { + "smithy.api#documentation": "

Use to specify the metrics, task, and prompt dataset to be used in your model evaluation job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the custom metrics, how tasks will be rated, the flow definition ARN, and your custom prompt datasets. Model evaluation jobs use human workers only support the use of custom prompt datasets. To learn more about custom prompt datasets and the required format, see Custom prompt datasets.

\n

When you create custom metrics in HumanEvaluationCustomMetric you must specify the metric's name. The list of names specified in the HumanEvaluationCustomMetric array, must match the metricNames array of strings specified in EvaluationDatasetMetricConfig. For example, if in the HumanEvaluationCustomMetric array your specified the names \"accuracy\", \"toxicity\", \"readability\" as custom metrics then the metricNames array would need to look like the following [\"accuracy\", \"toxicity\", \"readability\"] in EvaluationDatasetMetricConfig.

" + } + }, + "com.amazonaws.bedrock#HumanEvaluationCustomMetric": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrock#EvaluationMetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric. Your human evaluators will see this name in the evaluation UI.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#EvaluationMetricDescription", + "traits": { + "smithy.api#documentation": "

An optional description of the metric. Use this parameter to provide more details about the metric.

" + } + }, + "ratingMethod": { + "target": "com.amazonaws.bedrock#EvaluationRatingMethod", + "traits": { + "smithy.api#documentation": "

Choose how you want your human workers to evaluation your model. Valid values for rating methods are ThumbsUpDown, IndividualLikertScale,ComparisonLikertScale, ComparisonChoice, and ComparisonRank\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

In a model evaluation job that uses human workers you must \n define the name of the metric, and how you want that metric rated\n ratingMethod, and an optional description of the metric.

" + } + }, + "com.amazonaws.bedrock#HumanEvaluationCustomMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#HumanEvaluationCustomMetric" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrock#HumanTaskInstructions": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5000 + }, + "smithy.api#pattern": "^[\\S\\s]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#HumanWorkflowConfig": { + "type": "structure", + "members": { + "flowDefinitionArn": { + "target": "com.amazonaws.bedrock#SageMakerFlowDefinitionArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) for the flow definition

", + "smithy.api#required": {} + } + }, + "instructions": { + "target": "com.amazonaws.bedrock#HumanTaskInstructions", + "traits": { + "smithy.api#documentation": "

Instructions for the flow definition

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains SageMakerFlowDefinition object. The object is used to specify the prompt dataset, task type, rating method and metric names.

" + } + }, + "com.amazonaws.bedrock#IdempotencyToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + } + }, + "com.amazonaws.bedrock#ImportedModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:imported-model/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#ImportedModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:imported-model/[a-z0-9]{12})|(([0-9a-zA-Z][_-]?)+)$" + } + }, + "com.amazonaws.bedrock#ImportedModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?)+$" + } + }, + "com.amazonaws.bedrock#ImportedModelSummary": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.bedrock#ImportedModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the imported model.

", + "smithy.api#required": {} + } + }, + "modelName": { + "target": "com.amazonaws.bedrock#ImportedModelName", + "traits": { + "smithy.api#documentation": "

Name of the imported model.

", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Creation time of the imported model.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about tne imported model.

" + } + }, + "com.amazonaws.bedrock#ImportedModelSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ImportedModelSummary" + } + }, + "com.amazonaws.bedrock#InferenceType": { + "type": "enum", + "members": { + "ON_DEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON_DEMAND" + } + }, + "PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROVISIONED" + } + } + } + }, + "com.amazonaws.bedrock#InferenceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#InferenceType" + } + }, + "com.amazonaws.bedrock#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrock#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "

An internal server error occurred. Retry your request.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.bedrock#JobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9\\+\\-\\.])*$" + } + }, + "com.amazonaws.bedrock#KeyPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + } + } + }, + "com.amazonaws.bedrock#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" + } + }, + "com.amazonaws.bedrock#KmsKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)$" + } + }, + "com.amazonaws.bedrock#ListCustomModels": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListCustomModelsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListCustomModelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the custom models that you have created with the CreateModelCustomizationJob operation.

\n

For more information, see Custom models in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/custom-models" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "modelSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListCustomModelsRequest": { + "type": "structure", + "members": { + "creationTimeBefore": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Return custom models created before the specified time.

", + "smithy.api#httpQuery": "creationTimeBefore" + } + }, + "creationTimeAfter": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Return custom models created after the specified time.

", + "smithy.api#httpQuery": "creationTimeAfter" + } + }, + "nameContains": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "

Return custom models only if the job name contains these characters.

", + "smithy.api#httpQuery": "nameContains" + } + }, + "baseModelArnEquals": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "

Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.

", + "smithy.api#httpQuery": "baseModelArnEquals" + } + }, + "foundationModelArnEquals": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "

Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.

", + "smithy.api#httpQuery": "foundationModelArnEquals" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "sortBy": { + "target": "com.amazonaws.bedrock#SortModelsBy", + "traits": { + "smithy.api#documentation": "

The field to sort by in the returned list of models.

", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.bedrock#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order of the results.

", + "smithy.api#httpQuery": "sortOrder" + } + }, + "isOwned": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Return custom models depending on if the current account owns them (true) or if they were shared with the current account (false).

", + "smithy.api#httpQuery": "isOwned" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListCustomModelsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

" + } + }, + "modelSummaries": { + "target": "com.amazonaws.bedrock#CustomModelSummaryList", + "traits": { + "smithy.api#documentation": "

Model summaries.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListEvaluationJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListEvaluationJobsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListEvaluationJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists model evaluation jobs.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/evaluation-jobs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "jobSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListEvaluationJobsRequest": { + "type": "structure", + "members": { + "creationTimeAfter": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that includes model evaluation jobs created after the time specified.

", + "smithy.api#httpQuery": "creationTimeAfter" + } + }, + "creationTimeBefore": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that includes model evaluation jobs created prior to the time specified.

", + "smithy.api#httpQuery": "creationTimeBefore" + } + }, + "statusEquals": { + "target": "com.amazonaws.bedrock#EvaluationJobStatus", + "traits": { + "smithy.api#documentation": "

Only return jobs where the status condition is met.

", + "smithy.api#httpQuery": "statusEquals" + } + }, + "nameContains": { + "target": "com.amazonaws.bedrock#EvaluationJobName", + "traits": { + "smithy.api#documentation": "

Query parameter string for model evaluation job names.

", + "smithy.api#httpQuery": "nameContains" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

Continuation token from the previous response, for Amazon Bedrock to list the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "sortBy": { + "target": "com.amazonaws.bedrock#SortJobsBy", + "traits": { + "smithy.api#documentation": "

Allows you to sort model evaluation jobs by when they were created.

", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.bedrock#SortOrder", + "traits": { + "smithy.api#documentation": "

How you want the order of jobs sorted.

", + "smithy.api#httpQuery": "sortOrder" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListEvaluationJobsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

Continuation token from the previous response, for Amazon Bedrock to list the next set of results.

" + } + }, + "jobSummaries": { + "target": "com.amazonaws.bedrock#EvaluationSummaries", + "traits": { + "smithy.api#documentation": "

A summary of the model evaluation jobs.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListFoundationModels": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListFoundationModelsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListFoundationModelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters. For more information, see Foundation models in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/foundation-models" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListFoundationModelsRequest": { + "type": "structure", + "members": { + "byProvider": { + "target": "com.amazonaws.bedrock#Provider", + "traits": { + "smithy.api#documentation": "

Return models belonging to the model provider that you specify.

", + "smithy.api#httpQuery": "byProvider" + } + }, + "byCustomizationType": { + "target": "com.amazonaws.bedrock#ModelCustomization", + "traits": { + "smithy.api#documentation": "

Return models that support the customization type that you specify. For more information, see Custom models in the Amazon Bedrock User Guide.

", + "smithy.api#httpQuery": "byCustomizationType" + } + }, + "byOutputModality": { + "target": "com.amazonaws.bedrock#ModelModality", + "traits": { + "smithy.api#documentation": "

Return models that support the output modality that you specify.

", + "smithy.api#httpQuery": "byOutputModality" + } + }, + "byInferenceType": { + "target": "com.amazonaws.bedrock#InferenceType", + "traits": { + "smithy.api#documentation": "

Return models that support the inference type that you specify. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

", + "smithy.api#httpQuery": "byInferenceType" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListFoundationModelsResponse": { + "type": "structure", + "members": { + "modelSummaries": { + "target": "com.amazonaws.bedrock#FoundationModelSummaryList", + "traits": { + "smithy.api#documentation": "

A list of Amazon Bedrock foundation models.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListGuardrails": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListGuardrailsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListGuardrailsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists details about all the guardrails in an account. To list the DRAFT version of all your guardrails, don't specify the guardrailIdentifier field. To list all versions of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier field.

\n

You can set the maximum number of results to return in a response in the maxResults field. If there are more results than the number you set, the response returns a nextToken that you can send in another ListGuardrails request to see the next batch of results.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/guardrails" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "guardrails" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListGuardrailsRequest": { + "type": "structure", + "members": { + "guardrailIdentifier": { + "target": "com.amazonaws.bedrock#GuardrailIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the guardrail. This can be an ID or the ARN.

", + "smithy.api#httpQuery": "guardrailIdentifier" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

If there are more results than were returned in the response, the response returns a nextToken that you can send in another ListGuardrails request to see the next batch of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListGuardrailsResponse": { + "type": "structure", + "members": { + "guardrails": { + "target": "com.amazonaws.bedrock#GuardrailSummaries", + "traits": { + "smithy.api#documentation": "

A list of objects, each of which contains details about a guardrail.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

If there are more results than were returned in the response, the response returns a nextToken that you can send in another ListGuardrails request to see the next batch of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListImportedModels": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListImportedModelsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListImportedModelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of models you've imported. You can filter the results to return based on one or more criteria. \n For more information, \n see Import a customized model in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/imported-models" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "modelSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListImportedModelsRequest": { + "type": "structure", + "members": { + "creationTimeBefore": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Return imported models that created before the specified time.

", + "smithy.api#httpQuery": "creationTimeBefore" + } + }, + "creationTimeAfter": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Return imported models that were created after the specified time.

", + "smithy.api#httpQuery": "creationTimeAfter" + } + }, + "nameContains": { + "target": "com.amazonaws.bedrock#ImportedModelName", + "traits": { + "smithy.api#documentation": "

Return imported models only if the model name contains these characters.

", + "smithy.api#httpQuery": "nameContains" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "sortBy": { + "target": "com.amazonaws.bedrock#SortModelsBy", + "traits": { + "smithy.api#documentation": "

The field to sort by in the returned list of imported models.

", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.bedrock#SortOrder", + "traits": { + "smithy.api#documentation": "

Specifies whetehr to sort the results in ascending or descending order.

", + "smithy.api#httpQuery": "sortOrder" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListImportedModelsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

" + } + }, + "modelSummaries": { + "target": "com.amazonaws.bedrock#ImportedModelSummaryList", + "traits": { + "smithy.api#documentation": "

Model summaries.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListModelCopyJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListModelCopyJobsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListModelCopyJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of model copy jobs that you have submitted. You can filter the jobs to return based on\n one or more criteria. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-copy-jobs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "modelCopyJobSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListModelCopyJobsRequest": { + "type": "structure", + "members": { + "creationTimeAfter": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters for model copy jobs created after the specified time.

", + "smithy.api#httpQuery": "creationTimeAfter" + } + }, + "creationTimeBefore": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Filters for model copy jobs created before the specified time.

", + "smithy.api#httpQuery": "creationTimeBefore" + } + }, + "statusEquals": { + "target": "com.amazonaws.bedrock#ModelCopyJobStatus", + "traits": { + "smithy.api#documentation": "

Filters for model copy jobs whose status matches the value that you specify.

", + "smithy.api#httpQuery": "statusEquals" + } + }, + "sourceAccountEquals": { + "target": "com.amazonaws.bedrock#AccountId", + "traits": { + "smithy.api#documentation": "

Filters for model copy jobs in which the account that the source model belongs to is equal to the value that you specify.

", + "smithy.api#httpQuery": "sourceAccountEquals" + } + }, + "sourceModelArnEquals": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "

Filters for model copy jobs in which the Amazon Resource Name (ARN) of the source model to is equal to the value that you specify.

", + "smithy.api#httpQuery": "sourceModelArnEquals" + } + }, + "targetModelNameContains": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "

Filters for model copy jobs in which the name of the copied model contains the string that you specify.

", + "smithy.api#httpQuery": "outputModelNameContains" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "sortBy": { + "target": "com.amazonaws.bedrock#SortJobsBy", + "traits": { + "smithy.api#documentation": "

The field to sort by in the returned list of model copy jobs.

", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.bedrock#SortOrder", + "traits": { + "smithy.api#documentation": "

Specifies whether to sort the results in ascending or descending order.

", + "smithy.api#httpQuery": "sortOrder" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListModelCopyJobsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

" + } + }, + "modelCopyJobSummaries": { + "target": "com.amazonaws.bedrock#ModelCopyJobSummaries", + "traits": { + "smithy.api#documentation": "

A list of information about each model copy job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListModelCustomizationJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListModelCustomizationJobsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListModelCustomizationJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on\n one or more criteria.

\n

For more information, see Custom models in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-customization-jobs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "modelCustomizationJobSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListModelCustomizationJobsRequest": { + "type": "structure", + "members": { + "creationTimeAfter": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Return customization jobs created after the specified time.

", + "smithy.api#httpQuery": "creationTimeAfter" + } + }, + "creationTimeBefore": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Return customization jobs created before the specified time.

", + "smithy.api#httpQuery": "creationTimeBefore" + } + }, + "statusEquals": { + "target": "com.amazonaws.bedrock#FineTuningJobStatus", + "traits": { + "smithy.api#documentation": "

Return customization jobs with the specified status.

", + "smithy.api#httpQuery": "statusEquals" + } + }, + "nameContains": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "

Return customization jobs only if the job name contains these characters.

", + "smithy.api#httpQuery": "nameContains" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "sortBy": { + "target": "com.amazonaws.bedrock#SortJobsBy", + "traits": { + "smithy.api#documentation": "

The field to sort by in the returned list of jobs.

", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.bedrock#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order of the results.

", + "smithy.api#httpQuery": "sortOrder" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListModelCustomizationJobsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

" + } + }, + "modelCustomizationJobSummaries": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobSummaries", + "traits": { + "smithy.api#documentation": "

Job summaries.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListModelImportJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListModelImportJobsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListModelImportJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of import jobs you've submitted. You can filter the results to return based on one or more criteria. \n For more information, \n see Import a customized model in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-import-jobs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "modelImportJobSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListModelImportJobsRequest": { + "type": "structure", + "members": { + "creationTimeAfter": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Return import jobs that were created after the specified time.

", + "smithy.api#httpQuery": "creationTimeAfter" + } + }, + "creationTimeBefore": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Return import jobs that were created before the specified time.

", + "smithy.api#httpQuery": "creationTimeBefore" + } + }, + "statusEquals": { + "target": "com.amazonaws.bedrock#ModelImportJobStatus", + "traits": { + "smithy.api#documentation": "

Return imported jobs with the specified status.

", + "smithy.api#httpQuery": "statusEquals" + } + }, + "nameContains": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "

Return imported jobs only if the job name contains these characters.

", + "smithy.api#httpQuery": "nameContains" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "sortBy": { + "target": "com.amazonaws.bedrock#SortJobsBy", + "traits": { + "smithy.api#documentation": "

The field to sort by in the returned list of imported jobs.

", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.bedrock#SortOrder", + "traits": { + "smithy.api#documentation": "

Specifies whether to sort the results in ascending or descending order.

", + "smithy.api#httpQuery": "sortOrder" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListModelImportJobsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

" + } + }, + "modelImportJobSummaries": { + "target": "com.amazonaws.bedrock#ModelImportJobSummaries", + "traits": { + "smithy.api#documentation": "

Import job summaries.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListModelInvocationJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListModelInvocationJobsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListModelInvocationJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all batch inference jobs in the account. For more information, see View details about a batch inference job.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/model-invocation-jobs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "invocationJobSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListModelInvocationJobsRequest": { + "type": "structure", + "members": { + "submitTimeAfter": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Specify a time to filter for batch inference jobs that were submitted after the time you specify.

", + "smithy.api#httpQuery": "submitTimeAfter" + } + }, + "submitTimeBefore": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Specify a time to filter for batch inference jobs that were submitted before the time you specify.

", + "smithy.api#httpQuery": "submitTimeBefore" + } + }, + "statusEquals": { + "target": "com.amazonaws.bedrock#ModelInvocationJobStatus", + "traits": { + "smithy.api#documentation": "

Specify a status to filter for batch inference jobs whose statuses match the string you specify.

", + "smithy.api#httpQuery": "statusEquals" + } + }, + "nameContains": { + "target": "com.amazonaws.bedrock#ModelInvocationJobName", + "traits": { + "smithy.api#documentation": "

Specify a string to filter for batch inference jobs whose names contain the string.

", + "smithy.api#httpQuery": "nameContains" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return. If there are more results than the number that you specify, a nextToken value is returned. Use the nextToken in a request to return the next batch of results.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

If there were more results than the value you specified\n in the maxResults field in a previous ListModelInvocationJobs request, the response would have returned a nextToken\n value. To see the next batch of results, send the\n nextToken value in another\n request.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "sortBy": { + "target": "com.amazonaws.bedrock#SortJobsBy", + "traits": { + "smithy.api#documentation": "

An attribute by which to sort the results.

", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.bedrock#SortOrder", + "traits": { + "smithy.api#documentation": "

Specifies whether to sort the results by ascending or descending order.

", + "smithy.api#httpQuery": "sortOrder" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListModelInvocationJobsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

If there are more results than can fit in the response, a nextToken is returned. Use the nextToken in a request to return the next batch of results.

" + } + }, + "invocationJobSummaries": { + "target": "com.amazonaws.bedrock#ModelInvocationJobSummaries", + "traits": { + "smithy.api#documentation": "

A list of items, each of which contains a summary about a batch inference job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListProvisionedModelThroughputs": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListProvisionedModelThroughputsRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListProvisionedModelThroughputsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/provisioned-model-throughputs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "provisionedModelSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrock#ListProvisionedModelThroughputsRequest": { + "type": "structure", + "members": { + "creationTimeAfter": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns Provisioned Throughputs created after the specified time.

", + "smithy.api#httpQuery": "creationTimeAfter" + } + }, + "creationTimeBefore": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

A filter that returns Provisioned Throughputs created before the specified time.

", + "smithy.api#httpQuery": "creationTimeBefore" + } + }, + "statusEquals": { + "target": "com.amazonaws.bedrock#ProvisionedModelStatus", + "traits": { + "smithy.api#documentation": "

A filter that returns Provisioned Throughputs if their statuses matches the value that you specify.

", + "smithy.api#httpQuery": "statusEquals" + } + }, + "modelArnEquals": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "

A filter that returns Provisioned Throughputs whose model Amazon Resource Name (ARN) is equal to the value that you specify.

", + "smithy.api#httpQuery": "modelArnEquals" + } + }, + "nameContains": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", + "traits": { + "smithy.api#documentation": "

A filter that returns Provisioned Throughputs if their name contains the expression that you specify.

", + "smithy.api#httpQuery": "nameContains" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrock#MaxResults", + "traits": { + "smithy.api#documentation": "

THe maximum number of results to return in the response. If there are more results than the number you specified, the response returns a nextToken\n value. To see the next batch of results, send the nextToken value in another list request.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

If there are more results than the number you specified in the maxResults field, the response returns a nextToken\n value. To see the next batch of results, specify the nextToken value in this field.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "sortBy": { + "target": "com.amazonaws.bedrock#SortByProvisionedModels", + "traits": { + "smithy.api#documentation": "

The field by which to sort the returned list of Provisioned Throughputs.

", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.bedrock#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order of the results.

", + "smithy.api#httpQuery": "sortOrder" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListProvisionedModelThroughputsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrock#PaginationToken", + "traits": { + "smithy.api#documentation": "

If there are more results than the number you specified in the maxResults field, this value is returned. To see the next batch of results, include this value in the nextToken field in another list request.

" + } + }, + "provisionedModelSummaries": { + "target": "com.amazonaws.bedrock#ProvisionedModelSummaries", + "traits": { + "smithy.api#documentation": "

A list of summaries, one for each Provisioned Throughput in the response.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List the tags associated with the specified resource.

\n

For more information, see Tagging resources in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/listTagsForResource" + } + } + }, + "com.amazonaws.bedrock#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceARN": { + "target": "com.amazonaws.bedrock#TaggableResourcesArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "

An array of the tags associated with this resource.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#LogGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.bedrock#LoggingConfig": { + "type": "structure", + "members": { + "cloudWatchConfig": { + "target": "com.amazonaws.bedrock#CloudWatchConfig", + "traits": { + "smithy.api#documentation": "

CloudWatch logging configuration.

" + } + }, + "s3Config": { + "target": "com.amazonaws.bedrock#S3Config", + "traits": { + "smithy.api#documentation": "

S3 configuration for storing log data.

" + } + }, + "textDataDeliveryEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Set to include text data in the log delivery.

" + } + }, + "imageDataDeliveryEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Set to include image data in the log delivery.

" + } + }, + "embeddingDataDeliveryEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Set to include embeddings data in the log delivery.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration fields for invocation logging.

" + } + }, + "com.amazonaws.bedrock#LoggingResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#DeleteModelInvocationLoggingConfiguration" + }, + { + "target": "com.amazonaws.bedrock#GetModelInvocationLoggingConfiguration" + }, + { + "target": "com.amazonaws.bedrock#PutModelInvocationLoggingConfiguration" + } + ] + }, + "com.amazonaws.bedrock#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.bedrock#Message": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrock#MetricFloat": { + "type": "float" + }, + "com.amazonaws.bedrock#ModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))$" + } + }, + "com.amazonaws.bedrock#ModelCopyJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-copy-job/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#ModelCopyJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.bedrock#ModelCopyJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ModelCopyJobSummary" + } + }, + "com.amazonaws.bedrock#ModelCopyJobSummary": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCopyJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resoource Name (ARN) of the model copy job.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ModelCopyJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the model copy job.

", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the model copy job was created.

", + "smithy.api#required": {} + } + }, + "targetModelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the copied model.

", + "smithy.api#required": {} + } + }, + "targetModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "

The name of the copied model.

" + } + }, + "sourceAccountId": { + "target": "com.amazonaws.bedrock#AccountId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the account that the model being copied originated from.

", + "smithy.api#required": {} + } + }, + "sourceModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the original model being copied.

", + "smithy.api#required": {} + } + }, + "targetModelKmsKeyArn": { + "target": "com.amazonaws.bedrock#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the copied model.

" + } + }, + "targetModelTags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "

Tags associated with the copied model.

" + } + }, + "failureMessage": { + "target": "com.amazonaws.bedrock#ErrorMessage", + "traits": { + "smithy.api#documentation": "

If a model fails to be copied, a message describing why the job failed is included here.

" + } + }, + "sourceModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "

The name of the original model being copied.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about each model copy job.

\n

This data type is used in the following API operations:

\n " + } + }, + "com.amazonaws.bedrock#ModelCopyResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateModelCopyJob" + }, + { + "target": "com.amazonaws.bedrock#GetModelCopyJob" + }, + { + "target": "com.amazonaws.bedrock#ListModelCopyJobs" + } + ] + }, + "com.amazonaws.bedrock#ModelCustomization": { + "type": "enum", + "members": { + "FINE_TUNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FINE_TUNING" + } + }, + "CONTINUED_PRE_TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTINUED_PRE_TRAINING" + } + } + } + }, + "com.amazonaws.bedrock#ModelCustomizationHyperParameters": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.bedrock#ModelCustomizationJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-customization-job/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#ModelCustomizationJobIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-customization-job/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9\\+\\-\\.])*)$" + } + }, + "com.amazonaws.bedrock#ModelCustomizationJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "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" + } + } + } + }, + "com.amazonaws.bedrock#ModelCustomizationJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobSummary" + } + }, + "com.amazonaws.bedrock#ModelCustomizationJobSummary": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobArn", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the customization job.

", + "smithy.api#required": {} + } + }, + "baseModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the base model.

", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "

Name of the customization job.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobStatus", + "traits": { + "smithy.api#documentation": "

Status of the customization job.

", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Time that the customization job was last modified.

" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Creation time of the custom model.

", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

Time that the customization job ended.

" + } + }, + "customModelArn": { + "target": "com.amazonaws.bedrock#CustomModelArn", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the custom model.

" + } + }, + "customModelName": { + "target": "com.amazonaws.bedrock#CustomModelName", + "traits": { + "smithy.api#documentation": "

Name of the custom model.

" + } + }, + "customizationType": { + "target": "com.amazonaws.bedrock#CustomizationType", + "traits": { + "smithy.api#documentation": "

Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about one customization job

" + } + }, + "com.amazonaws.bedrock#ModelCustomizationList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ModelCustomization" + } + }, + "com.amazonaws.bedrock#ModelDataSource": { + "type": "union", + "members": { + "s3DataSource": { + "target": "com.amazonaws.bedrock#S3DataSource", + "traits": { + "smithy.api#documentation": "

The Amazon S3 data source of the imported model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data source for the imported model.

" + } + }, + "com.amazonaws.bedrock#ModelId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-:]{1,63}/[a-z0-9]{12}$)|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}$)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$" + } + }, + "com.amazonaws.bedrock#ModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$" + } + }, + "com.amazonaws.bedrock#ModelImportJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-import-job/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#ModelImportJobIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-import-job/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9\\+\\-\\.])*)$" + } + }, + "com.amazonaws.bedrock#ModelImportJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.bedrock#ModelImportJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ModelImportJobSummary" + } + }, + "com.amazonaws.bedrock#ModelImportJobSummary": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelImportJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the import job.

", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#JobName", + "traits": { + "smithy.api#documentation": "

The name of the import job.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ModelImportJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the imported job.

", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the import job was last modified.

" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time import job was created.

", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when import job ended.

" + } + }, + "importedModelArn": { + "target": "com.amazonaws.bedrock#ImportedModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon resource Name (ARN) of the imported model.

" + } + }, + "importedModelName": { + "target": "com.amazonaws.bedrock#ImportedModelName", + "traits": { + "smithy.api#documentation": "

The name of the imported model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the import job.

" + } + }, + "com.amazonaws.bedrock#ModelImportResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateModelImportJob" + }, + { + "target": "com.amazonaws.bedrock#DeleteImportedModel" + }, + { + "target": "com.amazonaws.bedrock#GetImportedModel" + }, + { + "target": "com.amazonaws.bedrock#GetModelImportJob" + }, + { + "target": "com.amazonaws.bedrock#ListImportedModels" + }, + { + "target": "com.amazonaws.bedrock#ListModelImportJobs" + } + ] + }, + "com.amazonaws.bedrock#ModelInvocationIdempotencyToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]{1,256}(-*[a-zA-Z0-9]){0,256}$" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-invocation-job/[a-z0-9]{12})$" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1011 + }, + "smithy.api#pattern": "^((arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-invocation-job/)?[a-z0-9]{12})$" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobInputDataConfig": { + "type": "union", + "members": { + "s3InputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobS3InputDataConfig", + "traits": { + "smithy.api#documentation": "

Contains the configuration of the S3 location of the input data.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the location of the input to the batch inference job.

" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]{1,63}(-*[a-zA-Z0-9\\+\\-\\.]){0,63}$" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobOutputDataConfig": { + "type": "union", + "members": { + "s3OutputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobS3OutputDataConfig", + "traits": { + "smithy.api#documentation": "

Contains the configuration of the S3 location of the output data.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the configuration of the S3 location of the output data.

" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateModelInvocationJob" + }, + { + "target": "com.amazonaws.bedrock#GetModelInvocationJob" + }, + { + "target": "com.amazonaws.bedrock#ListModelInvocationJobs" + }, + { + "target": "com.amazonaws.bedrock#StopModelInvocationJob" + } + ] + }, + "com.amazonaws.bedrock#ModelInvocationJobS3InputDataConfig": { + "type": "structure", + "members": { + "s3InputFormat": { + "target": "com.amazonaws.bedrock#S3InputFormat", + "traits": { + "smithy.api#documentation": "

The format of the input data.

" + } + }, + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", + "traits": { + "smithy.api#documentation": "

The S3 location of the input data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the configuration of the S3 location of the output data.

" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobS3OutputDataConfig": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", + "traits": { + "smithy.api#documentation": "

The S3 location of the output data.

", + "smithy.api#required": {} + } + }, + "s3EncryptionKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the key that encrypts the S3 location of the output data.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the configuration of the S3 location of the output data.

" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobStatus": { + "type": "enum", + "members": { + "SUBMITTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Submitted" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "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" + } + }, + "PARTIALLY_COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PartiallyCompleted" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Expired" + } + }, + "VALIDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Validating" + } + }, + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Scheduled" + } + } + } + }, + "com.amazonaws.bedrock#ModelInvocationJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ModelInvocationJobSummary" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobSummary": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.bedrock#ModelInvocationJobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job.

", + "smithy.api#required": {} + } + }, + "jobName": { + "target": "com.amazonaws.bedrock#ModelInvocationJobName", + "traits": { + "smithy.api#documentation": "

The name of the batch inference job.

", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.bedrock#ModelId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the foundation model used for model inference.

", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.bedrock#ModelInvocationIdempotencyToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n\t Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

" + } + }, + "roleArn": { + "target": "com.amazonaws.bedrock#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ModelInvocationJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the batch inference job.

" + } + }, + "message": { + "target": "com.amazonaws.bedrock#Message", + "traits": { + "smithy.api#documentation": "

If the batch inference job failed, this field contains a message describing why the job failed.

" + } + }, + "submitTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the batch inference job was submitted.

", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the batch inference job was last modified.

" + } + }, + "endTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the batch inference job ended.

" + } + }, + "inputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobInputDataConfig", + "traits": { + "smithy.api#documentation": "

Details about the location of the input to the batch inference job.

", + "smithy.api#required": {} + } + }, + "outputDataConfig": { + "target": "com.amazonaws.bedrock#ModelInvocationJobOutputDataConfig", + "traits": { + "smithy.api#documentation": "

Details about the location of the output of the batch inference job.

", + "smithy.api#required": {} + } + }, + "timeoutDurationInHours": { + "target": "com.amazonaws.bedrock#ModelInvocationJobTimeoutDurationInHours", + "traits": { + "smithy.api#documentation": "

The number of hours after which the batch inference job was set to time out.

" + } + }, + "jobExpirationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the batch inference job times or timed out.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of a batch inference job.

" + } + }, + "com.amazonaws.bedrock#ModelInvocationJobTimeoutDurationInHours": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 24, + "max": 168 + } + } + }, + "com.amazonaws.bedrock#ModelModality": { + "type": "enum", + "members": { + "TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT" + } + }, + "IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE" + } + }, + "EMBEDDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMBEDDING" + } + } + } + }, + "com.amazonaws.bedrock#ModelModalityList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ModelModality" + } + }, + "com.amazonaws.bedrock#ModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63})$" + } + }, + "com.amazonaws.bedrock#ModelResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#DeleteCustomModel" + }, + { + "target": "com.amazonaws.bedrock#GetCustomModel" + }, + { + "target": "com.amazonaws.bedrock#GetFoundationModel" + }, + { + "target": "com.amazonaws.bedrock#ListCustomModels" + }, + { + "target": "com.amazonaws.bedrock#ListFoundationModels" + } + ] + }, + "com.amazonaws.bedrock#NonBlankString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.bedrock#OutputDataConfig": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", + "traits": { + "smithy.api#documentation": "

The S3 URI where the output data is stored.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

S3 Location of the output data.

" + } + }, + "com.amazonaws.bedrock#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\S*$" + } + }, + "com.amazonaws.bedrock#PositiveInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.bedrock#Provider": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Za-z0-9- ]{1,63}$" + } + }, + "com.amazonaws.bedrock#ProvisionedModelArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}$" + } + }, + "com.amazonaws.bedrock#ProvisionedModelId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^((([0-9a-zA-Z][_-]?)+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}))$" + } + }, + "com.amazonaws.bedrock#ProvisionedModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?)+$" + } + }, + "com.amazonaws.bedrock#ProvisionedModelStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "IN_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InService" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.bedrock#ProvisionedModelSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ProvisionedModelSummary" + } + }, + "com.amazonaws.bedrock#ProvisionedModelSummary": { + "type": "structure", + "members": { + "provisionedModelName": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", + "traits": { + "smithy.api#documentation": "

The name of the Provisioned Throughput.

", + "smithy.api#required": {} + } + }, + "provisionedModelArn": { + "target": "com.amazonaws.bedrock#ProvisionedModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Provisioned Throughput.

", + "smithy.api#required": {} + } + }, + "modelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model associated with the Provisioned Throughput.

", + "smithy.api#required": {} + } + }, + "desiredModelArn": { + "target": "com.amazonaws.bedrock#ModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value differs from the modelArn if updating hasn't completed.

", + "smithy.api#required": {} + } + }, + "foundationModelArn": { + "target": "com.amazonaws.bedrock#FoundationModelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized.

", + "smithy.api#required": {} + } + }, + "modelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The number of model units allocated to the Provisioned Throughput.

", + "smithy.api#required": {} + } + }, + "desiredModelUnits": { + "target": "com.amazonaws.bedrock#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The number of model units that was requested to be allocated to the Provisioned Throughput.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrock#ProvisionedModelStatus", + "traits": { + "smithy.api#documentation": "

The status of the Provisioned Throughput.

", + "smithy.api#required": {} + } + }, + "commitmentDuration": { + "target": "com.amazonaws.bedrock#CommitmentDuration", + "traits": { + "smithy.api#documentation": "

The duration for which the Provisioned Throughput was committed.

" + } + }, + "commitmentExpirationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp for when the commitment term of the Provisioned Throughput expires.

" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the Provisioned Throughput was created.

", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the Provisioned Throughput was last modified.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of information about a Provisioned Throughput.

\n

This data type is used in the following API operations:

\n " + } + }, + "com.amazonaws.bedrock#ProvisionedModelThroughputResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateProvisionedModelThroughput" + }, + { + "target": "com.amazonaws.bedrock#DeleteProvisionedModelThroughput" + }, + { + "target": "com.amazonaws.bedrock#GetProvisionedModelThroughput" + }, + { + "target": "com.amazonaws.bedrock#ListProvisionedModelThroughputs" + }, + { + "target": "com.amazonaws.bedrock#UpdateProvisionedModelThroughput" + } + ] + }, + "com.amazonaws.bedrock#PutModelInvocationLoggingConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#PutModelInvocationLoggingConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#PutModelInvocationLoggingConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Set the configuration values for model invocation logging.

", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/logging/modelinvocations" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#PutModelInvocationLoggingConfigurationRequest": { + "type": "structure", + "members": { + "loggingConfig": { + "target": "com.amazonaws.bedrock#LoggingConfig", + "traits": { + "smithy.api#documentation": "

The logging configuration values to set.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#PutModelInvocationLoggingConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrock#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.bedrock#RoleArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "ARN of a IAM role", + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$" + } + }, + "com.amazonaws.bedrock#S3Config": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.bedrock#BucketName", + "traits": { + "smithy.api#documentation": "

S3 bucket name.

", + "smithy.api#required": {} + } + }, + "keyPrefix": { + "target": "com.amazonaws.bedrock#KeyPrefix", + "traits": { + "smithy.api#documentation": "

S3 prefix.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

S3 configuration for storing log data.

" + } + }, + "com.amazonaws.bedrock#S3DataSource": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", + "traits": { + "smithy.api#documentation": "

The URI of the Amazon S3 data source.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon S3 data source of the imported job.

" + } + }, + "com.amazonaws.bedrock#S3InputFormat": { + "type": "enum", + "members": { + "JSONL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSONL" + } + } + } + }, + "com.amazonaws.bedrock#S3Uri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^s3://[a-z0-9][-.a-z0-9]{1,61}(?:/[-!_*'().a-z0-9A-Z]+(?:/[-!_*'().a-z0-9A-Z]+)*)?/?$" + } + }, + "com.amazonaws.bedrock#SageMakerFlowDefinitionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:sagemaker:[a-z0-9-]{1,20}:[0-9]{12}:flow-definition/.*$" + } + }, + "com.amazonaws.bedrock#SecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrock#SecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#SecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrock#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrock#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "

The number of requests exceeds the service quota. Resubmit your request later.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrock#SortByProvisionedModels": { + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.bedrock#SortJobsBy": { + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.bedrock#SortModelsBy": { + "type": "enum", + "members": { + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + } + } + }, + "com.amazonaws.bedrock#SortOrder": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.bedrock#StopEvaluationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#StopEvaluationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#StopEvaluationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops an in progress model evaluation job.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/evaluation-job/{jobIdentifier}/stop" + } + } + }, + "com.amazonaws.bedrock#StopEvaluationJobRequest": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#EvaluationJobIdentifier", + "traits": { + "smithy.api#documentation": "

The ARN of the model evaluation job you want to stop.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#StopEvaluationJobResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#StopModelCustomizationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#StopModelCustomizationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#StopModelCustomizationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/model-customization-jobs/{jobIdentifier}/stop" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#StopModelCustomizationJobRequest": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#ModelCustomizationJobIdentifier", + "traits": { + "smithy.api#documentation": "

Job identifier of the job to stop.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#StopModelCustomizationJobResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#StopModelInvocationJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#StopModelInvocationJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#StopModelInvocationJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a batch inference job. You're only charged for tokens that were already processed. For more information, see Stop a batch inference job.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/model-invocation-job/{jobIdentifier}/stop" + } + } + }, + "com.amazonaws.bedrock#StopModelInvocationJobRequest": { + "type": "structure", + "members": { + "jobIdentifier": { + "target": "com.amazonaws.bedrock#ModelInvocationJobIdentifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job to stop.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#StopModelInvocationJobResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#SubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.bedrock#SubnetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#SubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.bedrock#SubscriptionResource": { + "type": "resource" + }, + "com.amazonaws.bedrock#Tag": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.bedrock#TagKey", + "traits": { + "smithy.api#documentation": "

Key for the tag.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.bedrock#TagValue", + "traits": { + "smithy.api#documentation": "

Value for the tag.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Definition of the key/value pair for a tag.

" + } + }, + "com.amazonaws.bedrock#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrock#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.bedrock#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.bedrock#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#TooManyTagsException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/tagResource" + } + } + }, + "com.amazonaws.bedrock#TagResourceRequest": { + "type": "structure", + "members": { + "resourceARN": { + "target": "com.amazonaws.bedrock#TaggableResourcesArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to tag.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.bedrock#TagList", + "traits": { + "smithy.api#documentation": "

Tags to associate with the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" + } + }, + "com.amazonaws.bedrock#TaggableResourcesArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 1011 + }, + "smithy.api#pattern": "(^[a-zA-Z0-9][a-zA-Z0-9\\-]*$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:([0-9]{12}|)((:(fine-tuning-job|model-customization-job|custom-model)/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12})$)|(:guardrail/[a-z0-9]+$)|(:(provisioned-model|model-invocation-job|model-evaluation-job|evaluation-job|model-import-job|imported-model)/[a-z0-9]{12}$)))" + } + }, + "com.amazonaws.bedrock#TaggingResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#ListTagsForResource" + }, + { + "target": "com.amazonaws.bedrock#TagResource" + }, + { + "target": "com.amazonaws.bedrock#UntagResource" + } + ] + }, + "com.amazonaws.bedrock#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrock#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "

The number of requests exceeds the limit. Resubmit your request later.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.bedrock#Timestamp": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.bedrock#TooManyTagsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrock#NonBlankString" + }, + "resourceName": { + "target": "com.amazonaws.bedrock#TaggableResourcesArn", + "traits": { + "smithy.api#documentation": "

The name of the resource with too many tags.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request contains more tags than can be associated with a resource (50 tags per resource). \n The maximum number of tags includes both existing tags and those included in your current request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrock#TrainingDataConfig": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", + "traits": { + "smithy.api#documentation": "

The S3 URI where the training data is stored.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

S3 Location of the training data.

" + } + }, + "com.amazonaws.bedrock#TrainingMetrics": { + "type": "structure", + "members": { + "trainingLoss": { + "target": "com.amazonaws.bedrock#MetricFloat", + "traits": { + "smithy.api#documentation": "

Loss metric associated with the custom job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metrics associated with the custom job.

" + } + }, + "com.amazonaws.bedrock#TrainingResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrock#CreateModelCustomizationJob" + }, + { + "target": "com.amazonaws.bedrock#GetModelCustomizationJob" + }, + { + "target": "com.amazonaws.bedrock#ListModelCustomizationJobs" + }, + { + "target": "com.amazonaws.bedrock#StopModelCustomizationJob" + } + ] + }, + "com.amazonaws.bedrock#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Remove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/untagResource" + } + } + }, + "com.amazonaws.bedrock#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceARN": { + "target": "com.amazonaws.bedrock#TaggableResourcesArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to untag.

", + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.bedrock#TagKeyList", + "traits": { + "smithy.api#documentation": "

Tag keys of the tags to remove from the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#UpdateGuardrail": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#UpdateGuardrailRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#UpdateGuardrailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#ConflictException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a guardrail with the values you specify.

\n ", + "smithy.api#http": { + "code": 202, + "method": "PUT", + "uri": "/guardrails/{guardrailIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#UpdateGuardrailRequest": { + "type": "structure", + "members": { + "guardrailIdentifier": { + "target": "com.amazonaws.bedrock#GuardrailIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the guardrail. This can be an ID or the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrock#GuardrailName", + "traits": { + "smithy.api#documentation": "

A name for the guardrail.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrock#GuardrailDescription", + "traits": { + "smithy.api#documentation": "

A description of the guardrail.

" + } + }, + "topicPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailTopicPolicyConfig", + "traits": { + "smithy.api#documentation": "

The topic policy to configure for the guardrail.

" + } + }, + "contentPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailContentPolicyConfig", + "traits": { + "smithy.api#documentation": "

The content policy to configure for the guardrail.

" + } + }, + "wordPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailWordPolicyConfig", + "traits": { + "smithy.api#documentation": "

The word policy to configure for the guardrail.

" + } + }, + "sensitiveInformationPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailSensitiveInformationPolicyConfig", + "traits": { + "smithy.api#documentation": "

The sensitive information policy to configure for the guardrail.

" + } + }, + "contextualGroundingPolicyConfig": { + "target": "com.amazonaws.bedrock#GuardrailContextualGroundingPolicyConfig", + "traits": { + "smithy.api#documentation": "

The contextual grounding policy configuration used to update a guardrail.

" + } + }, + "blockedInputMessaging": { + "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", + "traits": { + "smithy.api#documentation": "

The message to return when the guardrail blocks a prompt.

", + "smithy.api#required": {} + } + }, + "blockedOutputsMessaging": { + "target": "com.amazonaws.bedrock#GuardrailBlockedMessaging", + "traits": { + "smithy.api#documentation": "

The message to return when the guardrail blocks a model response.

", + "smithy.api#required": {} + } + }, + "kmsKeyId": { + "target": "com.amazonaws.bedrock#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key with which to encrypt the guardrail.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#UpdateGuardrailResponse": { + "type": "structure", + "members": { + "guardrailId": { + "target": "com.amazonaws.bedrock#GuardrailId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the guardrail

", + "smithy.api#required": {} + } + }, + "guardrailArn": { + "target": "com.amazonaws.bedrock#GuardrailArn", + "traits": { + "smithy.api#documentation": "

The ARN of the guardrail.

", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.bedrock#GuardrailDraftVersion", + "traits": { + "smithy.api#documentation": "

The version of the guardrail.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time at which the guardrail was updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#UpdateProvisionedModelThroughput": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrock#UpdateProvisionedModelThroughputRequest" + }, + "output": { + "target": "com.amazonaws.bedrock#UpdateProvisionedModelThroughputResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrock#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrock#InternalServerException" + }, + { + "target": "com.amazonaws.bedrock#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrock#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrock#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/provisioned-model-throughput/{provisionedModelId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bedrock#UpdateProvisionedModelThroughputRequest": { + "type": "structure", + "members": { + "provisionedModelId": { + "target": "com.amazonaws.bedrock#ProvisionedModelId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or name of the Provisioned Throughput to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "desiredProvisionedModelName": { + "target": "com.amazonaws.bedrock#ProvisionedModelName", + "traits": { + "smithy.api#documentation": "

The new name for this Provisioned Throughput.

" + } + }, + "desiredModelId": { + "target": "com.amazonaws.bedrock#ModelIdentifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the new model to associate with this Provisioned Throughput. You can't specify this field if this Provisioned Throughput is associated with a base model.

\n

If this Provisioned Throughput is associated with a custom model, you can specify one of the following options:

\n " + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrock#UpdateProvisionedModelThroughputResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrock#ValidationDataConfig": { + "type": "structure", + "members": { + "validators": { + "target": "com.amazonaws.bedrock#Validators", + "traits": { + "smithy.api#documentation": "

Information about the validators.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Array of up to 10 validators.

" + } + }, + "com.amazonaws.bedrock#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrock#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "

Input validation failed. Check your request parameters and retry the request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bedrock#ValidationMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#ValidatorMetric" + } + }, + "com.amazonaws.bedrock#Validator": { + "type": "structure", + "members": { + "s3Uri": { + "target": "com.amazonaws.bedrock#S3Uri", + "traits": { + "smithy.api#documentation": "

The S3 URI where the validation data is stored.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a validator.

" + } + }, + "com.amazonaws.bedrock#ValidatorMetric": { + "type": "structure", + "members": { + "validationLoss": { + "target": "com.amazonaws.bedrock#MetricFloat", + "traits": { + "smithy.api#documentation": "

The validation loss associated with this validator.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metric for the validator.

" + } + }, + "com.amazonaws.bedrock#Validators": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrock#Validator" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrock#VpcConfig": { + "type": "structure", + "members": { + "subnetIds": { + "target": "com.amazonaws.bedrock#SubnetIds", + "traits": { + "smithy.api#documentation": "

VPC configuration subnets.

", + "smithy.api#required": {} + } + }, + "securityGroupIds": { + "target": "com.amazonaws.bedrock#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

VPC configuration security group Ids.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

VPC configuration.

" + } } - }, - "traits": { - "smithy.api#documentation": "

VPC configuration.

" - } } - } -} +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/emr-containers.json b/codegen/sdk-codegen/aws-models/emr-containers.json index b3ad6cb38630..f70b533f308e 100644 --- a/codegen/sdk-codegen/aws-models/emr-containers.json +++ b/codegen/sdk-codegen/aws-models/emr-containers.json @@ -1,4789 +1,4853 @@ { - "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.emrcontainers#ACMCertArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 44, - "max": 2048 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):acm:.+:(\\d{12}):certificate/.+$" - } - }, - "com.amazonaws.emrcontainers#AuthorizationConfiguration": { - "type": "structure", - "members": { - "lakeFormationConfiguration": { - "target": "com.amazonaws.emrcontainers#LakeFormationConfiguration", - "traits": { - "smithy.api#documentation": "

Lake Formation related configuration inputs for the security\n configuration.

" - } - }, - "encryptionConfiguration": { - "target": "com.amazonaws.emrcontainers#EncryptionConfiguration", - "traits": { - "smithy.api#documentation": "

Encryption-related configuration input for the security configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Authorization-related configuration inputs for the security configuration.

" - } - }, - "com.amazonaws.emrcontainers#AwsChicagoWebService": { - "type": "service", - "version": "2020-10-01", - "operations": [ - { - "target": "com.amazonaws.emrcontainers#CancelJobRun" - }, - { - "target": "com.amazonaws.emrcontainers#CreateJobTemplate" - }, - { - "target": "com.amazonaws.emrcontainers#CreateManagedEndpoint" - }, - { - "target": "com.amazonaws.emrcontainers#CreateSecurityConfiguration" - }, - { - "target": "com.amazonaws.emrcontainers#CreateVirtualCluster" - }, - { - "target": "com.amazonaws.emrcontainers#DeleteJobTemplate" - }, - { - "target": "com.amazonaws.emrcontainers#DeleteManagedEndpoint" - }, - { - "target": "com.amazonaws.emrcontainers#DeleteVirtualCluster" - }, - { - "target": "com.amazonaws.emrcontainers#DescribeJobRun" - }, - { - "target": "com.amazonaws.emrcontainers#DescribeJobTemplate" - }, - { - "target": "com.amazonaws.emrcontainers#DescribeManagedEndpoint" - }, - { - "target": "com.amazonaws.emrcontainers#DescribeSecurityConfiguration" - }, - { - "target": "com.amazonaws.emrcontainers#DescribeVirtualCluster" - }, - { - "target": "com.amazonaws.emrcontainers#GetManagedEndpointSessionCredentials" - }, - { - "target": "com.amazonaws.emrcontainers#ListJobRuns" - }, - { - "target": "com.amazonaws.emrcontainers#ListJobTemplates" - }, - { - "target": "com.amazonaws.emrcontainers#ListManagedEndpoints" - }, - { - "target": "com.amazonaws.emrcontainers#ListSecurityConfigurations" - }, - { - "target": "com.amazonaws.emrcontainers#ListTagsForResource" - }, - { - "target": "com.amazonaws.emrcontainers#ListVirtualClusters" - }, - { - "target": "com.amazonaws.emrcontainers#StartJobRun" - }, - { - "target": "com.amazonaws.emrcontainers#TagResource" - }, - { - "target": "com.amazonaws.emrcontainers#UntagResource" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "EMR containers", - "arnNamespace": "emr-containers", - "cloudFormationName": "EMRcontainers", - "cloudTrailEventSource": "emrcontainers.amazonaws.com", - "endpointPrefix": "emr-containers" - }, - "aws.auth#sigv4": { - "name": "emr-containers" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Amazon EMR on EKS provides a deployment option for Amazon EMR that allows\n you to run open-source big data frameworks on Amazon Elastic Kubernetes Service (Amazon EKS).\n With this deployment option, you can focus on running analytics workloads while Amazon EMR on EKS builds, configures, and manages containers for open-source applications.\n For more information about Amazon EMR on EKS concepts and tasks, see What is\n Amazon EMR on EKS.

\n

\n Amazon EMR containers is the API name for Amazon EMR on EKS. The emr-containers prefix is used in the following\n scenarios:

\n ", - "smithy.api#title": "Amazon EMR Containers", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ + "smithy": "2.0", + "metadata": { + "suppressions": [ { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.emrcontainers#ACMCertArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 44, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):acm:.+:(\\d{12}):certificate/.+$" + } + }, + "com.amazonaws.emrcontainers#AuthorizationConfiguration": { + "type": "structure", + "members": { + "lakeFormationConfiguration": { + "target": "com.amazonaws.emrcontainers#LakeFormationConfiguration", + "traits": { + "smithy.api#documentation": "

Lake Formation related configuration inputs for the security\n configuration.

" + } + }, + "encryptionConfiguration": { + "target": "com.amazonaws.emrcontainers#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

Encryption-related configuration input for the security configuration.

" } - ] } - ], - "rules": [ + }, + "traits": { + "smithy.api#documentation": "

Authorization-related configuration inputs for the security configuration.

" + } + }, + "com.amazonaws.emrcontainers#AwsChicagoWebService": { + "type": "service", + "version": "2020-10-01", + "operations": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" + "target": "com.amazonaws.emrcontainers#CancelJobRun" }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "target": "com.amazonaws.emrcontainers#CreateJobTemplate" }, { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ + "target": "com.amazonaws.emrcontainers#CreateManagedEndpoint" + }, { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ + "target": "com.amazonaws.emrcontainers#CreateSecurityConfiguration" + }, + { + "target": "com.amazonaws.emrcontainers#CreateVirtualCluster" + }, + { + "target": "com.amazonaws.emrcontainers#DeleteJobTemplate" + }, { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ + "target": "com.amazonaws.emrcontainers#DeleteManagedEndpoint" + }, + { + "target": "com.amazonaws.emrcontainers#DeleteVirtualCluster" + }, + { + "target": "com.amazonaws.emrcontainers#DescribeJobRun" + }, + { + "target": "com.amazonaws.emrcontainers#DescribeJobTemplate" + }, + { + "target": "com.amazonaws.emrcontainers#DescribeManagedEndpoint" + }, + { + "target": "com.amazonaws.emrcontainers#DescribeSecurityConfiguration" + }, + { + "target": "com.amazonaws.emrcontainers#DescribeVirtualCluster" + }, + { + "target": "com.amazonaws.emrcontainers#GetManagedEndpointSessionCredentials" + }, + { + "target": "com.amazonaws.emrcontainers#ListJobRuns" + }, + { + "target": "com.amazonaws.emrcontainers#ListJobTemplates" + }, + { + "target": "com.amazonaws.emrcontainers#ListManagedEndpoints" + }, + { + "target": "com.amazonaws.emrcontainers#ListSecurityConfigurations" + }, + { + "target": "com.amazonaws.emrcontainers#ListTagsForResource" + }, + { + "target": "com.amazonaws.emrcontainers#ListVirtualClusters" + }, + { + "target": "com.amazonaws.emrcontainers#StartJobRun" + }, + { + "target": "com.amazonaws.emrcontainers#TagResource" + }, + { + "target": "com.amazonaws.emrcontainers#UntagResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "EMR containers", + "arnNamespace": "emr-containers", + "cloudFormationName": "EMRcontainers", + "cloudTrailEventSource": "emrcontainers.amazonaws.com", + "endpointPrefix": "emr-containers" + }, + "aws.auth#sigv4": { + "name": "emr-containers" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Amazon EMR on EKS provides a deployment option for Amazon EMR that allows\n you to run open-source big data frameworks on Amazon Elastic Kubernetes Service (Amazon EKS).\n With this deployment option, you can focus on running analytics workloads while Amazon EMR on EKS builds, configures, and manages containers for open-source applications.\n For more information about Amazon EMR on EKS concepts and tasks, see What is\n Amazon EMR on EKS.

\n

\n Amazon EMR containers is the API name for Amazon EMR on EKS. The emr-containers prefix is used in the following\n scenarios:

\n ", + "smithy.api#title": "Amazon EMR Containers", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://emr-containers-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-east-1" + ] + } + ], + "endpoint": { + "url": "https://emr-containers.us-gov-east-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-gov-west-1" + ] + } + ], + "endpoint": { + "url": "https://emr-containers.us-gov-west-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://emr-containers-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://emr-containers.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://emr-containers.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, { - "ref": "Region" + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.ap-northeast-1.amazonaws.com" + } }, - true - ] + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.ap-northeast-2.amazonaws.com" + } }, - true - ] - } - ], - "rules": [ + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.ap-south-1.amazonaws.com" } - ] }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + "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://emr-containers.ap-southeast-1.amazonaws.com" } - ] + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://emr-containers-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false } - ], - "type": "tree" }, { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers-fips.ca-central-1.amazonaws.com" + } }, - true - ] - } - ], - "rules": [ + "params": { + "Region": "ca-central-1", + "UseFIPS": true, + "UseDualStack": false + } + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://emr-containers-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false } - ], - "type": "tree" }, { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.eu-west-2.amazonaws.com" + } }, - true - ] - } - ], - "rules": [ + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.eu-west-3.amazonaws.com" } - ] + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://emr-containers.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false } - ], - "type": "tree" }, { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://emr-containers.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-containers.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://emr-containers.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-containers.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://emr-containers.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://emr-containers.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-containers.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-containers-fips.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-containers.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://emr-containers.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-containers.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://emr-containers.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://emr-containers.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-containers.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://emr-containers.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://emr-containers-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://emr-containers.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://emr-containers-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://emr-containers.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://emr-containers-fips.us-west-1.amazonaws.com" + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers.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://emr-containers-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://emr-containers.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://emr-containers-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://emr-containers.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://emr-containers-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://emr-containers.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://emr-containers-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://emr-containers-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://emr-containers.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://emr-containers.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://emr-containers.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://emr-containers-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://emr-containers-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://emr-containers.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://emr-containers.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://emr-containers.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://emr-containers.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://emr-containers.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://emr-containers-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://emr-containers.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-containers-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://emr-containers.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://emr-containers-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://emr-containers.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" } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": true, - "UseDualStack": false - } + } + }, + "com.amazonaws.emrcontainers#Base64Encoded": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5000 + }, + "smithy.api#pattern": "^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$" + } + }, + "com.amazonaws.emrcontainers#Boolean": { + "type": "boolean" + }, + "com.amazonaws.emrcontainers#CancelJobRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#CancelJobRunRequest" }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-containers.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.emrcontainers#CancelJobRunResponse" }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-containers-fips.us-west-2.amazonaws.com" + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" } - }, - "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://emr-containers-fips.us-east-1.api.aws" + ], + "traits": { + "smithy.api#documentation": "

Cancels a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or\n SparkSQL query, that you submit to Amazon EMR on EKS.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/virtualclusters/{virtualClusterId}/jobruns/{id}", + "code": 200 } - }, - "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://emr-containers.us-east-1.api.aws" + } + }, + "com.amazonaws.emrcontainers#CancelJobRunRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the job run to cancel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the virtual cluster for which the job run will be canceled.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } - }, - "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://emr-containers.cn-north-1.amazonaws.com.cn" + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#CancelJobRunResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The output contains the ID of the cancelled job run.

" + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The output contains the virtual cluster ID for which the job run is cancelled.

" + } } - }, - "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://emr-containers.cn-northwest-1.amazonaws.com.cn" + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#Certificate": { + "type": "structure", + "members": { + "certificateArn": { + "target": "com.amazonaws.emrcontainers#ACMCertArn", + "traits": { + "smithy.api#documentation": "

The ARN of the certificate generated for managed endpoint.

" + } + }, + "certificateData": { + "target": "com.amazonaws.emrcontainers#Base64Encoded", + "traits": { + "smithy.api#documentation": "

The base64 encoded PEM certificate data generated for managed endpoint.

" + } } - }, - "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://emr-containers-fips.cn-north-1.api.amazonwebservices.com.cn" + "traits": { + "smithy.api#documentation": "

The entity representing certificate data generated for managed endpoint.

" + } + }, + "com.amazonaws.emrcontainers#CertificateProviderType": { + "type": "enum", + "members": { + "PEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PEM" + } } - }, - "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://emr-containers-fips.cn-north-1.amazonaws.com.cn" + } + }, + "com.amazonaws.emrcontainers#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.emrcontainers#CloudWatchMonitoringConfiguration": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.emrcontainers#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group for log publishing.

", + "smithy.api#required": {} + } + }, + "logStreamNamePrefix": { + "target": "com.amazonaws.emrcontainers#String256", + "traits": { + "smithy.api#documentation": "

The specified name prefix for log streams.

" + } } - }, - "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://emr-containers.cn-north-1.api.amazonwebservices.com.cn" + "traits": { + "smithy.api#documentation": "

A configuration for CloudWatch monitoring. You can configure your jobs to send log\n information to CloudWatch Logs.

" + } + }, + "com.amazonaws.emrcontainers#ClusterId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[0-9A-Za-z][A-Za-z0-9\\-_]*$" + } + }, + "com.amazonaws.emrcontainers#Configuration": { + "type": "structure", + "members": { + "classification": { + "target": "com.amazonaws.emrcontainers#String1024", + "traits": { + "smithy.api#documentation": "

The classification within a configuration.

", + "smithy.api#required": {} + } + }, + "properties": { + "target": "com.amazonaws.emrcontainers#SensitivePropertiesMap", + "traits": { + "smithy.api#documentation": "

A set of properties specified within a configuration classification.

" + } + }, + "configurations": { + "target": "com.amazonaws.emrcontainers#ConfigurationList", + "traits": { + "smithy.api#documentation": "

A list of additional configurations to apply within a configuration object.

" + } } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-containers-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "traits": { + "smithy.api#documentation": "

A configuration specification to be used when provisioning virtual clusters, which can\n include configurations for applications and software bundled with Amazon EMR on EKS. A\n configuration consists of a classification, properties, and optional nested configurations.\n A classification refers to an application-specific configuration file. Properties are the\n settings you want to change in that file.

" + } + }, + "com.amazonaws.emrcontainers#ConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#Configuration" }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-containers-fips.us-gov-east-1.amazonaws.com" + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.emrcontainers#ConfigurationOverrides": { + "type": "structure", + "members": { + "applicationConfiguration": { + "target": "com.amazonaws.emrcontainers#ConfigurationList", + "traits": { + "smithy.api#documentation": "

The configurations for the application running by the job run.

" + } + }, + "monitoringConfiguration": { + "target": "com.amazonaws.emrcontainers#MonitoringConfiguration", + "traits": { + "smithy.api#documentation": "

The configurations for monitoring.

" + } } - }, - "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://emr-containers.us-gov-east-1.api.aws" + "traits": { + "smithy.api#documentation": "

A configuration specification to be used to override existing configurations.

" + } + }, + "com.amazonaws.emrcontainers#ContainerInfo": { + "type": "union", + "members": { + "eksInfo": { + "target": "com.amazonaws.emrcontainers#EksInfo", + "traits": { + "smithy.api#documentation": "

The information about the Amazon EKS cluster.

" + } } - }, - "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://emr-containers.us-gov-east-1.amazonaws.com" + "traits": { + "smithy.api#documentation": "

The information about the container used for a job run or a managed endpoint.

" + } + }, + "com.amazonaws.emrcontainers#ContainerLogRotationConfiguration": { + "type": "structure", + "members": { + "rotationSize": { + "target": "com.amazonaws.emrcontainers#RotationSize", + "traits": { + "smithy.api#documentation": "

The file size at which to rotate logs. Minimum of 2KB, Maximum of 2GB.

", + "smithy.api#required": {} + } + }, + "maxFilesToKeep": { + "target": "com.amazonaws.emrcontainers#MaxFilesToKeep", + "traits": { + "smithy.api#documentation": "

The number of files to keep in container after rotation.

", + "smithy.api#required": {} + } } - }, - "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 - } + "traits": { + "smithy.api#documentation": "

The settings for container log rotation.

" + } + }, + "com.amazonaws.emrcontainers#ContainerProvider": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.emrcontainers#ContainerProviderType", + "traits": { + "smithy.api#documentation": "

The type of the container provider. Amazon EKS is the only supported type as of\n now.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.emrcontainers#ClusterId", + "traits": { + "smithy.api#documentation": "

The ID of the container cluster.

", + "smithy.api#required": {} + } + }, + "info": { + "target": "com.amazonaws.emrcontainers#ContainerInfo", + "traits": { + "smithy.api#documentation": "

The information about the container cluster.

" + } + } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-containers-fips.us-iso-east-1.c2s.ic.gov" + "traits": { + "smithy.api#documentation": "

The information about the container provider.

" + } + }, + "com.amazonaws.emrcontainers#ContainerProviderType": { + "type": "enum", + "members": { + "EKS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS" + } } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } + } + }, + "com.amazonaws.emrcontainers#CreateJobTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#CreateJobTemplateRequest" }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "output": { + "target": "com.amazonaws.emrcontainers#CreateJobTemplateResponse" }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-containers.us-iso-east-1.c2s.ic.gov" + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a job template. Job template stores values of StartJobRun API request in a\n template and can be used to start a job run. Job template allows two use cases: avoid\n repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun\n API request.

", + "smithy.api#http": { + "method": "POST", + "uri": "/jobtemplates", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#CreateJobTemplateRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The specified name of the job template.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.emrcontainers#ClientToken", + "traits": { + "smithy.api#documentation": "

The client token of the job template.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "jobTemplateData": { + "target": "com.amazonaws.emrcontainers#JobTemplateData", + "traits": { + "smithy.api#documentation": "

The job template data which holds values of StartJobRun API request.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The tags that are associated with the job template.

" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.emrcontainers#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The KMS key ARN used to encrypt the job template.

" + } } - }, - "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 - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#CreateJobTemplateResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

This output display the created job template ID.

" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

This output displays the name of the created job template.

" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#JobTemplateArn", + "traits": { + "smithy.api#documentation": "

This output display the ARN of the created job template.

" + } + }, + "createdAt": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

This output displays the date and time when the job template was created.

" + } + } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-containers-fips.us-isob-east-1.sc2s.sgov.gov" + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#CreateManagedEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#CreateManagedEndpointRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#CreateManagedEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can\n communicate with your virtual cluster.

", + "smithy.api#http": { + "method": "POST", + "uri": "/virtualclusters/{virtualClusterId}/endpoints", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#CreateManagedEndpointRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The name of the managed endpoint.

", + "smithy.api#required": {} + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the virtual cluster for which a managed endpoint is created.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.emrcontainers#EndpointType", + "traits": { + "smithy.api#documentation": "

The type of the managed endpoint.

", + "smithy.api#required": {} + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrcontainers#ReleaseLabel", + "traits": { + "smithy.api#documentation": "

The Amazon EMR release version.

", + "smithy.api#required": {} + } + }, + "executionRoleArn": { + "target": "com.amazonaws.emrcontainers#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

The ARN of the execution role.

", + "smithy.api#required": {} + } + }, + "certificateArn": { + "target": "com.amazonaws.emrcontainers#ACMCertArn", + "traits": { + "smithy.api#deprecated": { + "message": "Customer provided certificate-arn is deprecated and would be removed in future." + }, + "smithy.api#documentation": "

The certificate ARN provided by users for the managed endpoint. This field is under\n deprecation and will be removed in future releases.

" + } + }, + "configurationOverrides": { + "target": "com.amazonaws.emrcontainers#ConfigurationOverrides", + "traits": { + "smithy.api#documentation": "

The configuration settings that will be used to override existing configurations.

" + } + }, + "clientToken": { + "target": "com.amazonaws.emrcontainers#ClientToken", + "traits": { + "smithy.api#documentation": "

The client idempotency token for this create call.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The tags of the managed endpoint.

" + } } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#CreateManagedEndpointResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The output contains the ID of the managed endpoint.

" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The output contains the name of the managed endpoint.

" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#EndpointArn", + "traits": { + "smithy.api#documentation": "

The output contains the ARN of the managed endpoint.

" + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The output contains the ID of the virtual cluster.

" + } + } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-containers.us-isob-east-1.sc2s.sgov.gov" + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#CreateSecurityConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#CreateSecurityConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#CreateSecurityConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a security configuration. Security configurations in Amazon EMR on EKS are\n templates for different security setups. You can use security configurations to configure\n the Lake Formation integration setup. You can also create a security configuration\n to re-use a security setup each time you create a virtual cluster.

", + "smithy.api#http": { + "method": "POST", + "uri": "/securityconfigurations", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#CreateSecurityConfigurationRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.emrcontainers#ClientToken", + "traits": { + "smithy.api#documentation": "

The client idempotency token to use when creating the security configuration.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The name of the security configuration.

", + "smithy.api#required": {} + } + }, + "securityConfigurationData": { + "target": "com.amazonaws.emrcontainers#SecurityConfigurationData", + "traits": { + "smithy.api#documentation": "

Security configuration input for the request.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The tags to add to the security configuration.

" + } } - }, - "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" + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#CreateSecurityConfigurationResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the security configuration.

" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The name of the security configuration.

" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#SecurityConfigurationArn", + "traits": { + "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the security configuration.

" + } } - }, - "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" + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#CreateVirtualCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#CreateVirtualClusterRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#CreateVirtualClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#EKSRequestThrottledException" + }, + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any\n additional resource in your system. A single virtual cluster maps to a single Kubernetes\n namespace. Given this relationship, you can model virtual clusters the same way you model\n Kubernetes namespaces to meet your requirements.

", + "smithy.api#http": { + "method": "POST", + "uri": "/virtualclusters", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#CreateVirtualClusterRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The specified name of the virtual cluster.

", + "smithy.api#required": {} + } + }, + "containerProvider": { + "target": "com.amazonaws.emrcontainers#ContainerProvider", + "traits": { + "smithy.api#documentation": "

The container provider of the virtual cluster.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.emrcontainers#ClientToken", + "traits": { + "smithy.api#documentation": "

The client token of the virtual cluster.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to the virtual cluster.

" + } + }, + "securityConfigurationId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the security configuration.

" + } } - }, - "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" - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#CreateVirtualClusterResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

This output contains the virtual cluster ID.

" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

This output contains the name of the virtual cluster.

" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#VirtualClusterArn", + "traits": { + "smithy.api#documentation": "

This output contains the ARN of virtual cluster.

" + } + } }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#CredentialType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^.*\\S.*$" + } + }, + "com.amazonaws.emrcontainers#Credentials": { + "type": "union", + "members": { + "token": { + "target": "com.amazonaws.emrcontainers#Token", + "traits": { + "smithy.api#documentation": "

The actual session token being returned.

" + } + } }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } + "traits": { + "smithy.api#documentation": "

The structure containing the session token being returned.

" + } + }, + "com.amazonaws.emrcontainers#Date": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.emrcontainers#DeleteJobTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#DeleteJobTemplateRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#DeleteJobTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a job template. Job template stores values of StartJobRun API request in a\n template and can be used to start a job run. Job template allows two use cases: avoid\n repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun\n API request.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/jobtemplates/{id}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#DeleteJobTemplateRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the job template that will be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#DeleteJobTemplateResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

This output contains the ID of the job template that was deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#DeleteManagedEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#DeleteManagedEndpointRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#DeleteManagedEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can\n communicate with your virtual cluster.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/virtualclusters/{virtualClusterId}/endpoints/{id}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#DeleteManagedEndpointRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the managed endpoint.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the endpoint's virtual cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#DeleteManagedEndpointResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The output displays the ID of the managed endpoint.

" + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The output displays the ID of the endpoint's virtual cluster.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#DeleteVirtualCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#DeleteVirtualClusterRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#DeleteVirtualClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any\n additional resource in your system. A single virtual cluster maps to a single Kubernetes\n namespace. Given this relationship, you can model virtual clusters the same way you model\n Kubernetes namespaces to meet your requirements.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/virtualclusters/{id}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#DeleteVirtualClusterRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the virtual cluster that will be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#DeleteVirtualClusterResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

This output contains the ID of the virtual cluster that will be deleted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#DescribeJobRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#DescribeJobRunRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#DescribeJobRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Displays detailed information about a job run. A job run is a unit of work, such as a\n Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

", + "smithy.api#http": { + "method": "GET", + "uri": "/virtualclusters/{virtualClusterId}/jobruns/{id}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#DescribeJobRunRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the job run request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the virtual cluster for which the job run is submitted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#DescribeJobRunResponse": { + "type": "structure", + "members": { + "jobRun": { + "target": "com.amazonaws.emrcontainers#JobRun", + "traits": { + "smithy.api#documentation": "

The output displays information about a job run.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#DescribeJobTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#DescribeJobTemplateRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#DescribeJobTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Displays detailed information about a specified job template. Job template stores values\n of StartJobRun API request in a template and can be used to start a job run. Job template\n allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing\n certain values in StartJobRun API request.

", + "smithy.api#http": { + "method": "GET", + "uri": "/jobtemplates/{id}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#DescribeJobTemplateRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the job template that will be described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#DescribeJobTemplateResponse": { + "type": "structure", + "members": { + "jobTemplate": { + "target": "com.amazonaws.emrcontainers#JobTemplate", + "traits": { + "smithy.api#documentation": "

This output displays information about the specified job template.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#DescribeManagedEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#DescribeManagedEndpointRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#DescribeManagedEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Displays detailed information about a managed endpoint. A managed endpoint is a gateway\n that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.

", + "smithy.api#http": { + "method": "GET", + "uri": "/virtualclusters/{virtualClusterId}/endpoints/{id}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#DescribeManagedEndpointRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

This output displays ID of the managed endpoint.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the endpoint's virtual cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#DescribeManagedEndpointResponse": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.emrcontainers#Endpoint", + "traits": { + "smithy.api#documentation": "

This output displays information about a managed endpoint.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#DescribeSecurityConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#DescribeSecurityConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#DescribeSecurityConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Displays detailed information about a specified security configuration. Security\n configurations in Amazon EMR on EKS are templates for different security setups. You\n can use security configurations to configure the Lake Formation integration setup.\n You can also create a security configuration to re-use a security setup each time you\n create a virtual cluster.

", + "smithy.api#http": { + "method": "GET", + "uri": "/securityconfigurations/{id}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#DescribeSecurityConfigurationRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the security configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#DescribeSecurityConfigurationResponse": { + "type": "structure", + "members": { + "securityConfiguration": { + "target": "com.amazonaws.emrcontainers#SecurityConfiguration", + "traits": { + "smithy.api#documentation": "

Details of the security configuration.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#DescribeVirtualCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#DescribeVirtualClusterRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#DescribeVirtualClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Displays detailed information about a specified virtual cluster. Virtual cluster is a\n managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual\n clusters. They do not consume any additional resource in your system. A single virtual\n cluster maps to a single Kubernetes namespace. Given this relationship, you can model\n virtual clusters the same way you model Kubernetes namespaces to meet your\n requirements.

", + "smithy.api#http": { + "method": "GET", + "uri": "/virtualclusters/{id}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#DescribeVirtualClusterRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the virtual cluster that will be described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#DescribeVirtualClusterResponse": { + "type": "structure", + "members": { + "virtualCluster": { + "target": "com.amazonaws.emrcontainers#VirtualCluster", + "traits": { + "smithy.api#documentation": "

This output displays information about the specified virtual cluster.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#EKSRequestThrottledException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrcontainers#String1024" + } + }, + "traits": { + "smithy.api#documentation": "

The request exceeded the Amazon EKS API operation limits.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.emrcontainers#EksInfo": { + "type": "structure", + "members": { + "namespace": { + "target": "com.amazonaws.emrcontainers#KubernetesNamespace", + "traits": { + "smithy.api#documentation": "

The namespaces of the Amazon EKS cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The information about the Amazon EKS cluster.

" + } + }, + "com.amazonaws.emrcontainers#EncryptionConfiguration": { + "type": "structure", + "members": { + "inTransitEncryptionConfiguration": { + "target": "com.amazonaws.emrcontainers#InTransitEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

In-transit encryption-related input for the security configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configurations related to encryption for the security configuration.

" + } + }, + "com.amazonaws.emrcontainers#Endpoint": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the endpoint.

" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The name of the endpoint.

" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#EndpointArn", + "traits": { + "smithy.api#documentation": "

The ARN of the endpoint.

" + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the endpoint's virtual cluster.

" + } + }, + "type": { + "target": "com.amazonaws.emrcontainers#EndpointType", + "traits": { + "smithy.api#documentation": "

The type of the endpoint.

" + } + }, + "state": { + "target": "com.amazonaws.emrcontainers#EndpointState", + "traits": { + "smithy.api#documentation": "

The state of the endpoint.

" + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrcontainers#ReleaseLabel", + "traits": { + "smithy.api#documentation": "

The EMR release version to be used for the endpoint.

" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.emrcontainers#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

The execution role ARN of the endpoint.

" + } + }, + "certificateArn": { + "target": "com.amazonaws.emrcontainers#ACMCertArn", + "traits": { + "smithy.api#deprecated": { + "message": "Customer provided certificate-arn is deprecated and would be removed in future." + }, + "smithy.api#documentation": "

The certificate ARN of the endpoint. This field is under deprecation and will be removed\n in future.

" + } + }, + "certificateAuthority": { + "target": "com.amazonaws.emrcontainers#Certificate", + "traits": { + "smithy.api#documentation": "

The certificate generated by emr control plane on customer behalf to secure the managed\n endpoint.

" + } + }, + "configurationOverrides": { + "target": "com.amazonaws.emrcontainers#ConfigurationOverrides", + "traits": { + "smithy.api#documentation": "

The configuration settings that are used to override existing configurations for\n endpoints.

" + } + }, + "serverUrl": { + "target": "com.amazonaws.emrcontainers#UriString", + "traits": { + "smithy.api#documentation": "

The server URL of the endpoint.

" + } + }, + "createdAt": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the endpoint was created.

" + } + }, + "securityGroup": { + "target": "com.amazonaws.emrcontainers#String256", + "traits": { + "smithy.api#documentation": "

The security group configuration of the endpoint.

" + } + }, + "subnetIds": { + "target": "com.amazonaws.emrcontainers#SubnetIds", + "traits": { + "smithy.api#documentation": "

The subnet IDs of the endpoint.

" + } + }, + "stateDetails": { + "target": "com.amazonaws.emrcontainers#String256", + "traits": { + "smithy.api#documentation": "

Additional details of the endpoint state.

" + } + }, + "failureReason": { + "target": "com.amazonaws.emrcontainers#FailureReason", + "traits": { + "smithy.api#documentation": "

The reasons why the endpoint has failed.

" + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The tags of the endpoint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This entity represents the endpoint that is managed by Amazon EMR on EKS.

" + } + }, + "com.amazonaws.emrcontainers#EndpointArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 60, + "max": 1024 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/virtualclusters\\/[0-9a-zA-Z]+\\/endpoints\\/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.emrcontainers#EndpointState": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "TERMINATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATING" + } + }, + "TERMINATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATED" + } + }, + "TERMINATED_WITH_ERRORS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATED_WITH_ERRORS" + } + } + } + }, + "com.amazonaws.emrcontainers#EndpointStates": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#EndpointState" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.emrcontainers#EndpointType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.emrcontainers#EndpointTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#EndpointType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.emrcontainers#Endpoints": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#Endpoint" + } + }, + "com.amazonaws.emrcontainers#EntryPointArgument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10280 + }, + "smithy.api#pattern": "\\S", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrcontainers#EntryPointArguments": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#EntryPointArgument" + } + }, + "com.amazonaws.emrcontainers#EntryPointPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "\\S", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrcontainers#FailureReason": { + "type": "enum", + "members": { + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + }, + "USER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_ERROR" + } + }, + "VALIDATION_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION_ERROR" + } + }, + "CLUSTER_UNAVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLUSTER_UNAVAILABLE" + } + } + } + }, + "com.amazonaws.emrcontainers#GetManagedEndpointSessionCredentials": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#GetManagedEndpointSessionCredentialsRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#GetManagedEndpointSessionCredentialsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#RequestThrottledException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Generate a session token to connect to a managed endpoint.

", + "smithy.api#http": { + "method": "POST", + "uri": "/virtualclusters/{virtualClusterIdentifier}/endpoints/{endpointIdentifier}/credentials", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#GetManagedEndpointSessionCredentialsRequest": { + "type": "structure", + "members": { + "endpointIdentifier": { + "target": "com.amazonaws.emrcontainers#String2048", + "traits": { + "smithy.api#documentation": "

The ARN of the managed endpoint for which the request is submitted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "virtualClusterIdentifier": { + "target": "com.amazonaws.emrcontainers#String2048", + "traits": { + "smithy.api#documentation": "

The ARN of the Virtual Cluster which the Managed Endpoint belongs to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "executionRoleArn": { + "target": "com.amazonaws.emrcontainers#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

The IAM Execution Role ARN that will be used by the job run.

", + "smithy.api#required": {} + } + }, + "credentialType": { + "target": "com.amazonaws.emrcontainers#CredentialType", + "traits": { + "smithy.api#documentation": "

Type of the token requested. Currently supported and default value of this field is\n “TOKEN.”

", + "smithy.api#required": {} + } + }, + "durationInSeconds": { + "target": "com.amazonaws.emrcontainers#JavaInteger", + "traits": { + "smithy.api#documentation": "

Duration in seconds for which the session token is valid. The default duration is 15\n minutes and the maximum is 12 hours.

" + } + }, + "logContext": { + "target": "com.amazonaws.emrcontainers#LogContext", + "traits": { + "smithy.api#documentation": "

String identifier used to separate sections of the execution logs uploaded to S3.

" + } + }, + "clientToken": { + "target": "com.amazonaws.emrcontainers#ClientToken", + "traits": { + "smithy.api#documentation": "

The client idempotency token of the job run request.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#GetManagedEndpointSessionCredentialsResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The identifier of the session token returned.

" + } + }, + "credentials": { + "target": "com.amazonaws.emrcontainers#Credentials", + "traits": { + "smithy.api#documentation": "

The structure containing the session credentials.

" + } + }, + "expiresAt": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the session token will expire.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#IAMRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):iam::(\\d{12})?:(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)$" + } + }, + "com.amazonaws.emrcontainers#InTransitEncryptionConfiguration": { + "type": "structure", + "members": { + "tlsCertificateConfiguration": { + "target": "com.amazonaws.emrcontainers#TLSCertificateConfiguration", + "traits": { + "smithy.api#documentation": "

TLS certificate-related configuration input for the security configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configurations related to in-transit encryption for the security configuration.

" + } + }, + "com.amazonaws.emrcontainers#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrcontainers#String1024" + } + }, + "traits": { + "smithy.api#documentation": "

This is an internal server exception.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.emrcontainers#JavaInteger": { + "type": "integer" + }, + "com.amazonaws.emrcontainers#JobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 60, + "max": 1024 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/virtualclusters\\/[0-9a-zA-Z]+\\/jobruns\\/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.emrcontainers#JobDriver": { + "type": "structure", + "members": { + "sparkSubmitJobDriver": { + "target": "com.amazonaws.emrcontainers#SparkSubmitJobDriver", + "traits": { + "smithy.api#documentation": "

The job driver parameters specified for spark submit.

" + } + }, + "sparkSqlJobDriver": { + "target": "com.amazonaws.emrcontainers#SparkSqlJobDriver", + "traits": { + "smithy.api#documentation": "

The job driver for job type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specify the driver that the job runs on. Exactly one of the two available job drivers is\n required, either sparkSqlJobDriver or sparkSubmitJobDriver.

" + } + }, + "com.amazonaws.emrcontainers#JobRun": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the job run.

" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The name of the job run.

" + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the job run's virtual cluster.

" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#JobArn", + "traits": { + "smithy.api#documentation": "

The ARN of job run.

" + } + }, + "state": { + "target": "com.amazonaws.emrcontainers#JobRunState", + "traits": { + "smithy.api#documentation": "

The state of the job run.

" + } + }, + "clientToken": { + "target": "com.amazonaws.emrcontainers#ClientToken", + "traits": { + "smithy.api#documentation": "

The client token used to start a job run.

" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.emrcontainers#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

The execution role ARN of the job run.

" + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrcontainers#ReleaseLabel", + "traits": { + "smithy.api#documentation": "

The release version of Amazon EMR.

" + } + }, + "configurationOverrides": { + "target": "com.amazonaws.emrcontainers#ConfigurationOverrides", + "traits": { + "smithy.api#documentation": "

The configuration settings that are used to override default configuration.

" + } + }, + "jobDriver": { + "target": "com.amazonaws.emrcontainers#JobDriver", + "traits": { + "smithy.api#documentation": "

Parameters of job driver for the job run.

" + } + }, + "createdAt": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the job run was created.

" + } + }, + "createdBy": { + "target": "com.amazonaws.emrcontainers#RequestIdentityUserArn", + "traits": { + "smithy.api#documentation": "

The user who created the job run.

" + } + }, + "finishedAt": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the job run has finished.

" + } + }, + "stateDetails": { + "target": "com.amazonaws.emrcontainers#String256", + "traits": { + "smithy.api#documentation": "

Additional details of the job run state.

" + } + }, + "failureReason": { + "target": "com.amazonaws.emrcontainers#FailureReason", + "traits": { + "smithy.api#documentation": "

The reasons why the job run has failed.

" + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The assigned tags of the job run.

" + } + }, + "retryPolicyConfiguration": { + "target": "com.amazonaws.emrcontainers#RetryPolicyConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the retry policy that the job runs on.

" + } + }, + "retryPolicyExecution": { + "target": "com.amazonaws.emrcontainers#RetryPolicyExecution", + "traits": { + "smithy.api#documentation": "

The current status of the retry policy executed on the job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This entity describes a job run. A job run is a unit of work, such as a Spark jar,\n PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

" + } + }, + "com.amazonaws.emrcontainers#JobRunState": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "SUBMITTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBMITTED" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "CANCEL_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCEL_PENDING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + } + } + }, + "com.amazonaws.emrcontainers#JobRunStates": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#JobRunState" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.emrcontainers#JobRuns": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#JobRun" + } + }, + "com.amazonaws.emrcontainers#JobTemplate": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The name of the job template.

" + } + }, + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the job template.

" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#JobTemplateArn", + "traits": { + "smithy.api#documentation": "

The ARN of the job template.

" + } + }, + "createdAt": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the job template was created.

" + } + }, + "createdBy": { + "target": "com.amazonaws.emrcontainers#RequestIdentityUserArn", + "traits": { + "smithy.api#documentation": "

The user who created the job template.

" + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to the job template.

" + } + }, + "jobTemplateData": { + "target": "com.amazonaws.emrcontainers#JobTemplateData", + "traits": { + "smithy.api#documentation": "

The job template data which holds values of StartJobRun API request.

", + "smithy.api#required": {} + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.emrcontainers#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The KMS key ARN used to encrypt the job template.

" + } + }, + "decryptionError": { + "target": "com.amazonaws.emrcontainers#String2048", + "traits": { + "smithy.api#documentation": "

The error message in case the decryption of job template fails.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This entity describes a job template. Job template stores values of StartJobRun API\n request in a template and can be used to start a job run. Job template allows two use\n cases: avoid repeating recurring StartJobRun API request values, enforcing certain values\n in StartJobRun API request.

" + } + }, + "com.amazonaws.emrcontainers#JobTemplateArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 60, + "max": 1024 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/jobtemplates\\/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.emrcontainers#JobTemplateData": { + "type": "structure", + "members": { + "executionRoleArn": { + "target": "com.amazonaws.emrcontainers#ParametricIAMRoleArn", + "traits": { + "smithy.api#documentation": "

The execution role ARN of the job run.

", + "smithy.api#required": {} + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrcontainers#ParametricReleaseLabel", + "traits": { + "smithy.api#documentation": "

The release version of Amazon EMR.

", + "smithy.api#required": {} + } + }, + "configurationOverrides": { + "target": "com.amazonaws.emrcontainers#ParametricConfigurationOverrides", + "traits": { + "smithy.api#documentation": "

The configuration settings that are used to override defaults configuration.

" + } + }, + "jobDriver": { + "target": "com.amazonaws.emrcontainers#JobDriver", + "traits": { + "smithy.api#required": {} + } + }, + "parameterConfiguration": { + "target": "com.amazonaws.emrcontainers#TemplateParameterConfigurationMap", + "traits": { + "smithy.api#documentation": "

The configuration of parameters existing in the job template.

" + } + }, + "jobTags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to jobs started using the job template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The values of StartJobRun API requests used in job runs started using the job\n template.

" + } + }, + "com.amazonaws.emrcontainers#JobTemplates": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#JobTemplate" + } + }, + "com.amazonaws.emrcontainers#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:(aws[a-zA-Z0-9-]*):kms:.+:(\\d{12})?:key\\/[(0-9a-zA-Z)-?]+|\\$\\{[a-zA-Z]\\w*\\})$" + } + }, + "com.amazonaws.emrcontainers#KubernetesNamespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" + } + }, + "com.amazonaws.emrcontainers#LakeFormationConfiguration": { + "type": "structure", + "members": { + "authorizedSessionTagValue": { + "target": "com.amazonaws.emrcontainers#SessionTagValue", + "traits": { + "smithy.api#documentation": "

The session tag to authorize Amazon EMR on EKS for API calls to Lake Formation.

" + } + }, + "secureNamespaceInfo": { + "target": "com.amazonaws.emrcontainers#SecureNamespaceInfo", + "traits": { + "smithy.api#documentation": "

The namespace input of the system job.

" + } + }, + "queryEngineRoleArn": { + "target": "com.amazonaws.emrcontainers#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

The query engine IAM role ARN that is tied to the secure Spark job. The\n QueryEngine role assumes the JobExecutionRole to execute all\n the Lake Formation calls.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Lake Formation related configuration inputs for the security\n configuration.

" + } + }, + "com.amazonaws.emrcontainers#ListJobRuns": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#ListJobRunsRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#ListJobRunsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists job runs based on a set of parameters. A job run is a unit of work, such as a\n Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

", + "smithy.api#http": { + "method": "GET", + "uri": "/virtualclusters/{virtualClusterId}/jobruns", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "jobRuns", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.emrcontainers#ListJobRunsRequest": { + "type": "structure", + "members": { + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the virtual cluster for which to list the job run.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "createdBefore": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time before which the job runs were submitted.

", + "smithy.api#httpQuery": "createdBefore" + } + }, + "createdAfter": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time after which the job runs were submitted.

", + "smithy.api#httpQuery": "createdAfter" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The name of the job run.

", + "smithy.api#httpQuery": "name" + } + }, + "states": { + "target": "com.amazonaws.emrcontainers#JobRunStates", + "traits": { + "smithy.api#documentation": "

The states of the job run.

", + "smithy.api#httpQuery": "states" + } + }, + "maxResults": { + "target": "com.amazonaws.emrcontainers#JavaInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of job runs that can be listed.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of job runs to return.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#ListJobRunsResponse": { + "type": "structure", + "members": { + "jobRuns": { + "target": "com.amazonaws.emrcontainers#JobRuns", + "traits": { + "smithy.api#documentation": "

This output lists information about the specified job runs.

" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "

This output displays the token for the next set of job runs.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#ListJobTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#ListJobTemplatesRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#ListJobTemplatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists job templates based on a set of parameters. Job template stores values of\n StartJobRun API request in a template and can be used to start a job run. Job template\n allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing\n certain values in StartJobRun API request.

", + "smithy.api#http": { + "method": "GET", + "uri": "/jobtemplates", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "templates", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.emrcontainers#ListJobTemplatesRequest": { + "type": "structure", + "members": { + "createdAfter": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time after which the job templates were created.

", + "smithy.api#httpQuery": "createdAfter" + } + }, + "createdBefore": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time before which the job templates were created.

", + "smithy.api#httpQuery": "createdBefore" + } + }, + "maxResults": { + "target": "com.amazonaws.emrcontainers#JavaInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of job templates that can be listed.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of job templates to return.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#ListJobTemplatesResponse": { + "type": "structure", + "members": { + "templates": { + "target": "com.amazonaws.emrcontainers#JobTemplates", + "traits": { + "smithy.api#documentation": "

This output lists information about the specified job templates.

" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "

This output displays the token for the next set of job templates.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#ListManagedEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#ListManagedEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#ListManagedEndpointsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway\n that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.

", + "smithy.api#http": { + "method": "GET", + "uri": "/virtualclusters/{virtualClusterId}/endpoints", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "endpoints", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.emrcontainers#ListManagedEndpointsRequest": { + "type": "structure", + "members": { + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the virtual cluster.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "createdBefore": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time before which the endpoints are created.

", + "smithy.api#httpQuery": "createdBefore" + } + }, + "createdAfter": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time after which the endpoints are created.

", + "smithy.api#httpQuery": "createdAfter" + } + }, + "types": { + "target": "com.amazonaws.emrcontainers#EndpointTypes", + "traits": { + "smithy.api#documentation": "

The types of the managed endpoints.

", + "smithy.api#httpQuery": "types" + } + }, + "states": { + "target": "com.amazonaws.emrcontainers#EndpointStates", + "traits": { + "smithy.api#documentation": "

The states of the managed endpoints.

", + "smithy.api#httpQuery": "states" + } + }, + "maxResults": { + "target": "com.amazonaws.emrcontainers#JavaInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of managed endpoints that can be listed.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of managed endpoints to return.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#ListManagedEndpointsResponse": { + "type": "structure", + "members": { + "endpoints": { + "target": "com.amazonaws.emrcontainers#Endpoints", + "traits": { + "smithy.api#documentation": "

The managed endpoints to be listed.

" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of endpoints to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#ListSecurityConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#ListSecurityConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#ListSecurityConfigurationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists security configurations based on a set of parameters. Security configurations in\n Amazon EMR on EKS are templates for different security setups. You can use security\n configurations to configure the Lake Formation integration setup. You can also\n create a security configuration to re-use a security setup each time you create a virtual\n cluster.

", + "smithy.api#http": { + "method": "GET", + "uri": "/securityconfigurations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "securityConfigurations", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.emrcontainers#ListSecurityConfigurationsRequest": { + "type": "structure", + "members": { + "createdAfter": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time after which the security configuration was created.

", + "smithy.api#httpQuery": "createdAfter" + } + }, + "createdBefore": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time before which the security configuration was created.

", + "smithy.api#httpQuery": "createdBefore" + } + }, + "maxResults": { + "target": "com.amazonaws.emrcontainers#JavaInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of security configurations the operation can list.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of security configurations to return.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#ListSecurityConfigurationsResponse": { + "type": "structure", + "members": { + "securityConfigurations": { + "target": "com.amazonaws.emrcontainers#SecurityConfigurations", + "traits": { + "smithy.api#documentation": "

The list of returned security configurations.

" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of security configurations to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags assigned to the resources.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.emrcontainers#RsiArn", + "traits": { + "smithy.api#documentation": "

The ARN of tagged resources.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to resources.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#ListVirtualClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#ListVirtualClustersRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#ListVirtualClustersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists information about the specified virtual cluster. Virtual cluster is a managed\n entity on Amazon EMR on EKS. You can create, describe, list and delete virtual\n clusters. They do not consume any additional resource in your system. A single virtual\n cluster maps to a single Kubernetes namespace. Given this relationship, you can model\n virtual clusters the same way you model Kubernetes namespaces to meet your\n requirements.

", + "smithy.api#http": { + "method": "GET", + "uri": "/virtualclusters", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "virtualClusters", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.emrcontainers#ListVirtualClustersRequest": { + "type": "structure", + "members": { + "containerProviderId": { + "target": "com.amazonaws.emrcontainers#String1024", + "traits": { + "smithy.api#documentation": "

The container provider ID of the virtual cluster.

", + "smithy.api#httpQuery": "containerProviderId" + } + }, + "containerProviderType": { + "target": "com.amazonaws.emrcontainers#ContainerProviderType", + "traits": { + "smithy.api#documentation": "

The container provider type of the virtual cluster. Amazon EKS is the only\n supported type as of now.

", + "smithy.api#httpQuery": "containerProviderType" + } + }, + "createdAfter": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time after which the virtual clusters are created.

", + "smithy.api#httpQuery": "createdAfter" + } + }, + "createdBefore": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time before which the virtual clusters are created.

", + "smithy.api#httpQuery": "createdBefore" + } + }, + "states": { + "target": "com.amazonaws.emrcontainers#VirtualClusterStates", + "traits": { + "smithy.api#documentation": "

The states of the requested virtual clusters.

", + "smithy.api#httpQuery": "states" + } + }, + "maxResults": { + "target": "com.amazonaws.emrcontainers#JavaInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of virtual clusters that can be listed.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of virtual clusters to return.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "eksAccessEntryIntegrated": { + "target": "com.amazonaws.emrcontainers#Boolean", + "traits": { + "smithy.api#documentation": "

Optional Boolean that specifies whether the operation should return the \n virtual clusters that have the access entry integration enabled or disabled. If not specified,\n the operation returns all applicable virtual clusters.

", + "smithy.api#httpQuery": "eksAccessEntryIntegrated" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#ListVirtualClustersResponse": { + "type": "structure", + "members": { + "virtualClusters": { + "target": "com.amazonaws.emrcontainers#VirtualClusters", + "traits": { + "smithy.api#documentation": "

This output lists the specified virtual clusters.

" + } + }, + "nextToken": { + "target": "com.amazonaws.emrcontainers#NextToken", + "traits": { + "smithy.api#documentation": "

This output displays the token for the next set of virtual clusters.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#LogContext": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^((?!.*-s3alias)(?!xn--.*)[a-z0-9][-a-z0-9.]*)?[a-z0-9]$" + } + }, + "com.amazonaws.emrcontainers#LogGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" + } + }, + "com.amazonaws.emrcontainers#MaxFilesToKeep": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.emrcontainers#MonitoringConfiguration": { + "type": "structure", + "members": { + "persistentAppUI": { + "target": "com.amazonaws.emrcontainers#PersistentAppUI", + "traits": { + "smithy.api#documentation": "

Monitoring configurations for the persistent application UI.

" + } + }, + "cloudWatchMonitoringConfiguration": { + "target": "com.amazonaws.emrcontainers#CloudWatchMonitoringConfiguration", + "traits": { + "smithy.api#documentation": "

Monitoring configurations for CloudWatch.

" + } + }, + "s3MonitoringConfiguration": { + "target": "com.amazonaws.emrcontainers#S3MonitoringConfiguration", + "traits": { + "smithy.api#documentation": "

Amazon S3 configuration for monitoring log publishing.

" + } + }, + "containerLogRotationConfiguration": { + "target": "com.amazonaws.emrcontainers#ContainerLogRotationConfiguration", + "traits": { + "smithy.api#documentation": "

Enable or disable container log rotation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration setting for monitoring.

" + } + }, + "com.amazonaws.emrcontainers#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.emrcontainers#ParametricCloudWatchMonitoringConfiguration": { + "type": "structure", + "members": { + "logGroupName": { + "target": "com.amazonaws.emrcontainers#TemplateParameter", + "traits": { + "smithy.api#documentation": "

The name of the log group for log publishing.

" + } + }, + "logStreamNamePrefix": { + "target": "com.amazonaws.emrcontainers#String256", + "traits": { + "smithy.api#documentation": "

The specified name prefix for log streams.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A configuration for CloudWatch monitoring. You can configure your jobs to send log\n information to CloudWatch Logs. This data type allows job template parameters to be\n specified within.

" + } + }, + "com.amazonaws.emrcontainers#ParametricConfigurationOverrides": { + "type": "structure", + "members": { + "applicationConfiguration": { + "target": "com.amazonaws.emrcontainers#ConfigurationList", + "traits": { + "smithy.api#documentation": "

The configurations for the application running by the job run.

" + } + }, + "monitoringConfiguration": { + "target": "com.amazonaws.emrcontainers#ParametricMonitoringConfiguration", + "traits": { + "smithy.api#documentation": "

The configurations for monitoring.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A configuration specification to be used to override existing configurations. This data\n type allows job template parameters to be specified within.

" + } + }, + "com.amazonaws.emrcontainers#ParametricIAMRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 2048 + }, + "smithy.api#pattern": "^(^arn:(aws[a-zA-Z0-9-]*):iam::(\\d{12})?:(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)$)|([\\.\\-_\\#A-Za-z0-9\\$\\{\\}]+)$" + } + }, + "com.amazonaws.emrcontainers#ParametricMonitoringConfiguration": { + "type": "structure", + "members": { + "persistentAppUI": { + "target": "com.amazonaws.emrcontainers#TemplateParameter", + "traits": { + "smithy.api#documentation": "

Monitoring configurations for the persistent application UI.

" + } + }, + "cloudWatchMonitoringConfiguration": { + "target": "com.amazonaws.emrcontainers#ParametricCloudWatchMonitoringConfiguration", + "traits": { + "smithy.api#documentation": "

Monitoring configurations for CloudWatch.

" + } + }, + "s3MonitoringConfiguration": { + "target": "com.amazonaws.emrcontainers#ParametricS3MonitoringConfiguration", + "traits": { + "smithy.api#documentation": "

Amazon S3 configuration for monitoring log publishing.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration setting for monitoring. This data type allows job template parameters to\n be specified within.

" + } + }, + "com.amazonaws.emrcontainers#ParametricReleaseLabel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^([\\.\\-_/A-Za-z0-9]+|\\$\\{[a-zA-Z]\\w*\\})$" + } + }, + "com.amazonaws.emrcontainers#ParametricS3MonitoringConfiguration": { + "type": "structure", + "members": { + "logUri": { + "target": "com.amazonaws.emrcontainers#UriString", + "traits": { + "smithy.api#documentation": "

Amazon S3 destination URI for log publishing.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Amazon S3 configuration for monitoring log publishing. You can configure your jobs to\n send log information to Amazon S3. This data type allows job template parameters to be\n specified within.

" + } + }, + "com.amazonaws.emrcontainers#PersistentAppUI": { + "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.emrcontainers#ReleaseLabel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\.\\-_/A-Za-z0-9]+$" + } + }, + "com.amazonaws.emrcontainers#RequestIdentityUserArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):(iam|sts)::(\\d{12})?:[\\w/+=,.@-]+$" + } + }, + "com.amazonaws.emrcontainers#RequestThrottledException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrcontainers#String1024" + } + }, + "traits": { + "smithy.api#documentation": "

The request throttled.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.emrcontainers#ResourceIdString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9a-z]+$" + } + }, + "com.amazonaws.emrcontainers#ResourceNameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" + } + }, + "com.amazonaws.emrcontainers#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrcontainers#String1024" + } + }, + "traits": { + "smithy.api#documentation": "

The specified resource was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.emrcontainers#RetryPolicyConfiguration": { + "type": "structure", + "members": { + "maxAttempts": { + "target": "com.amazonaws.emrcontainers#JavaInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of attempts on the job's driver.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of the retry policy that the job runs on.

" + } + }, + "com.amazonaws.emrcontainers#RetryPolicyExecution": { + "type": "structure", + "members": { + "currentAttemptCount": { + "target": "com.amazonaws.emrcontainers#JavaInteger", + "traits": { + "smithy.api#documentation": "

The current number of attempts made on the driver of the job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The current status of the retry policy executed on the job.

" + } + }, + "com.amazonaws.emrcontainers#RotationSize": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 12 + }, + "smithy.api#pattern": "^\\d+(\\.\\d+)?[KMG][Bb]?$" + } + }, + "com.amazonaws.emrcontainers#RsiArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 60, + "max": 500 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):/virtualclusters/.+$" + } + }, + "com.amazonaws.emrcontainers#S3MonitoringConfiguration": { + "type": "structure", + "members": { + "logUri": { + "target": "com.amazonaws.emrcontainers#UriString", + "traits": { + "smithy.api#documentation": "

Amazon S3 destination URI for log publishing.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Amazon S3 configuration for monitoring log publishing. You can configure your jobs to\n send log information to Amazon S3.

" + } + }, + "com.amazonaws.emrcontainers#SecretsManagerArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):secretsmanager:.+:(\\d{12}):secret:[0-9a-zA-Z/_+=.@-]+$" + } + }, + "com.amazonaws.emrcontainers#SecureNamespaceInfo": { + "type": "structure", + "members": { + "clusterId": { + "target": "com.amazonaws.emrcontainers#ClusterId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon EKS cluster where Amazon EMR on EKS jobs run.

" + } + }, + "namespace": { + "target": "com.amazonaws.emrcontainers#KubernetesNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the Amazon EKS cluster where the system jobs run.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Namespace inputs for the system job.

" + } + }, + "com.amazonaws.emrcontainers#SecurityConfiguration": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the security configuration.

" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The name of the security configuration.

" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#SecurityConfigurationArn", + "traits": { + "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the security configuration.

" + } + }, + "createdAt": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the job run was created.

" + } + }, + "createdBy": { + "target": "com.amazonaws.emrcontainers#RequestIdentityUserArn", + "traits": { + "smithy.api#documentation": "

The user who created the job run.

" + } + }, + "securityConfigurationData": { + "target": "com.amazonaws.emrcontainers#SecurityConfigurationData", + "traits": { + "smithy.api#documentation": "

Security configuration inputs for the request.

" + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The tags to assign to the security configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Inputs related to the security configuration. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security\n configurations to configure the Lake Formation integration setup. You can also\n create a security configuration to re-use a security setup each time you create a virtual\n cluster.

" + } + }, + "com.amazonaws.emrcontainers#SecurityConfigurationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 60, + "max": 1024 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/securityconfigurations\\/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.emrcontainers#SecurityConfigurationData": { + "type": "structure", + "members": { + "authorizationConfiguration": { + "target": "com.amazonaws.emrcontainers#AuthorizationConfiguration", + "traits": { + "smithy.api#documentation": "

Authorization-related configuration input for the security configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configurations related to the security configuration for the request.

" + } + }, + "com.amazonaws.emrcontainers#SecurityConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#SecurityConfiguration" + } + }, + "com.amazonaws.emrcontainers#SensitivePropertiesMap": { + "type": "map", + "key": { + "target": "com.amazonaws.emrcontainers#String1024" + }, + "value": { + "target": "com.amazonaws.emrcontainers#String1024" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrcontainers#SessionTagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9 ]+$" + } + }, + "com.amazonaws.emrcontainers#SparkSqlJobDriver": { + "type": "structure", + "members": { + "entryPoint": { + "target": "com.amazonaws.emrcontainers#EntryPointPath", + "traits": { + "smithy.api#documentation": "

The SQL file to be executed.

" + } + }, + "sparkSqlParameters": { + "target": "com.amazonaws.emrcontainers#SparkSqlParameters", + "traits": { + "smithy.api#documentation": "

The Spark parameters to be included in the Spark SQL command.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The job driver for job type.

" + } + }, + "com.amazonaws.emrcontainers#SparkSqlParameters": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 102400 + }, + "smithy.api#pattern": "\\S", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrcontainers#SparkSubmitJobDriver": { + "type": "structure", + "members": { + "entryPoint": { + "target": "com.amazonaws.emrcontainers#EntryPointPath", + "traits": { + "smithy.api#documentation": "

The entry point of job application.

", + "smithy.api#required": {} + } + }, + "entryPointArguments": { + "target": "com.amazonaws.emrcontainers#EntryPointArguments", + "traits": { + "smithy.api#documentation": "

The arguments for job application.

" + } + }, + "sparkSubmitParameters": { + "target": "com.amazonaws.emrcontainers#SparkSubmitParameters", + "traits": { + "smithy.api#documentation": "

The Spark submit parameters that are used for job runs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The information about job driver for Spark submit.

" + } + }, + "com.amazonaws.emrcontainers#SparkSubmitParameters": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 102400 + }, + "smithy.api#pattern": "\\S", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrcontainers#StartJobRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#StartJobRunRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#StartJobRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or\n SparkSQL query, that you submit to Amazon EMR on EKS.

", + "smithy.api#http": { + "method": "POST", + "uri": "/virtualclusters/{virtualClusterId}/jobruns", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#StartJobRunRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The name of the job run.

" + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The virtual cluster ID for which the job run request is submitted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.emrcontainers#ClientToken", + "traits": { + "smithy.api#documentation": "

The client idempotency token of the job run request.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "executionRoleArn": { + "target": "com.amazonaws.emrcontainers#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

The execution role ARN for the job run.

" + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrcontainers#ReleaseLabel", + "traits": { + "smithy.api#documentation": "

The Amazon EMR release version to use for the job run.

" + } + }, + "jobDriver": { + "target": "com.amazonaws.emrcontainers#JobDriver", + "traits": { + "smithy.api#documentation": "

The job driver for the job run.

" + } + }, + "configurationOverrides": { + "target": "com.amazonaws.emrcontainers#ConfigurationOverrides", + "traits": { + "smithy.api#documentation": "

The configuration overrides for the job run.

" + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to job runs.

" + } + }, + "jobTemplateId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The job template ID to be used to start the job run.

" + } + }, + "jobTemplateParameters": { + "target": "com.amazonaws.emrcontainers#TemplateParameterInputMap", + "traits": { + "smithy.api#documentation": "

The values of job template parameters to start a job run.

" + } + }, + "retryPolicyConfiguration": { + "target": "com.amazonaws.emrcontainers#RetryPolicyConfiguration", + "traits": { + "smithy.api#documentation": "

The retry policy configuration for the job run.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#StartJobRunResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

This output displays the started job run ID.

" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

This output displays the name of the started job run.

" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#JobArn", + "traits": { + "smithy.api#documentation": "

This output lists the ARN of job run.

" + } + }, + "virtualClusterId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

This output displays the virtual cluster ID for which the job run was submitted.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#String1024": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.emrcontainers#String128": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.emrcontainers#String2048": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.emrcontainers#String256": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.emrcontainers#StringEmpty256": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.emrcontainers#SubnetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#String256" + } + }, + "com.amazonaws.emrcontainers#TLSCertificateConfiguration": { + "type": "structure", + "members": { + "certificateProviderType": { + "target": "com.amazonaws.emrcontainers#CertificateProviderType", + "traits": { + "smithy.api#documentation": "

The TLS certificate type. Acceptable values: PEM or\n Custom.

" + } + }, + "publicCertificateSecretArn": { + "target": "com.amazonaws.emrcontainers#SecretsManagerArn", + "traits": { + "smithy.api#documentation": "

Secrets Manager ARN that contains the public TLS certificate contents, used for\n communication between the user job and the system job.

" + } + }, + "privateCertificateSecretArn": { + "target": "com.amazonaws.emrcontainers#SecretsManagerArn", + "traits": { + "smithy.api#documentation": "

Secrets Manager ARN that contains the private TLS certificate contents, used for\n communication between the user job and the system job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configurations related to the TLS certificate for the security configuration.

" + } + }, + "com.amazonaws.emrcontainers#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#String128" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.emrcontainers#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.emrcontainers#String128" + }, + "value": { + "target": "com.amazonaws.emrcontainers#StringEmpty256" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.emrcontainers#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Assigns tags to resources. A tag is a label that you assign to an Amazon Web Services\n resource. Each tag consists of a key and an optional value, both of which you define. Tags\n enable you to categorize your Amazon Web Services resources by attributes such as purpose,\n owner, or environment. When you have many resources of the same type, you can quickly\n identify a specific resource based on the tags you've assigned to it. For example, you can\n define a set of tags for your Amazon EMR on EKS clusters to help you track each\n cluster's owner and stack level. We recommend that you devise a consistent set of tag keys\n for each resource type. You can then search and filter the resources based on the tags that\n you add.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.emrcontainers#RsiArn", + "traits": { + "smithy.api#documentation": "

The ARN of resources.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to resources.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#TemplateParameter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9\\$\\{\\}]+$" + } + }, + "com.amazonaws.emrcontainers#TemplateParameterConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.emrcontainers#TemplateParameterDataType", + "traits": { + "smithy.api#documentation": "

The type of the job template parameter. Allowed values are: ‘STRING’, ‘NUMBER’.

" + } + }, + "defaultValue": { + "target": "com.amazonaws.emrcontainers#String1024", + "traits": { + "smithy.api#documentation": "

The default value for the job template parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a job template parameter.

" + } + }, + "com.amazonaws.emrcontainers#TemplateParameterConfigurationMap": { + "type": "map", + "key": { + "target": "com.amazonaws.emrcontainers#TemplateParameterName" + }, + "value": { + "target": "com.amazonaws.emrcontainers#TemplateParameterConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.emrcontainers#TemplateParameterDataType": { + "type": "enum", + "members": { + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMBER" + } + }, + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + } + } + }, + "com.amazonaws.emrcontainers#TemplateParameterInputMap": { + "type": "map", + "key": { + "target": "com.amazonaws.emrcontainers#TemplateParameterName" + }, + "value": { + "target": "com.amazonaws.emrcontainers#String1024" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.emrcontainers#TemplateParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[\\.\\-_\\#A-Za-z0-9]+$" + } + }, + "com.amazonaws.emrcontainers#Token": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^.*\\S.*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrcontainers#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrcontainers#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.emrcontainers#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrcontainers#InternalServerException" + }, + { + "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrcontainers#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes tags from resources.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.emrcontainers#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.emrcontainers#RsiArn", + "traits": { + "smithy.api#documentation": "

The ARN of resources.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.emrcontainers#TagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys of the resources.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrcontainers#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.emrcontainers#UriString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10280 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.emrcontainers#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrcontainers#String1024" + } + }, + "traits": { + "smithy.api#documentation": "

There are invalid parameters in the client request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.emrcontainers#VirtualCluster": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the virtual cluster.

" + } + }, + "name": { + "target": "com.amazonaws.emrcontainers#ResourceNameString", + "traits": { + "smithy.api#documentation": "

The name of the virtual cluster.

" + } + }, + "arn": { + "target": "com.amazonaws.emrcontainers#VirtualClusterArn", + "traits": { + "smithy.api#documentation": "

The ARN of the virtual cluster.

" + } + }, + "state": { + "target": "com.amazonaws.emrcontainers#VirtualClusterState", + "traits": { + "smithy.api#documentation": "

The state of the virtual cluster.

" + } + }, + "containerProvider": { + "target": "com.amazonaws.emrcontainers#ContainerProvider", + "traits": { + "smithy.api#documentation": "

The container provider of the virtual cluster.

" + } + }, + "createdAt": { + "target": "com.amazonaws.emrcontainers#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the virtual cluster is created.

" + } + }, + "tags": { + "target": "com.amazonaws.emrcontainers#TagMap", + "traits": { + "smithy.api#documentation": "

The assigned tags of the virtual cluster.

" + } + }, + "securityConfigurationId": { + "target": "com.amazonaws.emrcontainers#ResourceIdString", + "traits": { + "smithy.api#documentation": "

The ID of the security configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This entity describes a virtual cluster. A virtual cluster is a Kubernetes namespace\n that Amazon EMR is registered with. Amazon EMR uses virtual clusters to run\n jobs and host endpoints. Multiple virtual clusters can be backed by the same physical\n cluster. However, each virtual cluster maps to one namespace on an Amazon EKS\n cluster. Virtual clusters do not create any active resources that contribute to your bill\n or that require lifecycle management outside the service.

" + } + }, + "com.amazonaws.emrcontainers#VirtualClusterArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 60, + "max": 1024 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/virtualclusters\\/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.emrcontainers#VirtualClusterState": { + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "TERMINATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATING" + } + }, + "TERMINATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERMINATED" + } + }, + "ARRESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARRESTED" + } + } + } + }, + "com.amazonaws.emrcontainers#VirtualClusterStates": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#VirtualClusterState" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.emrcontainers#VirtualClusters": { + "type": "list", + "member": { + "target": "com.amazonaws.emrcontainers#VirtualCluster" } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.emrcontainers#Base64Encoded": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5000 - }, - "smithy.api#pattern": "^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$" - } - }, - "com.amazonaws.emrcontainers#Boolean": { - "type": "boolean" - }, - "com.amazonaws.emrcontainers#CancelJobRun": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrcontainers#CancelJobRunRequest" - }, - "output": { - "target": "com.amazonaws.emrcontainers#CancelJobRunResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrcontainers#InternalServerException" - }, - { - "target": "com.amazonaws.emrcontainers#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Cancels a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or\n SparkSQL query, that you submit to Amazon EMR on EKS.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/virtualclusters/{virtualClusterId}/jobruns/{id}", - "code": 200 - } - } - }, - "com.amazonaws.emrcontainers#CancelJobRunRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the job run to cancel.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "virtualClusterId": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the virtual cluster for which the job run will be canceled.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.emrcontainers#CancelJobRunResponse": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The output contains the ID of the cancelled job run.

" - } - }, - "virtualClusterId": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The output contains the virtual cluster ID for which the job run is cancelled.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.emrcontainers#Certificate": { - "type": "structure", - "members": { - "certificateArn": { - "target": "com.amazonaws.emrcontainers#ACMCertArn", - "traits": { - "smithy.api#documentation": "

The ARN of the certificate generated for managed endpoint.

" - } - }, - "certificateData": { - "target": "com.amazonaws.emrcontainers#Base64Encoded", - "traits": { - "smithy.api#documentation": "

The base64 encoded PEM certificate data generated for managed endpoint.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The entity representing certificate data generated for managed endpoint.

" - } - }, - "com.amazonaws.emrcontainers#CertificateProviderType": { - "type": "enum", - "members": { - "PEM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PEM" - } - } - } - }, - "com.amazonaws.emrcontainers#ClientToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.emrcontainers#CloudWatchMonitoringConfiguration": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.emrcontainers#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group for log publishing.

", - "smithy.api#required": {} - } - }, - "logStreamNamePrefix": { - "target": "com.amazonaws.emrcontainers#String256", - "traits": { - "smithy.api#documentation": "

The specified name prefix for log streams.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A configuration for CloudWatch monitoring. You can configure your jobs to send log\n information to CloudWatch Logs.

" - } - }, - "com.amazonaws.emrcontainers#ClusterId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^[0-9A-Za-z][A-Za-z0-9\\-_]*$" - } - }, - "com.amazonaws.emrcontainers#Configuration": { - "type": "structure", - "members": { - "classification": { - "target": "com.amazonaws.emrcontainers#String1024", - "traits": { - "smithy.api#documentation": "

The classification within a configuration.

", - "smithy.api#required": {} - } - }, - "properties": { - "target": "com.amazonaws.emrcontainers#SensitivePropertiesMap", - "traits": { - "smithy.api#documentation": "

A set of properties specified within a configuration classification.

" - } - }, - "configurations": { - "target": "com.amazonaws.emrcontainers#ConfigurationList", - "traits": { - "smithy.api#documentation": "

A list of additional configurations to apply within a configuration object.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A configuration specification to be used when provisioning virtual clusters, which can\n include configurations for applications and software bundled with Amazon EMR on EKS. A\n configuration consists of a classification, properties, and optional nested configurations.\n A classification refers to an application-specific configuration file. Properties are the\n settings you want to change in that file.

" - } - }, - "com.amazonaws.emrcontainers#ConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.emrcontainers#Configuration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.emrcontainers#ConfigurationOverrides": { - "type": "structure", - "members": { - "applicationConfiguration": { - "target": "com.amazonaws.emrcontainers#ConfigurationList", - "traits": { - "smithy.api#documentation": "

The configurations for the application running by the job run.

" - } - }, - "monitoringConfiguration": { - "target": "com.amazonaws.emrcontainers#MonitoringConfiguration", - "traits": { - "smithy.api#documentation": "

The configurations for monitoring.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A configuration specification to be used to override existing configurations.

" - } - }, - "com.amazonaws.emrcontainers#ContainerInfo": { - "type": "union", - "members": { - "eksInfo": { - "target": "com.amazonaws.emrcontainers#EksInfo", - "traits": { - "smithy.api#documentation": "

The information about the Amazon EKS cluster.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The information about the container used for a job run or a managed endpoint.

" - } - }, - "com.amazonaws.emrcontainers#ContainerLogRotationConfiguration": { - "type": "structure", - "members": { - "rotationSize": { - "target": "com.amazonaws.emrcontainers#RotationSize", - "traits": { - "smithy.api#documentation": "

The file size at which to rotate logs. Minimum of 2KB, Maximum of 2GB.

", - "smithy.api#required": {} - } - }, - "maxFilesToKeep": { - "target": "com.amazonaws.emrcontainers#MaxFilesToKeep", - "traits": { - "smithy.api#documentation": "

The number of files to keep in container after rotation.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The settings for container log rotation.

" - } - }, - "com.amazonaws.emrcontainers#ContainerProvider": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.emrcontainers#ContainerProviderType", - "traits": { - "smithy.api#documentation": "

The type of the container provider. Amazon EKS is the only supported type as of\n now.

", - "smithy.api#required": {} - } - }, - "id": { - "target": "com.amazonaws.emrcontainers#ClusterId", - "traits": { - "smithy.api#documentation": "

The ID of the container cluster.

", - "smithy.api#required": {} - } - }, - "info": { - "target": "com.amazonaws.emrcontainers#ContainerInfo", - "traits": { - "smithy.api#documentation": "

The information about the container cluster.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The information about the container provider.

" - } - }, - "com.amazonaws.emrcontainers#ContainerProviderType": { - "type": "enum", - "members": { - "EKS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EKS" - } - } - } - }, - "com.amazonaws.emrcontainers#CreateJobTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrcontainers#CreateJobTemplateRequest" - }, - "output": { - "target": "com.amazonaws.emrcontainers#CreateJobTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrcontainers#InternalServerException" - }, - { - "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrcontainers#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a job template. Job template stores values of StartJobRun API request in a\n template and can be used to start a job run. Job template allows two use cases: avoid\n repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun\n API request.

", - "smithy.api#http": { - "method": "POST", - "uri": "/jobtemplates", - "code": 200 - } - } - }, - "com.amazonaws.emrcontainers#CreateJobTemplateRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.emrcontainers#ResourceNameString", - "traits": { - "smithy.api#documentation": "

The specified name of the job template.

", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.emrcontainers#ClientToken", - "traits": { - "smithy.api#documentation": "

The client token of the job template.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "jobTemplateData": { - "target": "com.amazonaws.emrcontainers#JobTemplateData", - "traits": { - "smithy.api#documentation": "

The job template data which holds values of StartJobRun API request.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.emrcontainers#TagMap", - "traits": { - "smithy.api#documentation": "

The tags that are associated with the job template.

" - } - }, - "kmsKeyArn": { - "target": "com.amazonaws.emrcontainers#KmsKeyArn", - "traits": { - "smithy.api#documentation": "

The KMS key ARN used to encrypt the job template.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.emrcontainers#CreateJobTemplateResponse": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

This output display the created job template ID.

" - } - }, - "name": { - "target": "com.amazonaws.emrcontainers#ResourceNameString", - "traits": { - "smithy.api#documentation": "

This output displays the name of the created job template.

" - } - }, - "arn": { - "target": "com.amazonaws.emrcontainers#JobTemplateArn", - "traits": { - "smithy.api#documentation": "

This output display the ARN of the created job template.

" - } - }, - "createdAt": { - "target": "com.amazonaws.emrcontainers#Date", - "traits": { - "smithy.api#documentation": "

This output displays the date and time when the job template was created.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.emrcontainers#CreateManagedEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrcontainers#CreateManagedEndpointRequest" - }, - "output": { - "target": "com.amazonaws.emrcontainers#CreateManagedEndpointResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrcontainers#InternalServerException" - }, - { - "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrcontainers#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can\n communicate with your virtual cluster.

", - "smithy.api#http": { - "method": "POST", - "uri": "/virtualclusters/{virtualClusterId}/endpoints", - "code": 200 - } - } - }, - "com.amazonaws.emrcontainers#CreateManagedEndpointRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.emrcontainers#ResourceNameString", - "traits": { - "smithy.api#documentation": "

The name of the managed endpoint.

", - "smithy.api#required": {} - } - }, - "virtualClusterId": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the virtual cluster for which a managed endpoint is created.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.emrcontainers#EndpointType", - "traits": { - "smithy.api#documentation": "

The type of the managed endpoint.

", - "smithy.api#required": {} - } - }, - "releaseLabel": { - "target": "com.amazonaws.emrcontainers#ReleaseLabel", - "traits": { - "smithy.api#documentation": "

The Amazon EMR release version.

", - "smithy.api#required": {} - } - }, - "executionRoleArn": { - "target": "com.amazonaws.emrcontainers#IAMRoleArn", - "traits": { - "smithy.api#documentation": "

The ARN of the execution role.

", - "smithy.api#required": {} - } - }, - "certificateArn": { - "target": "com.amazonaws.emrcontainers#ACMCertArn", - "traits": { - "smithy.api#deprecated": { - "message": "Customer provided certificate-arn is deprecated and would be removed in future." - }, - "smithy.api#documentation": "

The certificate ARN provided by users for the managed endpoint. This field is under\n deprecation and will be removed in future releases.

" - } - }, - "configurationOverrides": { - "target": "com.amazonaws.emrcontainers#ConfigurationOverrides", - "traits": { - "smithy.api#documentation": "

The configuration settings that will be used to override existing configurations.

" - } - }, - "clientToken": { - "target": "com.amazonaws.emrcontainers#ClientToken", - "traits": { - "smithy.api#documentation": "

The client idempotency token for this create call.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.emrcontainers#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the managed endpoint.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.emrcontainers#CreateManagedEndpointResponse": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The output contains the ID of the managed endpoint.

" - } - }, - "name": { - "target": "com.amazonaws.emrcontainers#ResourceNameString", - "traits": { - "smithy.api#documentation": "

The output contains the name of the managed endpoint.

" - } - }, - "arn": { - "target": "com.amazonaws.emrcontainers#EndpointArn", - "traits": { - "smithy.api#documentation": "

The output contains the ARN of the managed endpoint.

" - } - }, - "virtualClusterId": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The output contains the ID of the virtual cluster.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.emrcontainers#CreateSecurityConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrcontainers#CreateSecurityConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.emrcontainers#CreateSecurityConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrcontainers#InternalServerException" - }, - { - "target": "com.amazonaws.emrcontainers#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a security configuration. Security configurations in Amazon EMR on EKS are\n templates for different security setups. You can use security configurations to configure\n the Lake Formation integration setup. You can also create a security configuration\n to re-use a security setup each time you create a virtual cluster.

", - "smithy.api#http": { - "method": "POST", - "uri": "/securityconfigurations", - "code": 200 - } - } - }, - "com.amazonaws.emrcontainers#CreateSecurityConfigurationRequest": { - "type": "structure", - "members": { - "clientToken": { - "target": "com.amazonaws.emrcontainers#ClientToken", - "traits": { - "smithy.api#documentation": "

The client idempotency token to use when creating the security configuration.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.emrcontainers#ResourceNameString", - "traits": { - "smithy.api#documentation": "

The name of the security configuration.

", - "smithy.api#required": {} - } - }, - "securityConfigurationData": { - "target": "com.amazonaws.emrcontainers#SecurityConfigurationData", - "traits": { - "smithy.api#documentation": "

Security configuration input for the request.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.emrcontainers#TagMap", - "traits": { - "smithy.api#documentation": "

The tags to add to the security configuration.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.emrcontainers#CreateSecurityConfigurationResponse": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the security configuration.

" - } - }, - "name": { - "target": "com.amazonaws.emrcontainers#ResourceNameString", - "traits": { - "smithy.api#documentation": "

The name of the security configuration.

" - } - }, - "arn": { - "target": "com.amazonaws.emrcontainers#SecurityConfigurationArn", - "traits": { - "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the security configuration.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.emrcontainers#CreateVirtualCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrcontainers#CreateVirtualClusterRequest" - }, - "output": { - "target": "com.amazonaws.emrcontainers#CreateVirtualClusterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrcontainers#EKSRequestThrottledException" - }, - { - "target": "com.amazonaws.emrcontainers#InternalServerException" - }, - { - "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrcontainers#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any\n additional resource in your system. A single virtual cluster maps to a single Kubernetes\n namespace. Given this relationship, you can model virtual clusters the same way you model\n Kubernetes namespaces to meet your requirements.

", - "smithy.api#http": { - "method": "POST", - "uri": "/virtualclusters", - "code": 200 - } - } - }, - "com.amazonaws.emrcontainers#CreateVirtualClusterRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.emrcontainers#ResourceNameString", - "traits": { - "smithy.api#documentation": "

The specified name of the virtual cluster.

", - "smithy.api#required": {} - } - }, - "containerProvider": { - "target": "com.amazonaws.emrcontainers#ContainerProvider", - "traits": { - "smithy.api#documentation": "

The container provider of the virtual cluster.

", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.emrcontainers#ClientToken", - "traits": { - "smithy.api#documentation": "

The client token of the virtual cluster.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.emrcontainers#TagMap", - "traits": { - "smithy.api#documentation": "

The tags assigned to the virtual cluster.

" - } - }, - "securityConfigurationId": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the security configuration.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.emrcontainers#CreateVirtualClusterResponse": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

This output contains the virtual cluster ID.

" - } - }, - "name": { - "target": "com.amazonaws.emrcontainers#ResourceNameString", - "traits": { - "smithy.api#documentation": "

This output contains the name of the virtual cluster.

" - } - }, - "arn": { - "target": "com.amazonaws.emrcontainers#VirtualClusterArn", - "traits": { - "smithy.api#documentation": "

This output contains the ARN of virtual cluster.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.emrcontainers#CredentialType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^.*\\S.*$" - } - }, - "com.amazonaws.emrcontainers#Credentials": { - "type": "union", - "members": { - "token": { - "target": "com.amazonaws.emrcontainers#Token", - "traits": { - "smithy.api#documentation": "

The actual session token being returned.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The structure containing the session token being returned.

" - } - }, - "com.amazonaws.emrcontainers#Date": { - "type": "timestamp", - "traits": { - "smithy.api#timestampFormat": "date-time" - } - }, - "com.amazonaws.emrcontainers#DeleteJobTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrcontainers#DeleteJobTemplateRequest" - }, - "output": { - "target": "com.amazonaws.emrcontainers#DeleteJobTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrcontainers#InternalServerException" - }, - { - "target": "com.amazonaws.emrcontainers#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a job template. Job template stores values of StartJobRun API request in a\n template and can be used to start a job run. Job template allows two use cases: avoid\n repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun\n API request.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/jobtemplates/{id}", - "code": 200 - } - } - }, - "com.amazonaws.emrcontainers#DeleteJobTemplateRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the job template that will be deleted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.emrcontainers#DeleteJobTemplateResponse": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

This output contains the ID of the job template that was deleted.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.emrcontainers#DeleteManagedEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrcontainers#DeleteManagedEndpointRequest" - }, - "output": { - "target": "com.amazonaws.emrcontainers#DeleteManagedEndpointResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrcontainers#InternalServerException" - }, - { - "target": "com.amazonaws.emrcontainers#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can\n communicate with your virtual cluster.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/virtualclusters/{virtualClusterId}/endpoints/{id}", - "code": 200 - } - } - }, - "com.amazonaws.emrcontainers#DeleteManagedEndpointRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the managed endpoint.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "virtualClusterId": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the endpoint's virtual cluster.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.emrcontainers#DeleteManagedEndpointResponse": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The output displays the ID of the managed endpoint.

" - } - }, - "virtualClusterId": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The output displays the ID of the endpoint's virtual cluster.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.emrcontainers#DeleteVirtualCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrcontainers#DeleteVirtualClusterRequest" - }, - "output": { - "target": "com.amazonaws.emrcontainers#DeleteVirtualClusterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrcontainers#InternalServerException" - }, - { - "target": "com.amazonaws.emrcontainers#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any\n additional resource in your system. A single virtual cluster maps to a single Kubernetes\n namespace. Given this relationship, you can model virtual clusters the same way you model\n Kubernetes namespaces to meet your requirements.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/virtualclusters/{id}", - "code": 200 - } - } - }, - "com.amazonaws.emrcontainers#DeleteVirtualClusterRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the virtual cluster that will be deleted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.emrcontainers#DeleteVirtualClusterResponse": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

This output contains the ID of the virtual cluster that will be deleted.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.emrcontainers#DescribeJobRun": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrcontainers#DescribeJobRunRequest" - }, - "output": { - "target": "com.amazonaws.emrcontainers#DescribeJobRunResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrcontainers#InternalServerException" - }, - { - "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrcontainers#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Displays detailed information about a job run. A job run is a unit of work, such as a\n Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

", - "smithy.api#http": { - "method": "GET", - "uri": "/virtualclusters/{virtualClusterId}/jobruns/{id}", - "code": 200 - } - } - }, - "com.amazonaws.emrcontainers#DescribeJobRunRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the job run request.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "virtualClusterId": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the virtual cluster for which the job run is submitted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.emrcontainers#DescribeJobRunResponse": { - "type": "structure", - "members": { - "jobRun": { - "target": "com.amazonaws.emrcontainers#JobRun", - "traits": { - "smithy.api#documentation": "

The output displays information about a job run.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.emrcontainers#DescribeJobTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrcontainers#DescribeJobTemplateRequest" - }, - "output": { - "target": "com.amazonaws.emrcontainers#DescribeJobTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrcontainers#InternalServerException" - }, - { - "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrcontainers#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Displays detailed information about a specified job template. Job template stores values\n of StartJobRun API request in a template and can be used to start a job run. Job template\n allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing\n certain values in StartJobRun API request.

", - "smithy.api#http": { - "method": "GET", - "uri": "/jobtemplates/{id}", - "code": 200 - } - } - }, - "com.amazonaws.emrcontainers#DescribeJobTemplateRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the job template that will be described.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.emrcontainers#DescribeJobTemplateResponse": { - "type": "structure", - "members": { - "jobTemplate": { - "target": "com.amazonaws.emrcontainers#JobTemplate", - "traits": { - "smithy.api#documentation": "

This output displays information about the specified job template.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.emrcontainers#DescribeManagedEndpoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrcontainers#DescribeManagedEndpointRequest" - }, - "output": { - "target": "com.amazonaws.emrcontainers#DescribeManagedEndpointResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrcontainers#InternalServerException" - }, - { - "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrcontainers#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Displays detailed information about a managed endpoint. A managed endpoint is a gateway\n that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.

", - "smithy.api#http": { - "method": "GET", - "uri": "/virtualclusters/{virtualClusterId}/endpoints/{id}", - "code": 200 - } - } - }, - "com.amazonaws.emrcontainers#DescribeManagedEndpointRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

This output displays ID of the managed endpoint.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "virtualClusterId": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the endpoint's virtual cluster.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.emrcontainers#DescribeManagedEndpointResponse": { - "type": "structure", - "members": { - "endpoint": { - "target": "com.amazonaws.emrcontainers#Endpoint", - "traits": { - "smithy.api#documentation": "

This output displays information about a managed endpoint.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.emrcontainers#DescribeSecurityConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrcontainers#DescribeSecurityConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.emrcontainers#DescribeSecurityConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrcontainers#InternalServerException" - }, - { - "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrcontainers#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Displays detailed information about a specified security configuration. Security\n configurations in Amazon EMR on EKS are templates for different security setups. You\n can use security configurations to configure the Lake Formation integration setup.\n You can also create a security configuration to re-use a security setup each time you\n create a virtual cluster.

", - "smithy.api#http": { - "method": "GET", - "uri": "/securityconfigurations/{id}", - "code": 200 - } - } - }, - "com.amazonaws.emrcontainers#DescribeSecurityConfigurationRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the security configuration.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.emrcontainers#DescribeSecurityConfigurationResponse": { - "type": "structure", - "members": { - "securityConfiguration": { - "target": "com.amazonaws.emrcontainers#SecurityConfiguration", - "traits": { - "smithy.api#documentation": "

Details of the security configuration.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.emrcontainers#DescribeVirtualCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrcontainers#DescribeVirtualClusterRequest" - }, - "output": { - "target": "com.amazonaws.emrcontainers#DescribeVirtualClusterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrcontainers#InternalServerException" - }, - { - "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrcontainers#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Displays detailed information about a specified virtual cluster. Virtual cluster is a\n managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual\n clusters. They do not consume any additional resource in your system. A single virtual\n cluster maps to a single Kubernetes namespace. Given this relationship, you can model\n virtual clusters the same way you model Kubernetes namespaces to meet your\n requirements.

", - "smithy.api#http": { - "method": "GET", - "uri": "/virtualclusters/{id}", - "code": 200 - } - } - }, - "com.amazonaws.emrcontainers#DescribeVirtualClusterRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the virtual cluster that will be described.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.emrcontainers#DescribeVirtualClusterResponse": { - "type": "structure", - "members": { - "virtualCluster": { - "target": "com.amazonaws.emrcontainers#VirtualCluster", - "traits": { - "smithy.api#documentation": "

This output displays information about the specified virtual cluster.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.emrcontainers#EKSRequestThrottledException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.emrcontainers#String1024" - } - }, - "traits": { - "smithy.api#documentation": "

The request exceeded the Amazon EKS API operation limits.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.emrcontainers#EksInfo": { - "type": "structure", - "members": { - "namespace": { - "target": "com.amazonaws.emrcontainers#KubernetesNamespace", - "traits": { - "smithy.api#documentation": "

The namespaces of the Amazon EKS cluster.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The information about the Amazon EKS cluster.

" - } - }, - "com.amazonaws.emrcontainers#EncryptionConfiguration": { - "type": "structure", - "members": { - "inTransitEncryptionConfiguration": { - "target": "com.amazonaws.emrcontainers#InTransitEncryptionConfiguration", - "traits": { - "smithy.api#documentation": "

In-transit encryption-related input for the security configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configurations related to encryption for the security configuration.

" - } - }, - "com.amazonaws.emrcontainers#Endpoint": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the endpoint.

" - } - }, - "name": { - "target": "com.amazonaws.emrcontainers#ResourceNameString", - "traits": { - "smithy.api#documentation": "

The name of the endpoint.

" - } - }, - "arn": { - "target": "com.amazonaws.emrcontainers#EndpointArn", - "traits": { - "smithy.api#documentation": "

The ARN of the endpoint.

" - } - }, - "virtualClusterId": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the endpoint's virtual cluster.

" - } - }, - "type": { - "target": "com.amazonaws.emrcontainers#EndpointType", - "traits": { - "smithy.api#documentation": "

The type of the endpoint.

" - } - }, - "state": { - "target": "com.amazonaws.emrcontainers#EndpointState", - "traits": { - "smithy.api#documentation": "

The state of the endpoint.

" - } - }, - "releaseLabel": { - "target": "com.amazonaws.emrcontainers#ReleaseLabel", - "traits": { - "smithy.api#documentation": "

The EMR release version to be used for the endpoint.

" - } - }, - "executionRoleArn": { - "target": "com.amazonaws.emrcontainers#IAMRoleArn", - "traits": { - "smithy.api#documentation": "

The execution role ARN of the endpoint.

" - } - }, - "certificateArn": { - "target": "com.amazonaws.emrcontainers#ACMCertArn", - "traits": { - "smithy.api#deprecated": { - "message": "Customer provided certificate-arn is deprecated and would be removed in future." - }, - "smithy.api#documentation": "

The certificate ARN of the endpoint. This field is under deprecation and will be removed\n in future.

" - } - }, - "certificateAuthority": { - "target": "com.amazonaws.emrcontainers#Certificate", - "traits": { - "smithy.api#documentation": "

The certificate generated by emr control plane on customer behalf to secure the managed\n endpoint.

" - } - }, - "configurationOverrides": { - "target": "com.amazonaws.emrcontainers#ConfigurationOverrides", - "traits": { - "smithy.api#documentation": "

The configuration settings that are used to override existing configurations for\n endpoints.

" - } - }, - "serverUrl": { - "target": "com.amazonaws.emrcontainers#UriString", - "traits": { - "smithy.api#documentation": "

The server URL of the endpoint.

" - } - }, - "createdAt": { - "target": "com.amazonaws.emrcontainers#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the endpoint was created.

" - } - }, - "securityGroup": { - "target": "com.amazonaws.emrcontainers#String256", - "traits": { - "smithy.api#documentation": "

The security group configuration of the endpoint.

" - } - }, - "subnetIds": { - "target": "com.amazonaws.emrcontainers#SubnetIds", - "traits": { - "smithy.api#documentation": "

The subnet IDs of the endpoint.

" - } - }, - "stateDetails": { - "target": "com.amazonaws.emrcontainers#String256", - "traits": { - "smithy.api#documentation": "

Additional details of the endpoint state.

" - } - }, - "failureReason": { - "target": "com.amazonaws.emrcontainers#FailureReason", - "traits": { - "smithy.api#documentation": "

The reasons why the endpoint has failed.

" - } - }, - "tags": { - "target": "com.amazonaws.emrcontainers#TagMap", - "traits": { - "smithy.api#documentation": "

The tags of the endpoint.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This entity represents the endpoint that is managed by Amazon EMR on EKS.

" - } - }, - "com.amazonaws.emrcontainers#EndpointArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 60, - "max": 1024 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/virtualclusters\\/[0-9a-zA-Z]+\\/endpoints\\/[0-9a-zA-Z]+$" - } - }, - "com.amazonaws.emrcontainers#EndpointState": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "TERMINATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TERMINATING" - } - }, - "TERMINATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TERMINATED" - } - }, - "TERMINATED_WITH_ERRORS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TERMINATED_WITH_ERRORS" - } - } - } - }, - "com.amazonaws.emrcontainers#EndpointStates": { - "type": "list", - "member": { - "target": "com.amazonaws.emrcontainers#EndpointState" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.emrcontainers#EndpointType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.emrcontainers#EndpointTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.emrcontainers#EndpointType" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.emrcontainers#Endpoints": { - "type": "list", - "member": { - "target": "com.amazonaws.emrcontainers#Endpoint" - } - }, - "com.amazonaws.emrcontainers#EntryPointArgument": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10280 - }, - "smithy.api#pattern": "\\S", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.emrcontainers#EntryPointArguments": { - "type": "list", - "member": { - "target": "com.amazonaws.emrcontainers#EntryPointArgument" - } - }, - "com.amazonaws.emrcontainers#EntryPointPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "\\S", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.emrcontainers#FailureReason": { - "type": "enum", - "members": { - "INTERNAL_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_ERROR" - } - }, - "USER_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "USER_ERROR" - } - }, - "VALIDATION_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VALIDATION_ERROR" - } - }, - "CLUSTER_UNAVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLUSTER_UNAVAILABLE" - } - } - } - }, - "com.amazonaws.emrcontainers#GetManagedEndpointSessionCredentials": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrcontainers#GetManagedEndpointSessionCredentialsRequest" - }, - "output": { - "target": "com.amazonaws.emrcontainers#GetManagedEndpointSessionCredentialsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrcontainers#InternalServerException" - }, - { - "target": "com.amazonaws.emrcontainers#RequestThrottledException" - }, - { - "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrcontainers#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Generate a session token to connect to a managed endpoint.

", - "smithy.api#http": { - "method": "POST", - "uri": "/virtualclusters/{virtualClusterIdentifier}/endpoints/{endpointIdentifier}/credentials", - "code": 200 - } - } - }, - "com.amazonaws.emrcontainers#GetManagedEndpointSessionCredentialsRequest": { - "type": "structure", - "members": { - "endpointIdentifier": { - "target": "com.amazonaws.emrcontainers#String2048", - "traits": { - "smithy.api#documentation": "

The ARN of the managed endpoint for which the request is submitted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "virtualClusterIdentifier": { - "target": "com.amazonaws.emrcontainers#String2048", - "traits": { - "smithy.api#documentation": "

The ARN of the Virtual Cluster which the Managed Endpoint belongs to.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "executionRoleArn": { - "target": "com.amazonaws.emrcontainers#IAMRoleArn", - "traits": { - "smithy.api#documentation": "

The IAM Execution Role ARN that will be used by the job run.

", - "smithy.api#required": {} - } - }, - "credentialType": { - "target": "com.amazonaws.emrcontainers#CredentialType", - "traits": { - "smithy.api#documentation": "

Type of the token requested. Currently supported and default value of this field is\n “TOKEN.”

", - "smithy.api#required": {} - } - }, - "durationInSeconds": { - "target": "com.amazonaws.emrcontainers#JavaInteger", - "traits": { - "smithy.api#documentation": "

Duration in seconds for which the session token is valid. The default duration is 15\n minutes and the maximum is 12 hours.

" - } - }, - "logContext": { - "target": "com.amazonaws.emrcontainers#LogContext", - "traits": { - "smithy.api#documentation": "

String identifier used to separate sections of the execution logs uploaded to S3.

" - } - }, - "clientToken": { - "target": "com.amazonaws.emrcontainers#ClientToken", - "traits": { - "smithy.api#documentation": "

The client idempotency token of the job run request.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.emrcontainers#GetManagedEndpointSessionCredentialsResponse": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The identifier of the session token returned.

" - } - }, - "credentials": { - "target": "com.amazonaws.emrcontainers#Credentials", - "traits": { - "smithy.api#documentation": "

The structure containing the session credentials.

" - } - }, - "expiresAt": { - "target": "com.amazonaws.emrcontainers#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the session token will expire.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.emrcontainers#IAMRoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):iam::(\\d{12})?:(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)$" - } - }, - "com.amazonaws.emrcontainers#InTransitEncryptionConfiguration": { - "type": "structure", - "members": { - "tlsCertificateConfiguration": { - "target": "com.amazonaws.emrcontainers#TLSCertificateConfiguration", - "traits": { - "smithy.api#documentation": "

TLS certificate-related configuration input for the security configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configurations related to in-transit encryption for the security configuration.

" - } - }, - "com.amazonaws.emrcontainers#InternalServerException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.emrcontainers#String1024" - } - }, - "traits": { - "smithy.api#documentation": "

This is an internal server exception.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.emrcontainers#JavaInteger": { - "type": "integer" - }, - "com.amazonaws.emrcontainers#JobArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 60, - "max": 1024 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/virtualclusters\\/[0-9a-zA-Z]+\\/jobruns\\/[0-9a-zA-Z]+$" - } - }, - "com.amazonaws.emrcontainers#JobDriver": { - "type": "structure", - "members": { - "sparkSubmitJobDriver": { - "target": "com.amazonaws.emrcontainers#SparkSubmitJobDriver", - "traits": { - "smithy.api#documentation": "

The job driver parameters specified for spark submit.

" - } - }, - "sparkSqlJobDriver": { - "target": "com.amazonaws.emrcontainers#SparkSqlJobDriver", - "traits": { - "smithy.api#documentation": "

The job driver for job type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specify the driver that the job runs on. Exactly one of the two available job drivers is\n required, either sparkSqlJobDriver or sparkSubmitJobDriver.

" - } - }, - "com.amazonaws.emrcontainers#JobRun": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the job run.

" - } - }, - "name": { - "target": "com.amazonaws.emrcontainers#ResourceNameString", - "traits": { - "smithy.api#documentation": "

The name of the job run.

" - } - }, - "virtualClusterId": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the job run's virtual cluster.

" - } - }, - "arn": { - "target": "com.amazonaws.emrcontainers#JobArn", - "traits": { - "smithy.api#documentation": "

The ARN of job run.

" - } - }, - "state": { - "target": "com.amazonaws.emrcontainers#JobRunState", - "traits": { - "smithy.api#documentation": "

The state of the job run.

" - } - }, - "clientToken": { - "target": "com.amazonaws.emrcontainers#ClientToken", - "traits": { - "smithy.api#documentation": "

The client token used to start a job run.

" - } - }, - "executionRoleArn": { - "target": "com.amazonaws.emrcontainers#IAMRoleArn", - "traits": { - "smithy.api#documentation": "

The execution role ARN of the job run.

" - } - }, - "releaseLabel": { - "target": "com.amazonaws.emrcontainers#ReleaseLabel", - "traits": { - "smithy.api#documentation": "

The release version of Amazon EMR.

" - } - }, - "configurationOverrides": { - "target": "com.amazonaws.emrcontainers#ConfigurationOverrides", - "traits": { - "smithy.api#documentation": "

The configuration settings that are used to override default configuration.

" - } - }, - "jobDriver": { - "target": "com.amazonaws.emrcontainers#JobDriver", - "traits": { - "smithy.api#documentation": "

Parameters of job driver for the job run.

" - } - }, - "createdAt": { - "target": "com.amazonaws.emrcontainers#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the job run was created.

" - } - }, - "createdBy": { - "target": "com.amazonaws.emrcontainers#RequestIdentityUserArn", - "traits": { - "smithy.api#documentation": "

The user who created the job run.

" - } - }, - "finishedAt": { - "target": "com.amazonaws.emrcontainers#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the job run has finished.

" - } - }, - "stateDetails": { - "target": "com.amazonaws.emrcontainers#String256", - "traits": { - "smithy.api#documentation": "

Additional details of the job run state.

" - } - }, - "failureReason": { - "target": "com.amazonaws.emrcontainers#FailureReason", - "traits": { - "smithy.api#documentation": "

The reasons why the job run has failed.

" - } - }, - "tags": { - "target": "com.amazonaws.emrcontainers#TagMap", - "traits": { - "smithy.api#documentation": "

The assigned tags of the job run.

" - } - }, - "retryPolicyConfiguration": { - "target": "com.amazonaws.emrcontainers#RetryPolicyConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of the retry policy that the job runs on.

" - } - }, - "retryPolicyExecution": { - "target": "com.amazonaws.emrcontainers#RetryPolicyExecution", - "traits": { - "smithy.api#documentation": "

The current status of the retry policy executed on the job.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This entity describes a job run. A job run is a unit of work, such as a Spark jar,\n PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

" - } - }, - "com.amazonaws.emrcontainers#JobRunState": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "SUBMITTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUBMITTED" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLED" - } - }, - "CANCEL_PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCEL_PENDING" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - } - } - }, - "com.amazonaws.emrcontainers#JobRunStates": { - "type": "list", - "member": { - "target": "com.amazonaws.emrcontainers#JobRunState" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.emrcontainers#JobRuns": { - "type": "list", - "member": { - "target": "com.amazonaws.emrcontainers#JobRun" - } - }, - "com.amazonaws.emrcontainers#JobTemplate": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.emrcontainers#ResourceNameString", - "traits": { - "smithy.api#documentation": "

The name of the job template.

" - } - }, - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the job template.

" - } - }, - "arn": { - "target": "com.amazonaws.emrcontainers#JobTemplateArn", - "traits": { - "smithy.api#documentation": "

The ARN of the job template.

" - } - }, - "createdAt": { - "target": "com.amazonaws.emrcontainers#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the job template was created.

" - } - }, - "createdBy": { - "target": "com.amazonaws.emrcontainers#RequestIdentityUserArn", - "traits": { - "smithy.api#documentation": "

The user who created the job template.

" - } - }, - "tags": { - "target": "com.amazonaws.emrcontainers#TagMap", - "traits": { - "smithy.api#documentation": "

The tags assigned to the job template.

" - } - }, - "jobTemplateData": { - "target": "com.amazonaws.emrcontainers#JobTemplateData", - "traits": { - "smithy.api#documentation": "

The job template data which holds values of StartJobRun API request.

", - "smithy.api#required": {} - } - }, - "kmsKeyArn": { - "target": "com.amazonaws.emrcontainers#KmsKeyArn", - "traits": { - "smithy.api#documentation": "

The KMS key ARN used to encrypt the job template.

" - } - }, - "decryptionError": { - "target": "com.amazonaws.emrcontainers#String2048", - "traits": { - "smithy.api#documentation": "

The error message in case the decryption of job template fails.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This entity describes a job template. Job template stores values of StartJobRun API\n request in a template and can be used to start a job run. Job template allows two use\n cases: avoid repeating recurring StartJobRun API request values, enforcing certain values\n in StartJobRun API request.

" - } - }, - "com.amazonaws.emrcontainers#JobTemplateArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 60, - "max": 1024 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/jobtemplates\\/[0-9a-zA-Z]+$" - } - }, - "com.amazonaws.emrcontainers#JobTemplateData": { - "type": "structure", - "members": { - "executionRoleArn": { - "target": "com.amazonaws.emrcontainers#ParametricIAMRoleArn", - "traits": { - "smithy.api#documentation": "

The execution role ARN of the job run.

", - "smithy.api#required": {} - } - }, - "releaseLabel": { - "target": "com.amazonaws.emrcontainers#ParametricReleaseLabel", - "traits": { - "smithy.api#documentation": "

The release version of Amazon EMR.

", - "smithy.api#required": {} - } - }, - "configurationOverrides": { - "target": "com.amazonaws.emrcontainers#ParametricConfigurationOverrides", - "traits": { - "smithy.api#documentation": "

The configuration settings that are used to override defaults configuration.

" - } - }, - "jobDriver": { - "target": "com.amazonaws.emrcontainers#JobDriver", - "traits": { - "smithy.api#required": {} - } - }, - "parameterConfiguration": { - "target": "com.amazonaws.emrcontainers#TemplateParameterConfigurationMap", - "traits": { - "smithy.api#documentation": "

The configuration of parameters existing in the job template.

" - } - }, - "jobTags": { - "target": "com.amazonaws.emrcontainers#TagMap", - "traits": { - "smithy.api#documentation": "

The tags assigned to jobs started using the job template.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The values of StartJobRun API requests used in job runs started using the job\n template.

" - } - }, - "com.amazonaws.emrcontainers#JobTemplates": { - "type": "list", - "member": { - "target": "com.amazonaws.emrcontainers#JobTemplate" - } - }, - "com.amazonaws.emrcontainers#KmsKeyArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 2048 - }, - "smithy.api#pattern": "^(arn:(aws[a-zA-Z0-9-]*):kms:.+:(\\d{12})?:key\\/[(0-9a-zA-Z)-?]+|\\$\\{[a-zA-Z]\\w*\\})$" - } - }, - "com.amazonaws.emrcontainers#KubernetesNamespace": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" - } - }, - "com.amazonaws.emrcontainers#LakeFormationConfiguration": { - "type": "structure", - "members": { - "authorizedSessionTagValue": { - "target": "com.amazonaws.emrcontainers#SessionTagValue", - "traits": { - "smithy.api#documentation": "

The session tag to authorize Amazon EMR on EKS for API calls to Lake Formation.

" - } - }, - "secureNamespaceInfo": { - "target": "com.amazonaws.emrcontainers#SecureNamespaceInfo", - "traits": { - "smithy.api#documentation": "

The namespace input of the system job.

" - } - }, - "queryEngineRoleArn": { - "target": "com.amazonaws.emrcontainers#IAMRoleArn", - "traits": { - "smithy.api#documentation": "

The query engine IAM role ARN that is tied to the secure Spark job. The\n QueryEngine role assumes the JobExecutionRole to execute all\n the Lake Formation calls.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Lake Formation related configuration inputs for the security\n configuration.

" - } - }, - "com.amazonaws.emrcontainers#ListJobRuns": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrcontainers#ListJobRunsRequest" - }, - "output": { - "target": "com.amazonaws.emrcontainers#ListJobRunsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrcontainers#InternalServerException" - }, - { - "target": "com.amazonaws.emrcontainers#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists job runs based on a set of parameters. A job run is a unit of work, such as a\n Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

", - "smithy.api#http": { - "method": "GET", - "uri": "/virtualclusters/{virtualClusterId}/jobruns", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "jobRuns", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.emrcontainers#ListJobRunsRequest": { - "type": "structure", - "members": { - "virtualClusterId": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the virtual cluster for which to list the job run.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "createdBefore": { - "target": "com.amazonaws.emrcontainers#Date", - "traits": { - "smithy.api#documentation": "

The date and time before which the job runs were submitted.

", - "smithy.api#httpQuery": "createdBefore" - } - }, - "createdAfter": { - "target": "com.amazonaws.emrcontainers#Date", - "traits": { - "smithy.api#documentation": "

The date and time after which the job runs were submitted.

", - "smithy.api#httpQuery": "createdAfter" - } - }, - "name": { - "target": "com.amazonaws.emrcontainers#ResourceNameString", - "traits": { - "smithy.api#documentation": "

The name of the job run.

", - "smithy.api#httpQuery": "name" - } - }, - "states": { - "target": "com.amazonaws.emrcontainers#JobRunStates", - "traits": { - "smithy.api#documentation": "

The states of the job run.

", - "smithy.api#httpQuery": "states" - } - }, - "maxResults": { - "target": "com.amazonaws.emrcontainers#JavaInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of job runs that can be listed.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.emrcontainers#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of job runs to return.

", - "smithy.api#httpQuery": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.emrcontainers#ListJobRunsResponse": { - "type": "structure", - "members": { - "jobRuns": { - "target": "com.amazonaws.emrcontainers#JobRuns", - "traits": { - "smithy.api#documentation": "

This output lists information about the specified job runs.

" - } - }, - "nextToken": { - "target": "com.amazonaws.emrcontainers#NextToken", - "traits": { - "smithy.api#documentation": "

This output displays the token for the next set of job runs.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.emrcontainers#ListJobTemplates": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrcontainers#ListJobTemplatesRequest" - }, - "output": { - "target": "com.amazonaws.emrcontainers#ListJobTemplatesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrcontainers#InternalServerException" - }, - { - "target": "com.amazonaws.emrcontainers#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists job templates based on a set of parameters. Job template stores values of\n StartJobRun API request in a template and can be used to start a job run. Job template\n allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing\n certain values in StartJobRun API request.

", - "smithy.api#http": { - "method": "GET", - "uri": "/jobtemplates", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "templates", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.emrcontainers#ListJobTemplatesRequest": { - "type": "structure", - "members": { - "createdAfter": { - "target": "com.amazonaws.emrcontainers#Date", - "traits": { - "smithy.api#documentation": "

The date and time after which the job templates were created.

", - "smithy.api#httpQuery": "createdAfter" - } - }, - "createdBefore": { - "target": "com.amazonaws.emrcontainers#Date", - "traits": { - "smithy.api#documentation": "

The date and time before which the job templates were created.

", - "smithy.api#httpQuery": "createdBefore" - } - }, - "maxResults": { - "target": "com.amazonaws.emrcontainers#JavaInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of job templates that can be listed.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.emrcontainers#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of job templates to return.

", - "smithy.api#httpQuery": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.emrcontainers#ListJobTemplatesResponse": { - "type": "structure", - "members": { - "templates": { - "target": "com.amazonaws.emrcontainers#JobTemplates", - "traits": { - "smithy.api#documentation": "

This output lists information about the specified job templates.

" - } - }, - "nextToken": { - "target": "com.amazonaws.emrcontainers#NextToken", - "traits": { - "smithy.api#documentation": "

This output displays the token for the next set of job templates.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.emrcontainers#ListManagedEndpoints": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrcontainers#ListManagedEndpointsRequest" - }, - "output": { - "target": "com.amazonaws.emrcontainers#ListManagedEndpointsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrcontainers#InternalServerException" - }, - { - "target": "com.amazonaws.emrcontainers#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway\n that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.

", - "smithy.api#http": { - "method": "GET", - "uri": "/virtualclusters/{virtualClusterId}/endpoints", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "endpoints", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.emrcontainers#ListManagedEndpointsRequest": { - "type": "structure", - "members": { - "virtualClusterId": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the virtual cluster.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "createdBefore": { - "target": "com.amazonaws.emrcontainers#Date", - "traits": { - "smithy.api#documentation": "

The date and time before which the endpoints are created.

", - "smithy.api#httpQuery": "createdBefore" - } - }, - "createdAfter": { - "target": "com.amazonaws.emrcontainers#Date", - "traits": { - "smithy.api#documentation": "

The date and time after which the endpoints are created.

", - "smithy.api#httpQuery": "createdAfter" - } - }, - "types": { - "target": "com.amazonaws.emrcontainers#EndpointTypes", - "traits": { - "smithy.api#documentation": "

The types of the managed endpoints.

", - "smithy.api#httpQuery": "types" - } - }, - "states": { - "target": "com.amazonaws.emrcontainers#EndpointStates", - "traits": { - "smithy.api#documentation": "

The states of the managed endpoints.

", - "smithy.api#httpQuery": "states" - } - }, - "maxResults": { - "target": "com.amazonaws.emrcontainers#JavaInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of managed endpoints that can be listed.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.emrcontainers#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of managed endpoints to return.

", - "smithy.api#httpQuery": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.emrcontainers#ListManagedEndpointsResponse": { - "type": "structure", - "members": { - "endpoints": { - "target": "com.amazonaws.emrcontainers#Endpoints", - "traits": { - "smithy.api#documentation": "

The managed endpoints to be listed.

" - } - }, - "nextToken": { - "target": "com.amazonaws.emrcontainers#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of endpoints to return.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.emrcontainers#ListSecurityConfigurations": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrcontainers#ListSecurityConfigurationsRequest" - }, - "output": { - "target": "com.amazonaws.emrcontainers#ListSecurityConfigurationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrcontainers#InternalServerException" - }, - { - "target": "com.amazonaws.emrcontainers#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists security configurations based on a set of parameters. Security configurations in\n Amazon EMR on EKS are templates for different security setups. You can use security\n configurations to configure the Lake Formation integration setup. You can also\n create a security configuration to re-use a security setup each time you create a virtual\n cluster.

", - "smithy.api#http": { - "method": "GET", - "uri": "/securityconfigurations", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "securityConfigurations", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.emrcontainers#ListSecurityConfigurationsRequest": { - "type": "structure", - "members": { - "createdAfter": { - "target": "com.amazonaws.emrcontainers#Date", - "traits": { - "smithy.api#documentation": "

The date and time after which the security configuration was created.

", - "smithy.api#httpQuery": "createdAfter" - } - }, - "createdBefore": { - "target": "com.amazonaws.emrcontainers#Date", - "traits": { - "smithy.api#documentation": "

The date and time before which the security configuration was created.

", - "smithy.api#httpQuery": "createdBefore" - } - }, - "maxResults": { - "target": "com.amazonaws.emrcontainers#JavaInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of security configurations the operation can list.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.emrcontainers#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of security configurations to return.

", - "smithy.api#httpQuery": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.emrcontainers#ListSecurityConfigurationsResponse": { - "type": "structure", - "members": { - "securityConfigurations": { - "target": "com.amazonaws.emrcontainers#SecurityConfigurations", - "traits": { - "smithy.api#documentation": "

The list of returned security configurations.

" - } - }, - "nextToken": { - "target": "com.amazonaws.emrcontainers#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of security configurations to return.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.emrcontainers#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrcontainers#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.emrcontainers#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrcontainers#InternalServerException" - }, - { - "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrcontainers#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the tags assigned to the resources.

", - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.emrcontainers#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.emrcontainers#RsiArn", - "traits": { - "smithy.api#documentation": "

The ARN of tagged resources.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.emrcontainers#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.emrcontainers#TagMap", - "traits": { - "smithy.api#documentation": "

The tags assigned to resources.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.emrcontainers#ListVirtualClusters": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrcontainers#ListVirtualClustersRequest" - }, - "output": { - "target": "com.amazonaws.emrcontainers#ListVirtualClustersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrcontainers#InternalServerException" - }, - { - "target": "com.amazonaws.emrcontainers#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists information about the specified virtual cluster. Virtual cluster is a managed\n entity on Amazon EMR on EKS. You can create, describe, list and delete virtual\n clusters. They do not consume any additional resource in your system. A single virtual\n cluster maps to a single Kubernetes namespace. Given this relationship, you can model\n virtual clusters the same way you model Kubernetes namespaces to meet your\n requirements.

", - "smithy.api#http": { - "method": "GET", - "uri": "/virtualclusters", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "virtualClusters", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.emrcontainers#ListVirtualClustersRequest": { - "type": "structure", - "members": { - "containerProviderId": { - "target": "com.amazonaws.emrcontainers#String1024", - "traits": { - "smithy.api#documentation": "

The container provider ID of the virtual cluster.

", - "smithy.api#httpQuery": "containerProviderId" - } - }, - "containerProviderType": { - "target": "com.amazonaws.emrcontainers#ContainerProviderType", - "traits": { - "smithy.api#documentation": "

The container provider type of the virtual cluster. Amazon EKS is the only\n supported type as of now.

", - "smithy.api#httpQuery": "containerProviderType" - } - }, - "createdAfter": { - "target": "com.amazonaws.emrcontainers#Date", - "traits": { - "smithy.api#documentation": "

The date and time after which the virtual clusters are created.

", - "smithy.api#httpQuery": "createdAfter" - } - }, - "createdBefore": { - "target": "com.amazonaws.emrcontainers#Date", - "traits": { - "smithy.api#documentation": "

The date and time before which the virtual clusters are created.

", - "smithy.api#httpQuery": "createdBefore" - } - }, - "states": { - "target": "com.amazonaws.emrcontainers#VirtualClusterStates", - "traits": { - "smithy.api#documentation": "

The states of the requested virtual clusters.

", - "smithy.api#httpQuery": "states" - } - }, - "maxResults": { - "target": "com.amazonaws.emrcontainers#JavaInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of virtual clusters that can be listed.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.emrcontainers#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of virtual clusters to return.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "eksAccessEntryIntegrated": { - "target": "com.amazonaws.emrcontainers#Boolean", - "traits": { - "smithy.api#documentation": "

Optional Boolean that specifies whether the operation should return the \n virtual clusters that have the access entry integration enabled or disabled. If not specified,\n the operation returns all applicable virtual clusters.

", - "smithy.api#httpQuery": "eksAccessEntryIntegrated" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.emrcontainers#ListVirtualClustersResponse": { - "type": "structure", - "members": { - "virtualClusters": { - "target": "com.amazonaws.emrcontainers#VirtualClusters", - "traits": { - "smithy.api#documentation": "

This output lists the specified virtual clusters.

" - } - }, - "nextToken": { - "target": "com.amazonaws.emrcontainers#NextToken", - "traits": { - "smithy.api#documentation": "

This output displays the token for the next set of virtual clusters.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.emrcontainers#LogContext": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^((?!.*-s3alias)(?!xn--.*)[a-z0-9][-a-z0-9.]*)?[a-z0-9]$" - } - }, - "com.amazonaws.emrcontainers#LogGroupName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - }, - "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" - } - }, - "com.amazonaws.emrcontainers#MaxFilesToKeep": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.emrcontainers#MonitoringConfiguration": { - "type": "structure", - "members": { - "persistentAppUI": { - "target": "com.amazonaws.emrcontainers#PersistentAppUI", - "traits": { - "smithy.api#documentation": "

Monitoring configurations for the persistent application UI.

" - } - }, - "cloudWatchMonitoringConfiguration": { - "target": "com.amazonaws.emrcontainers#CloudWatchMonitoringConfiguration", - "traits": { - "smithy.api#documentation": "

Monitoring configurations for CloudWatch.

" - } - }, - "s3MonitoringConfiguration": { - "target": "com.amazonaws.emrcontainers#S3MonitoringConfiguration", - "traits": { - "smithy.api#documentation": "

Amazon S3 configuration for monitoring log publishing.

" - } - }, - "containerLogRotationConfiguration": { - "target": "com.amazonaws.emrcontainers#ContainerLogRotationConfiguration", - "traits": { - "smithy.api#documentation": "

Enable or disable container log rotation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration setting for monitoring.

" - } - }, - "com.amazonaws.emrcontainers#NextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.emrcontainers#ParametricCloudWatchMonitoringConfiguration": { - "type": "structure", - "members": { - "logGroupName": { - "target": "com.amazonaws.emrcontainers#TemplateParameter", - "traits": { - "smithy.api#documentation": "

The name of the log group for log publishing.

" - } - }, - "logStreamNamePrefix": { - "target": "com.amazonaws.emrcontainers#String256", - "traits": { - "smithy.api#documentation": "

The specified name prefix for log streams.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A configuration for CloudWatch monitoring. You can configure your jobs to send log\n information to CloudWatch Logs. This data type allows job template parameters to be\n specified within.

" - } - }, - "com.amazonaws.emrcontainers#ParametricConfigurationOverrides": { - "type": "structure", - "members": { - "applicationConfiguration": { - "target": "com.amazonaws.emrcontainers#ConfigurationList", - "traits": { - "smithy.api#documentation": "

The configurations for the application running by the job run.

" - } - }, - "monitoringConfiguration": { - "target": "com.amazonaws.emrcontainers#ParametricMonitoringConfiguration", - "traits": { - "smithy.api#documentation": "

The configurations for monitoring.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A configuration specification to be used to override existing configurations. This data\n type allows job template parameters to be specified within.

" - } - }, - "com.amazonaws.emrcontainers#ParametricIAMRoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 4, - "max": 2048 - }, - "smithy.api#pattern": "^(^arn:(aws[a-zA-Z0-9-]*):iam::(\\d{12})?:(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)$)|([\\.\\-_\\#A-Za-z0-9\\$\\{\\}]+)$" - } - }, - "com.amazonaws.emrcontainers#ParametricMonitoringConfiguration": { - "type": "structure", - "members": { - "persistentAppUI": { - "target": "com.amazonaws.emrcontainers#TemplateParameter", - "traits": { - "smithy.api#documentation": "

Monitoring configurations for the persistent application UI.

" - } - }, - "cloudWatchMonitoringConfiguration": { - "target": "com.amazonaws.emrcontainers#ParametricCloudWatchMonitoringConfiguration", - "traits": { - "smithy.api#documentation": "

Monitoring configurations for CloudWatch.

" - } - }, - "s3MonitoringConfiguration": { - "target": "com.amazonaws.emrcontainers#ParametricS3MonitoringConfiguration", - "traits": { - "smithy.api#documentation": "

Amazon S3 configuration for monitoring log publishing.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration setting for monitoring. This data type allows job template parameters to\n be specified within.

" - } - }, - "com.amazonaws.emrcontainers#ParametricReleaseLabel": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^([\\.\\-_/A-Za-z0-9]+|\\$\\{[a-zA-Z]\\w*\\})$" - } - }, - "com.amazonaws.emrcontainers#ParametricS3MonitoringConfiguration": { - "type": "structure", - "members": { - "logUri": { - "target": "com.amazonaws.emrcontainers#UriString", - "traits": { - "smithy.api#documentation": "

Amazon S3 destination URI for log publishing.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Amazon S3 configuration for monitoring log publishing. You can configure your jobs to\n send log information to Amazon S3. This data type allows job template parameters to be\n specified within.

" - } - }, - "com.amazonaws.emrcontainers#PersistentAppUI": { - "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.emrcontainers#ReleaseLabel": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[\\.\\-_/A-Za-z0-9]+$" - } - }, - "com.amazonaws.emrcontainers#RequestIdentityUserArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):(iam|sts)::(\\d{12})?:[\\w/+=,.@-]+$" - } - }, - "com.amazonaws.emrcontainers#RequestThrottledException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.emrcontainers#String1024" - } - }, - "traits": { - "smithy.api#documentation": "

The request throttled.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.emrcontainers#ResourceIdString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[0-9a-z]+$" - } - }, - "com.amazonaws.emrcontainers#ResourceNameString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" - } - }, - "com.amazonaws.emrcontainers#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.emrcontainers#String1024" - } - }, - "traits": { - "smithy.api#documentation": "

The specified resource was not found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.emrcontainers#RetryPolicyConfiguration": { - "type": "structure", - "members": { - "maxAttempts": { - "target": "com.amazonaws.emrcontainers#JavaInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of attempts on the job's driver.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of the retry policy that the job runs on.

" - } - }, - "com.amazonaws.emrcontainers#RetryPolicyExecution": { - "type": "structure", - "members": { - "currentAttemptCount": { - "target": "com.amazonaws.emrcontainers#JavaInteger", - "traits": { - "smithy.api#documentation": "

The current number of attempts made on the driver of the job.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The current status of the retry policy executed on the job.

" - } - }, - "com.amazonaws.emrcontainers#RotationSize": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 12 - }, - "smithy.api#pattern": "^\\d+(\\.\\d+)?[KMG][Bb]?$" - } - }, - "com.amazonaws.emrcontainers#RsiArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 60, - "max": 500 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):/virtualclusters/.+$" - } - }, - "com.amazonaws.emrcontainers#S3MonitoringConfiguration": { - "type": "structure", - "members": { - "logUri": { - "target": "com.amazonaws.emrcontainers#UriString", - "traits": { - "smithy.api#documentation": "

Amazon S3 destination URI for log publishing.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Amazon S3 configuration for monitoring log publishing. You can configure your jobs to\n send log information to Amazon S3.

" - } - }, - "com.amazonaws.emrcontainers#SecretsManagerArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 2048 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):secretsmanager:.+:(\\d{12}):secret:[0-9a-zA-Z/_+=.@-]+$" - } - }, - "com.amazonaws.emrcontainers#SecureNamespaceInfo": { - "type": "structure", - "members": { - "clusterId": { - "target": "com.amazonaws.emrcontainers#ClusterId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon EKS cluster where Amazon EMR on EKS jobs run.

" - } - }, - "namespace": { - "target": "com.amazonaws.emrcontainers#KubernetesNamespace", - "traits": { - "smithy.api#documentation": "

The namespace of the Amazon EKS cluster where the system jobs run.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Namespace inputs for the system job.

" - } - }, - "com.amazonaws.emrcontainers#SecurityConfiguration": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the security configuration.

" - } - }, - "name": { - "target": "com.amazonaws.emrcontainers#ResourceNameString", - "traits": { - "smithy.api#documentation": "

The name of the security configuration.

" - } - }, - "arn": { - "target": "com.amazonaws.emrcontainers#SecurityConfigurationArn", - "traits": { - "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the security configuration.

" - } - }, - "createdAt": { - "target": "com.amazonaws.emrcontainers#Date", - "traits": { - "smithy.api#documentation": "

The date and time that the job run was created.

" - } - }, - "createdBy": { - "target": "com.amazonaws.emrcontainers#RequestIdentityUserArn", - "traits": { - "smithy.api#documentation": "

The user who created the job run.

" - } - }, - "securityConfigurationData": { - "target": "com.amazonaws.emrcontainers#SecurityConfigurationData", - "traits": { - "smithy.api#documentation": "

Security configuration inputs for the request.

" - } - }, - "tags": { - "target": "com.amazonaws.emrcontainers#TagMap", - "traits": { - "smithy.api#documentation": "

The tags to assign to the security configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Inputs related to the security configuration. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security\n configurations to configure the Lake Formation integration setup. You can also\n create a security configuration to re-use a security setup each time you create a virtual\n cluster.

" - } - }, - "com.amazonaws.emrcontainers#SecurityConfigurationArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 60, - "max": 1024 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/securityconfigurations\\/[0-9a-zA-Z]+$" - } - }, - "com.amazonaws.emrcontainers#SecurityConfigurationData": { - "type": "structure", - "members": { - "authorizationConfiguration": { - "target": "com.amazonaws.emrcontainers#AuthorizationConfiguration", - "traits": { - "smithy.api#documentation": "

Authorization-related configuration input for the security configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configurations related to the security configuration for the request.

" - } - }, - "com.amazonaws.emrcontainers#SecurityConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.emrcontainers#SecurityConfiguration" - } - }, - "com.amazonaws.emrcontainers#SensitivePropertiesMap": { - "type": "map", - "key": { - "target": "com.amazonaws.emrcontainers#String1024" - }, - "value": { - "target": "com.amazonaws.emrcontainers#String1024" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.emrcontainers#SessionTagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - }, - "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9 ]+$" - } - }, - "com.amazonaws.emrcontainers#SparkSqlJobDriver": { - "type": "structure", - "members": { - "entryPoint": { - "target": "com.amazonaws.emrcontainers#EntryPointPath", - "traits": { - "smithy.api#documentation": "

The SQL file to be executed.

" - } - }, - "sparkSqlParameters": { - "target": "com.amazonaws.emrcontainers#SparkSqlParameters", - "traits": { - "smithy.api#documentation": "

The Spark parameters to be included in the Spark SQL command.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The job driver for job type.

" - } - }, - "com.amazonaws.emrcontainers#SparkSqlParameters": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 102400 - }, - "smithy.api#pattern": "\\S", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.emrcontainers#SparkSubmitJobDriver": { - "type": "structure", - "members": { - "entryPoint": { - "target": "com.amazonaws.emrcontainers#EntryPointPath", - "traits": { - "smithy.api#documentation": "

The entry point of job application.

", - "smithy.api#required": {} - } - }, - "entryPointArguments": { - "target": "com.amazonaws.emrcontainers#EntryPointArguments", - "traits": { - "smithy.api#documentation": "

The arguments for job application.

" - } - }, - "sparkSubmitParameters": { - "target": "com.amazonaws.emrcontainers#SparkSubmitParameters", - "traits": { - "smithy.api#documentation": "

The Spark submit parameters that are used for job runs.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The information about job driver for Spark submit.

" - } - }, - "com.amazonaws.emrcontainers#SparkSubmitParameters": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 102400 - }, - "smithy.api#pattern": "\\S", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.emrcontainers#StartJobRun": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrcontainers#StartJobRunRequest" - }, - "output": { - "target": "com.amazonaws.emrcontainers#StartJobRunResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrcontainers#InternalServerException" - }, - { - "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrcontainers#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or\n SparkSQL query, that you submit to Amazon EMR on EKS.

", - "smithy.api#http": { - "method": "POST", - "uri": "/virtualclusters/{virtualClusterId}/jobruns", - "code": 200 - } - } - }, - "com.amazonaws.emrcontainers#StartJobRunRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.emrcontainers#ResourceNameString", - "traits": { - "smithy.api#documentation": "

The name of the job run.

" - } - }, - "virtualClusterId": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The virtual cluster ID for which the job run request is submitted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.emrcontainers#ClientToken", - "traits": { - "smithy.api#documentation": "

The client idempotency token of the job run request.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "executionRoleArn": { - "target": "com.amazonaws.emrcontainers#IAMRoleArn", - "traits": { - "smithy.api#documentation": "

The execution role ARN for the job run.

" - } - }, - "releaseLabel": { - "target": "com.amazonaws.emrcontainers#ReleaseLabel", - "traits": { - "smithy.api#documentation": "

The Amazon EMR release version to use for the job run.

" - } - }, - "jobDriver": { - "target": "com.amazonaws.emrcontainers#JobDriver", - "traits": { - "smithy.api#documentation": "

The job driver for the job run.

" - } - }, - "configurationOverrides": { - "target": "com.amazonaws.emrcontainers#ConfigurationOverrides", - "traits": { - "smithy.api#documentation": "

The configuration overrides for the job run.

" - } - }, - "tags": { - "target": "com.amazonaws.emrcontainers#TagMap", - "traits": { - "smithy.api#documentation": "

The tags assigned to job runs.

" - } - }, - "jobTemplateId": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The job template ID to be used to start the job run.

" - } - }, - "jobTemplateParameters": { - "target": "com.amazonaws.emrcontainers#TemplateParameterInputMap", - "traits": { - "smithy.api#documentation": "

The values of job template parameters to start a job run.

" - } - }, - "retryPolicyConfiguration": { - "target": "com.amazonaws.emrcontainers#RetryPolicyConfiguration", - "traits": { - "smithy.api#documentation": "

The retry policy configuration for the job run.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.emrcontainers#StartJobRunResponse": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

This output displays the started job run ID.

" - } - }, - "name": { - "target": "com.amazonaws.emrcontainers#ResourceNameString", - "traits": { - "smithy.api#documentation": "

This output displays the name of the started job run.

" - } - }, - "arn": { - "target": "com.amazonaws.emrcontainers#JobArn", - "traits": { - "smithy.api#documentation": "

This output lists the ARN of job run.

" - } - }, - "virtualClusterId": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

This output displays the virtual cluster ID for which the job run was submitted.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.emrcontainers#String1024": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.emrcontainers#String128": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.emrcontainers#String2048": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.emrcontainers#String256": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.emrcontainers#StringEmpty256": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.emrcontainers#SubnetIds": { - "type": "list", - "member": { - "target": "com.amazonaws.emrcontainers#String256" - } - }, - "com.amazonaws.emrcontainers#TLSCertificateConfiguration": { - "type": "structure", - "members": { - "certificateProviderType": { - "target": "com.amazonaws.emrcontainers#CertificateProviderType", - "traits": { - "smithy.api#documentation": "

The TLS certificate type. Acceptable values: PEM or\n Custom.

" - } - }, - "publicCertificateSecretArn": { - "target": "com.amazonaws.emrcontainers#SecretsManagerArn", - "traits": { - "smithy.api#documentation": "

Secrets Manager ARN that contains the public TLS certificate contents, used for\n communication between the user job and the system job.

" - } - }, - "privateCertificateSecretArn": { - "target": "com.amazonaws.emrcontainers#SecretsManagerArn", - "traits": { - "smithy.api#documentation": "

Secrets Manager ARN that contains the private TLS certificate contents, used for\n communication between the user job and the system job.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configurations related to the TLS certificate for the security configuration.

" - } - }, - "com.amazonaws.emrcontainers#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.emrcontainers#String128" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.emrcontainers#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.emrcontainers#String128" - }, - "value": { - "target": "com.amazonaws.emrcontainers#StringEmpty256" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.emrcontainers#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrcontainers#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.emrcontainers#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrcontainers#InternalServerException" - }, - { - "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrcontainers#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Assigns tags to resources. A tag is a label that you assign to an Amazon Web Services\n resource. Each tag consists of a key and an optional value, both of which you define. Tags\n enable you to categorize your Amazon Web Services resources by attributes such as purpose,\n owner, or environment. When you have many resources of the same type, you can quickly\n identify a specific resource based on the tags you've assigned to it. For example, you can\n define a set of tags for your Amazon EMR on EKS clusters to help you track each\n cluster's owner and stack level. We recommend that you devise a consistent set of tag keys\n for each resource type. You can then search and filter the resources based on the tags that\n you add.

", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.emrcontainers#TagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.emrcontainers#RsiArn", - "traits": { - "smithy.api#documentation": "

The ARN of resources.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.emrcontainers#TagMap", - "traits": { - "smithy.api#documentation": "

The tags assigned to resources.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.emrcontainers#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.emrcontainers#TemplateParameter": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - }, - "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9\\$\\{\\}]+$" - } - }, - "com.amazonaws.emrcontainers#TemplateParameterConfiguration": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.emrcontainers#TemplateParameterDataType", - "traits": { - "smithy.api#documentation": "

The type of the job template parameter. Allowed values are: ‘STRING’, ‘NUMBER’.

" - } - }, - "defaultValue": { - "target": "com.amazonaws.emrcontainers#String1024", - "traits": { - "smithy.api#documentation": "

The default value for the job template parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a job template parameter.

" - } - }, - "com.amazonaws.emrcontainers#TemplateParameterConfigurationMap": { - "type": "map", - "key": { - "target": "com.amazonaws.emrcontainers#TemplateParameterName" - }, - "value": { - "target": "com.amazonaws.emrcontainers#TemplateParameterConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.emrcontainers#TemplateParameterDataType": { - "type": "enum", - "members": { - "NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NUMBER" - } - }, - "STRING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STRING" - } - } - } - }, - "com.amazonaws.emrcontainers#TemplateParameterInputMap": { - "type": "map", - "key": { - "target": "com.amazonaws.emrcontainers#TemplateParameterName" - }, - "value": { - "target": "com.amazonaws.emrcontainers#String1024" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.emrcontainers#TemplateParameterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - }, - "smithy.api#pattern": "^[\\.\\-_\\#A-Za-z0-9]+$" - } - }, - "com.amazonaws.emrcontainers#Token": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - }, - "smithy.api#pattern": "^.*\\S.*$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.emrcontainers#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrcontainers#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.emrcontainers#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrcontainers#InternalServerException" - }, - { - "target": "com.amazonaws.emrcontainers#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrcontainers#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes tags from resources.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.emrcontainers#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.emrcontainers#RsiArn", - "traits": { - "smithy.api#documentation": "

The ARN of resources.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.emrcontainers#TagKeyList", - "traits": { - "smithy.api#documentation": "

The tag keys of the resources.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.emrcontainers#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.emrcontainers#UriString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10280 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.emrcontainers#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.emrcontainers#String1024" - } - }, - "traits": { - "smithy.api#documentation": "

There are invalid parameters in the client request.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.emrcontainers#VirtualCluster": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the virtual cluster.

" - } - }, - "name": { - "target": "com.amazonaws.emrcontainers#ResourceNameString", - "traits": { - "smithy.api#documentation": "

The name of the virtual cluster.

" - } - }, - "arn": { - "target": "com.amazonaws.emrcontainers#VirtualClusterArn", - "traits": { - "smithy.api#documentation": "

The ARN of the virtual cluster.

" - } - }, - "state": { - "target": "com.amazonaws.emrcontainers#VirtualClusterState", - "traits": { - "smithy.api#documentation": "

The state of the virtual cluster.

" - } - }, - "containerProvider": { - "target": "com.amazonaws.emrcontainers#ContainerProvider", - "traits": { - "smithy.api#documentation": "

The container provider of the virtual cluster.

" - } - }, - "createdAt": { - "target": "com.amazonaws.emrcontainers#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the virtual cluster is created.

" - } - }, - "tags": { - "target": "com.amazonaws.emrcontainers#TagMap", - "traits": { - "smithy.api#documentation": "

The assigned tags of the virtual cluster.

" - } - }, - "securityConfigurationId": { - "target": "com.amazonaws.emrcontainers#ResourceIdString", - "traits": { - "smithy.api#documentation": "

The ID of the security configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This entity describes a virtual cluster. A virtual cluster is a Kubernetes namespace\n that Amazon EMR is registered with. Amazon EMR uses virtual clusters to run\n jobs and host endpoints. Multiple virtual clusters can be backed by the same physical\n cluster. However, each virtual cluster maps to one namespace on an Amazon EKS\n cluster. Virtual clusters do not create any active resources that contribute to your bill\n or that require lifecycle management outside the service.

" - } - }, - "com.amazonaws.emrcontainers#VirtualClusterArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 60, - "max": 1024 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/virtualclusters\\/[0-9a-zA-Z]+$" - } - }, - "com.amazonaws.emrcontainers#VirtualClusterState": { - "type": "enum", - "members": { - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "TERMINATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TERMINATING" - } - }, - "TERMINATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TERMINATED" - } - }, - "ARRESTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARRESTED" - } - } - } - }, - "com.amazonaws.emrcontainers#VirtualClusterStates": { - "type": "list", - "member": { - "target": "com.amazonaws.emrcontainers#VirtualClusterState" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 } - } - }, - "com.amazonaws.emrcontainers#VirtualClusters": { - "type": "list", - "member": { - "target": "com.amazonaws.emrcontainers#VirtualCluster" - } } - } } diff --git a/codegen/sdk-codegen/aws-models/inspector2.json b/codegen/sdk-codegen/aws-models/inspector2.json index 4ebb92775768..97f840031f06 100644 --- a/codegen/sdk-codegen/aws-models/inspector2.json +++ b/codegen/sdk-codegen/aws-models/inspector2.json @@ -1,15435 +1,15504 @@ { - "smithy": "2.0", - "shapes": { - "com.amazonaws.inspector2#AccessDeniedException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.inspector2#Account": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.inspector2#Status", - "traits": { - "smithy.api#documentation": "

The status of Amazon Inspector for the account.

", - "smithy.api#required": {} - } - }, - "resourceStatus": { - "target": "com.amazonaws.inspector2#ResourceStatus", - "traits": { - "smithy.api#documentation": "

Details of the status of Amazon Inspector scans by resource type.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An Amazon Web Services account within your environment that Amazon Inspector has been enabled for.

" - } - }, - "com.amazonaws.inspector2#AccountAggregation": { - "type": "structure", - "members": { - "findingType": { - "target": "com.amazonaws.inspector2#AggregationFindingType", - "traits": { - "smithy.api#documentation": "

The type of finding.

" - } - }, - "resourceType": { - "target": "com.amazonaws.inspector2#AggregationResourceType", - "traits": { - "smithy.api#documentation": "

The type of resource.

" - } - }, - "sortOrder": { - "target": "com.amazonaws.inspector2#SortOrder", - "traits": { - "smithy.api#documentation": "

The sort order (ascending or descending).

" - } - }, - "sortBy": { - "target": "com.amazonaws.inspector2#AccountSortBy", - "traits": { - "smithy.api#documentation": "

The value to sort by.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains details about an aggregation response based on\n Amazon Web Services accounts.

" - } - }, - "com.amazonaws.inspector2#AccountAggregationResponse": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

" - } - }, - "severityCounts": { - "target": "com.amazonaws.inspector2#SeverityCounts", - "traits": { - "smithy.api#documentation": "

The number of findings by severity.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An aggregation of findings by Amazon Web Services account ID.

" - } - }, - "com.amazonaws.inspector2#AccountId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 12, - "max": 12 - }, - "smithy.api#pattern": "^\\d{12}$" - } - }, - "com.amazonaws.inspector2#AccountIdFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisStringFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#AccountIdSet": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#AccountId" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - }, - "smithy.api#uniqueItems": {} - } - }, - "com.amazonaws.inspector2#AccountList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#Account" - } - }, - "com.amazonaws.inspector2#AccountSortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CRITICAL", - "name": "CRITICAL" - }, - { - "value": "HIGH", - "name": "HIGH" - }, - { - "value": "ALL", - "name": "ALL" - } - ] - } - }, - "com.amazonaws.inspector2#AccountState": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#required": {} - } - }, - "state": { - "target": "com.amazonaws.inspector2#State", - "traits": { - "smithy.api#documentation": "

An object detailing the status of Amazon Inspector for the account.

", - "smithy.api#required": {} - } - }, - "resourceState": { - "target": "com.amazonaws.inspector2#ResourceState", - "traits": { - "smithy.api#documentation": "

An object detailing which resources Amazon Inspector is enabled to scan for the account.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object with details the status of an Amazon Web Services account within your Amazon Inspector environment.

" - } - }, - "com.amazonaws.inspector2#AccountStateList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#AccountState" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.inspector2#AggCounts": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.inspector2#AggregationFindingType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NETWORK_REACHABILITY", - "name": "NETWORK_REACHABILITY" - }, - { - "value": "PACKAGE_VULNERABILITY", - "name": "PACKAGE_VULNERABILITY" - }, - { - "value": "CODE_VULNERABILITY", - "name": "CODE_VULNERABILITY" - } - ] - } - }, - "com.amazonaws.inspector2#AggregationRequest": { - "type": "union", - "members": { - "accountAggregation": { - "target": "com.amazonaws.inspector2#AccountAggregation", - "traits": { - "smithy.api#documentation": "

An object that contains details about an aggregation request based on Amazon Web Services account\n IDs.

" - } - }, - "amiAggregation": { - "target": "com.amazonaws.inspector2#AmiAggregation", - "traits": { - "smithy.api#documentation": "

An object that contains details about an aggregation request based on Amazon Machine\n Images (AMIs).

" - } - }, - "awsEcrContainerAggregation": { - "target": "com.amazonaws.inspector2#AwsEcrContainerAggregation", - "traits": { - "smithy.api#documentation": "

An object that contains details about an aggregation request based on Amazon ECR container\n images.

" - } - }, - "ec2InstanceAggregation": { - "target": "com.amazonaws.inspector2#Ec2InstanceAggregation", - "traits": { - "smithy.api#documentation": "

An object that contains details about an aggregation request based on Amazon EC2\n instances.

" - } - }, - "findingTypeAggregation": { - "target": "com.amazonaws.inspector2#FindingTypeAggregation", - "traits": { - "smithy.api#documentation": "

An object that contains details about an aggregation request based on finding types.

" - } - }, - "imageLayerAggregation": { - "target": "com.amazonaws.inspector2#ImageLayerAggregation", - "traits": { - "smithy.api#documentation": "

An object that contains details about an aggregation request based on container image\n layers.

" - } - }, - "packageAggregation": { - "target": "com.amazonaws.inspector2#PackageAggregation", - "traits": { - "smithy.api#documentation": "

An object that contains details about an aggregation request based on operating system\n package type.

" - } - }, - "repositoryAggregation": { - "target": "com.amazonaws.inspector2#RepositoryAggregation", - "traits": { - "smithy.api#documentation": "

An object that contains details about an aggregation request based on Amazon ECR repositories.

" - } - }, - "titleAggregation": { - "target": "com.amazonaws.inspector2#TitleAggregation", - "traits": { - "smithy.api#documentation": "

An object that contains details about an aggregation request based on finding title.

" - } - }, - "lambdaLayerAggregation": { - "target": "com.amazonaws.inspector2#LambdaLayerAggregation", - "traits": { - "smithy.api#documentation": "

Returns an object with findings aggregated by Amazon Web Services Lambda layer.

" - } - }, - "lambdaFunctionAggregation": { - "target": "com.amazonaws.inspector2#LambdaFunctionAggregation", - "traits": { - "smithy.api#documentation": "

Returns an object with findings aggregated by Amazon Web Services Lambda function.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details about an aggregation request.

" - } - }, - "com.amazonaws.inspector2#AggregationResourceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AWS_EC2_INSTANCE", - "name": "AWS_EC2_INSTANCE" - }, - { - "value": "AWS_ECR_CONTAINER_IMAGE", - "name": "AWS_ECR_CONTAINER_IMAGE" - }, - { - "value": "AWS_LAMBDA_FUNCTION", - "name": "AWS_LAMBDA_FUNCTION" - } - ] - } - }, - "com.amazonaws.inspector2#AggregationResponse": { - "type": "union", - "members": { - "accountAggregation": { - "target": "com.amazonaws.inspector2#AccountAggregationResponse", - "traits": { - "smithy.api#documentation": "

An object that contains details about an aggregation response based on Amazon Web Services account\n IDs.

" - } - }, - "amiAggregation": { - "target": "com.amazonaws.inspector2#AmiAggregationResponse", - "traits": { - "smithy.api#documentation": "

An object that contains details about an aggregation response based on Amazon Machine\n Images (AMIs).

" - } - }, - "awsEcrContainerAggregation": { - "target": "com.amazonaws.inspector2#AwsEcrContainerAggregationResponse", - "traits": { - "smithy.api#documentation": "

An object that contains details about an aggregation response based on Amazon ECR container\n images.

" - } - }, - "ec2InstanceAggregation": { - "target": "com.amazonaws.inspector2#Ec2InstanceAggregationResponse", - "traits": { - "smithy.api#documentation": "

An object that contains details about an aggregation response based on Amazon EC2\n instances.

" - } - }, - "findingTypeAggregation": { - "target": "com.amazonaws.inspector2#FindingTypeAggregationResponse", - "traits": { - "smithy.api#documentation": "

An object that contains details about an aggregation response based on finding types.

" - } - }, - "imageLayerAggregation": { - "target": "com.amazonaws.inspector2#ImageLayerAggregationResponse", - "traits": { - "smithy.api#documentation": "

An object that contains details about an aggregation response based on container image\n layers.

" - } - }, - "packageAggregation": { - "target": "com.amazonaws.inspector2#PackageAggregationResponse", - "traits": { - "smithy.api#documentation": "

An object that contains details about an aggregation response based on operating system\n package type.

" - } - }, - "repositoryAggregation": { - "target": "com.amazonaws.inspector2#RepositoryAggregationResponse", - "traits": { - "smithy.api#documentation": "

An object that contains details about an aggregation response based on Amazon ECR\n repositories.

" - } - }, - "titleAggregation": { - "target": "com.amazonaws.inspector2#TitleAggregationResponse", - "traits": { - "smithy.api#documentation": "

An object that contains details about an aggregation response based on finding title.

" - } - }, - "lambdaLayerAggregation": { - "target": "com.amazonaws.inspector2#LambdaLayerAggregationResponse", - "traits": { - "smithy.api#documentation": "

An aggregation of findings by Amazon Web Services Lambda layer.

" - } - }, - "lambdaFunctionAggregation": { - "target": "com.amazonaws.inspector2#LambdaFunctionAggregationResponse", - "traits": { - "smithy.api#documentation": "

An aggregation of findings by Amazon Web Services Lambda function.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains details about the results of an aggregation type.

" - } - }, - "com.amazonaws.inspector2#AggregationResponseList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#AggregationResponse" - } - }, - "com.amazonaws.inspector2#AggregationType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FINDING_TYPE", - "name": "FINDING_TYPE" - }, - { - "value": "PACKAGE", - "name": "PACKAGE" - }, - { - "value": "TITLE", - "name": "TITLE" - }, - { - "value": "REPOSITORY", - "name": "REPOSITORY" - }, - { - "value": "AMI", - "name": "AMI" - }, - { - "value": "AWS_EC2_INSTANCE", - "name": "AWS_EC2_INSTANCE" - }, - { - "value": "AWS_ECR_CONTAINER", - "name": "AWS_ECR_CONTAINER" - }, - { - "value": "IMAGE_LAYER", - "name": "IMAGE_LAYER" - }, - { - "value": "ACCOUNT", - "name": "ACCOUNT" - }, - { - "value": "AWS_LAMBDA_FUNCTION", - "name": "AWS_LAMBDA_FUNCTION" - }, - { - "value": "LAMBDA_LAYER", - "name": "LAMBDA_LAYER" - } - ] - } - }, - "com.amazonaws.inspector2#AmiAggregation": { - "type": "structure", - "members": { - "amis": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The IDs of AMIs to aggregate findings for.

" - } - }, - "sortOrder": { - "target": "com.amazonaws.inspector2#SortOrder", - "traits": { - "smithy.api#documentation": "

The order to sort results by.

" - } - }, - "sortBy": { - "target": "com.amazonaws.inspector2#AmiSortBy", - "traits": { - "smithy.api#documentation": "

The value to sort results by.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The details that define an aggregation based on Amazon machine images (AMIs).

" - } - }, - "com.amazonaws.inspector2#AmiAggregationResponse": { - "type": "structure", - "members": { - "ami": { - "target": "com.amazonaws.inspector2#AmiId", - "traits": { - "smithy.api#documentation": "

The ID of the AMI that findings were aggregated for.

", - "smithy.api#required": {} - } - }, - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID for the AMI.

" - } - }, - "severityCounts": { - "target": "com.amazonaws.inspector2#SeverityCounts", - "traits": { - "smithy.api#documentation": "

An object that contains the count of matched findings per severity.

" - } - }, - "affectedInstances": { - "target": "smithy.api#Long", - "traits": { - "smithy.api#documentation": "

The IDs of Amazon EC2 instances using this AMI.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A response that contains the results of a finding aggregation by AMI.

" - } - }, - "com.amazonaws.inspector2#AmiId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^ami-([a-z0-9]{8}|[a-z0-9]{17}|\\*)$" - } - }, - "com.amazonaws.inspector2#AmiSortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CRITICAL", - "name": "CRITICAL" - }, - { - "value": "HIGH", - "name": "HIGH" - }, - { - "value": "ALL", - "name": "ALL" - }, - { - "value": "AFFECTED_INSTANCES", - "name": "AFFECTED_INSTANCES" - } - ] - } - }, - "com.amazonaws.inspector2#Architecture": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "X86_64", - "name": "X86_64" - }, - { - "value": "ARM64", - "name": "ARM64" - } - ] - } - }, - "com.amazonaws.inspector2#ArchitectureList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#Architecture" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.inspector2#Arn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1011 - } - } - }, - "com.amazonaws.inspector2#AssociateMember": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#AssociateMemberRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#AssociateMemberResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Associates an Amazon Web Services account with an Amazon Inspector delegated administrator. An HTTP 200 response indicates the association was successfully started, but doesn’t indicate whether it was completed. You can check if the association completed by using ListMembers for multiple accounts or GetMembers for a single account.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/members/associate" - } - } - }, - "com.amazonaws.inspector2#AssociateMemberRequest": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the member account to be associated.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.inspector2#AssociateMemberResponse": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the successfully associated member account.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.inspector2#AtigData": { - "type": "structure", - "members": { - "firstSeen": { - "target": "com.amazonaws.inspector2#FirstSeen", - "traits": { - "smithy.api#documentation": "

The date and time this vulnerability was first observed.

" - } - }, - "lastSeen": { - "target": "com.amazonaws.inspector2#LastSeen", - "traits": { - "smithy.api#documentation": "

The date and time this vulnerability was last observed.

" - } - }, - "targets": { - "target": "com.amazonaws.inspector2#Targets", - "traits": { - "smithy.api#documentation": "

The commercial sectors this vulnerability targets.

" - } - }, - "ttps": { - "target": "com.amazonaws.inspector2#Ttps", - "traits": { - "smithy.api#documentation": "

The MITRE ATT&CK tactics, techniques, and procedures (TTPs) associated with vulnerability.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Threat Intel Group (ATIG) details for a specific vulnerability.

" - } - }, - "com.amazonaws.inspector2#AutoEnable": { - "type": "structure", - "members": { - "ec2": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Represents whether Amazon EC2 scans are automatically enabled for new members of your Amazon Inspector\n organization.

", - "smithy.api#required": {} - } - }, - "ecr": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Represents whether Amazon ECR scans are automatically enabled for new members of your Amazon Inspector\n organization.

", - "smithy.api#required": {} - } - }, - "lambda": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Represents whether Amazon Web Services Lambda standard scans are automatically enabled for new members of your Amazon Inspector organization.\n

" - } - }, - "lambdaCode": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Represents whether Lambda code scans are automatically enabled for new members of your Amazon Inspector organization.\n \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents which scan types are automatically enabled for new members of your Amazon Inspector organization.

" - } - }, - "com.amazonaws.inspector2#AwsEc2InstanceDetails": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The type of the Amazon EC2 instance.

" - } - }, - "imageId": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The image ID of the Amazon EC2 instance.

" - } - }, - "ipV4Addresses": { - "target": "com.amazonaws.inspector2#IpV4AddressList", - "traits": { - "smithy.api#documentation": "

The IPv4 addresses of the Amazon EC2 instance.

" - } - }, - "ipV6Addresses": { - "target": "com.amazonaws.inspector2#IpV6AddressList", - "traits": { - "smithy.api#documentation": "

The IPv6 addresses of the Amazon EC2 instance.

" - } - }, - "keyName": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the key pair used to launch the Amazon EC2 instance.

" - } - }, - "iamInstanceProfileArn": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The IAM instance profile ARN of the Amazon EC2 instance.

" - } - }, - "vpcId": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The VPC ID of the Amazon EC2 instance.

" - } - }, - "subnetId": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The subnet ID of the Amazon EC2 instance.

" - } - }, - "launchedAt": { - "target": "com.amazonaws.inspector2#DateTimeTimestamp", - "traits": { - "smithy.api#documentation": "

The date and time the Amazon EC2 instance was launched at.

" - } - }, - "platform": { - "target": "com.amazonaws.inspector2#Platform", - "traits": { - "smithy.api#documentation": "

The platform of the Amazon EC2 instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details of the Amazon EC2 instance involved in a finding.

" - } - }, - "com.amazonaws.inspector2#AwsEcrContainerAggregation": { - "type": "structure", - "members": { - "resourceIds": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The container resource IDs.

" - } - }, - "imageShas": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The image SHA values.

" - } - }, - "repositories": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The container repositories.

" - } - }, - "architectures": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The architecture of the containers.

" - } - }, - "imageTags": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The image tags.

" - } - }, - "sortOrder": { - "target": "com.amazonaws.inspector2#SortOrder", - "traits": { - "smithy.api#documentation": "

The sort order (ascending or descending).

" - } - }, - "sortBy": { - "target": "com.amazonaws.inspector2#AwsEcrContainerSortBy", - "traits": { - "smithy.api#documentation": "

The value to sort by.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An aggregation of information about Amazon ECR containers.

" - } - }, - "com.amazonaws.inspector2#AwsEcrContainerAggregationResponse": { - "type": "structure", - "members": { - "resourceId": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The resource ID of the container.

", - "smithy.api#required": {} - } - }, - "imageSha": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The SHA value of the container image.

" - } - }, - "repository": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The container repository.

" - } - }, - "architecture": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The architecture of the container.

" - } - }, - "imageTags": { - "target": "com.amazonaws.inspector2#StringList", - "traits": { - "smithy.api#documentation": "

The container image stags.

" - } - }, - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the account that owns the container.

" - } - }, - "severityCounts": { - "target": "com.amazonaws.inspector2#SeverityCounts", - "traits": { - "smithy.api#documentation": "

The number of finding by severity.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An aggregation of information about Amazon ECR containers.

" - } - }, - "com.amazonaws.inspector2#AwsEcrContainerImageDetails": { - "type": "structure", - "members": { - "repositoryName": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the repository the Amazon ECR container image resides in.

", - "smithy.api#required": {} - } - }, - "imageTags": { - "target": "com.amazonaws.inspector2#ImageTagList", - "traits": { - "smithy.api#documentation": "

The image tags attached to the Amazon ECR container image.

" - } - }, - "pushedAt": { - "target": "com.amazonaws.inspector2#DateTimeTimestamp", - "traits": { - "smithy.api#documentation": "

The date and time the Amazon ECR container image was pushed.

" - } - }, - "author": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The image author of the Amazon ECR container image.

" - } - }, - "architecture": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The architecture of the Amazon ECR container image.

" - } - }, - "imageHash": { - "target": "com.amazonaws.inspector2#ImageHash", - "traits": { - "smithy.api#documentation": "

The image hash of the Amazon ECR container image.

", - "smithy.api#required": {} - } - }, - "registry": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The registry for the Amazon ECR container image.

", - "smithy.api#required": {} - } - }, - "platform": { - "target": "com.amazonaws.inspector2#Platform", - "traits": { - "smithy.api#documentation": "

The platform of the Amazon ECR container image.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The image details of the Amazon ECR container image.

" - } - }, - "com.amazonaws.inspector2#AwsEcrContainerSortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CRITICAL", - "name": "CRITICAL" - }, - { - "value": "HIGH", - "name": "HIGH" - }, - { - "value": "ALL", - "name": "ALL" - } - ] - } - }, - "com.amazonaws.inspector2#AwsLambdaFunctionDetails": { - "type": "structure", - "members": { - "functionName": { - "target": "com.amazonaws.inspector2#FunctionName", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Web Services Lambda function.

", - "smithy.api#required": {} - } - }, - "runtime": { - "target": "com.amazonaws.inspector2#Runtime", - "traits": { - "smithy.api#documentation": "

The runtime environment for the Amazon Web Services Lambda function.

", - "smithy.api#required": {} - } - }, - "codeSha256": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The SHA256 hash of the Amazon Web Services Lambda function's deployment package.

", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.inspector2#Version", - "traits": { - "smithy.api#documentation": "

The version of the Amazon Web Services Lambda function.

", - "smithy.api#required": {} - } - }, - "executionRoleArn": { - "target": "com.amazonaws.inspector2#ExecutionRoleArn", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Lambda function's execution role.

", - "smithy.api#required": {} - } - }, - "layers": { - "target": "com.amazonaws.inspector2#LayerList", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Lambda function's \n layers. A Lambda function can have up to five layers.

" - } - }, - "vpcConfig": { - "target": "com.amazonaws.inspector2#LambdaVpcConfig", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Lambda function's networking configuration.

" - } - }, - "packageType": { - "target": "com.amazonaws.inspector2#PackageType", - "traits": { - "smithy.api#documentation": "

The type of deployment package. Set to Image for container image and set Zip for .zip file archive.

" - } - }, - "architectures": { - "target": "com.amazonaws.inspector2#ArchitectureList", - "traits": { - "smithy.api#documentation": "

The instruction set architecture that the Amazon Web Services Lambda function supports. Architecture is a string array with one of the \n valid values. The default architecture value is x86_64.

" - } - }, - "lastModifiedAt": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that a user last updated the configuration, in ISO 8601 format\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A summary of information about the Amazon Web Services Lambda function.

" - } - }, - "com.amazonaws.inspector2#BadRequestException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

One or more tags submitted as part of the request is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.inspector2#BatchGetAccountStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#BatchGetAccountStatusRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#BatchGetAccountStatusResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/status/batch/get" - } - } - }, - "com.amazonaws.inspector2#BatchGetAccountStatusRequest": { - "type": "structure", - "members": { - "accountIds": { - "target": "com.amazonaws.inspector2#AccountIdSet", - "traits": { - "smithy.api#documentation": "

The 12-digit Amazon Web Services account IDs of the accounts to retrieve Amazon Inspector status for.

" - } - } - } - }, - "com.amazonaws.inspector2#BatchGetAccountStatusResponse": { - "type": "structure", - "members": { - "accounts": { - "target": "com.amazonaws.inspector2#AccountStateList", - "traits": { - "smithy.api#documentation": "

An array of objects that provide details on the status of Amazon Inspector for each of the requested accounts.

", - "smithy.api#required": {} - } - }, - "failedAccounts": { - "target": "com.amazonaws.inspector2#FailedAccountList", - "traits": { - "smithy.api#documentation": "

An array of objects detailing any accounts that failed to enable Amazon Inspector and why.

" - } - } - } - }, - "com.amazonaws.inspector2#BatchGetCodeSnippet": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#BatchGetCodeSnippetRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#BatchGetCodeSnippetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves code snippets from findings that Amazon Inspector detected code vulnerabilities in.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/codesnippet/batchget" - } - } - }, - "com.amazonaws.inspector2#BatchGetCodeSnippetRequest": { - "type": "structure", - "members": { - "findingArns": { - "target": "com.amazonaws.inspector2#FindingArns", - "traits": { - "smithy.api#documentation": "

An array of finding ARNs for the findings you want to retrieve code snippets from.

", - "smithy.api#length": { - "min": 1, - "max": 10 - }, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#BatchGetCodeSnippetResponse": { - "type": "structure", - "members": { - "codeSnippetResults": { - "target": "com.amazonaws.inspector2#CodeSnippetResultList", - "traits": { - "smithy.api#documentation": "

The retrieved code snippets associated with the provided finding ARNs.

" - } - }, - "errors": { - "target": "com.amazonaws.inspector2#CodeSnippetErrorList", - "traits": { - "smithy.api#documentation": "

Any errors Amazon Inspector encountered while trying to retrieve the requested code snippets.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#BatchGetFindingDetails": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#BatchGetFindingDetailsRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#BatchGetFindingDetailsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets vulnerability details for findings.

", - "smithy.api#examples": [ - { - "title": "Sample BatchGetFindingDetails Call", + "smithy": "2.0", + "shapes": { + "com.amazonaws.inspector2#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

You do not have sufficient access to perform this action.

\n

\n For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.inspector2#Account": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.inspector2#Status", + "traits": { + "smithy.api#documentation": "

The status of Amazon Inspector for the account.

", + "smithy.api#required": {} + } + }, + "resourceStatus": { + "target": "com.amazonaws.inspector2#ResourceStatus", + "traits": { + "smithy.api#documentation": "

Details of the status of Amazon Inspector scans by resource type.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An Amazon Web Services account within your environment that Amazon Inspector has been enabled for.

" + } + }, + "com.amazonaws.inspector2#AccountAggregation": { + "type": "structure", + "members": { + "findingType": { + "target": "com.amazonaws.inspector2#AggregationFindingType", + "traits": { + "smithy.api#documentation": "

The type of finding.

" + } + }, + "resourceType": { + "target": "com.amazonaws.inspector2#AggregationResourceType", + "traits": { + "smithy.api#documentation": "

The type of resource.

" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order (ascending or descending).

" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#AccountSortBy", + "traits": { + "smithy.api#documentation": "

The value to sort by.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains details about an aggregation response based on\n Amazon Web Services accounts.

" + } + }, + "com.amazonaws.inspector2#AccountAggregationResponse": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

" + } + }, + "severityCounts": { + "target": "com.amazonaws.inspector2#SeverityCounts", + "traits": { + "smithy.api#documentation": "

The number of findings by severity.

" + } + }, + "exploitAvailableCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

\n The number of findings that have an exploit available.\n

" + } + }, + "fixAvailableCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

\n Details about the number of fixes.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An aggregation of findings by Amazon Web Services account ID.

" + } + }, + "com.amazonaws.inspector2#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^\\d{12}$" + } + }, + "com.amazonaws.inspector2#AccountIdFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisStringFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#AccountIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#AccountId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.inspector2#AccountList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Account" + } + }, + "com.amazonaws.inspector2#AccountSortBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CRITICAL", + "name": "CRITICAL" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "ALL", + "name": "ALL" + } + ] + } + }, + "com.amazonaws.inspector2#AccountState": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.inspector2#State", + "traits": { + "smithy.api#documentation": "

An object detailing the status of Amazon Inspector for the account.

", + "smithy.api#required": {} + } + }, + "resourceState": { + "target": "com.amazonaws.inspector2#ResourceState", + "traits": { + "smithy.api#documentation": "

An object detailing which resources Amazon Inspector is enabled to scan for the account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object with details the status of an Amazon Web Services account within your Amazon Inspector environment.

" + } + }, + "com.amazonaws.inspector2#AccountStateList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#AccountState" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.inspector2#AggCounts": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.inspector2#AggregationFindingType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NETWORK_REACHABILITY", + "name": "NETWORK_REACHABILITY" + }, + { + "value": "PACKAGE_VULNERABILITY", + "name": "PACKAGE_VULNERABILITY" + }, + { + "value": "CODE_VULNERABILITY", + "name": "CODE_VULNERABILITY" + } + ] + } + }, + "com.amazonaws.inspector2#AggregationRequest": { + "type": "union", + "members": { + "accountAggregation": { + "target": "com.amazonaws.inspector2#AccountAggregation", + "traits": { + "smithy.api#documentation": "

An object that contains details about an aggregation request based on Amazon Web Services account\n IDs.

" + } + }, + "amiAggregation": { + "target": "com.amazonaws.inspector2#AmiAggregation", + "traits": { + "smithy.api#documentation": "

An object that contains details about an aggregation request based on Amazon Machine\n Images (AMIs).

" + } + }, + "awsEcrContainerAggregation": { + "target": "com.amazonaws.inspector2#AwsEcrContainerAggregation", + "traits": { + "smithy.api#documentation": "

An object that contains details about an aggregation request based on Amazon ECR container\n images.

" + } + }, + "ec2InstanceAggregation": { + "target": "com.amazonaws.inspector2#Ec2InstanceAggregation", + "traits": { + "smithy.api#documentation": "

An object that contains details about an aggregation request based on Amazon EC2\n instances.

" + } + }, + "findingTypeAggregation": { + "target": "com.amazonaws.inspector2#FindingTypeAggregation", + "traits": { + "smithy.api#documentation": "

An object that contains details about an aggregation request based on finding types.

" + } + }, + "imageLayerAggregation": { + "target": "com.amazonaws.inspector2#ImageLayerAggregation", + "traits": { + "smithy.api#documentation": "

An object that contains details about an aggregation request based on container image\n layers.

" + } + }, + "packageAggregation": { + "target": "com.amazonaws.inspector2#PackageAggregation", + "traits": { + "smithy.api#documentation": "

An object that contains details about an aggregation request based on operating system\n package type.

" + } + }, + "repositoryAggregation": { + "target": "com.amazonaws.inspector2#RepositoryAggregation", + "traits": { + "smithy.api#documentation": "

An object that contains details about an aggregation request based on Amazon ECR repositories.

" + } + }, + "titleAggregation": { + "target": "com.amazonaws.inspector2#TitleAggregation", + "traits": { + "smithy.api#documentation": "

An object that contains details about an aggregation request based on finding title.

" + } + }, + "lambdaLayerAggregation": { + "target": "com.amazonaws.inspector2#LambdaLayerAggregation", + "traits": { + "smithy.api#documentation": "

Returns an object with findings aggregated by Amazon Web Services Lambda layer.

" + } + }, + "lambdaFunctionAggregation": { + "target": "com.amazonaws.inspector2#LambdaFunctionAggregation", + "traits": { + "smithy.api#documentation": "

Returns an object with findings aggregated by Amazon Web Services Lambda function.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about an aggregation request.

" + } + }, + "com.amazonaws.inspector2#AggregationResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWS_EC2_INSTANCE", + "name": "AWS_EC2_INSTANCE" + }, + { + "value": "AWS_ECR_CONTAINER_IMAGE", + "name": "AWS_ECR_CONTAINER_IMAGE" + }, + { + "value": "AWS_LAMBDA_FUNCTION", + "name": "AWS_LAMBDA_FUNCTION" + } + ] + } + }, + "com.amazonaws.inspector2#AggregationResponse": { + "type": "union", + "members": { + "accountAggregation": { + "target": "com.amazonaws.inspector2#AccountAggregationResponse", + "traits": { + "smithy.api#documentation": "

An object that contains details about an aggregation response based on Amazon Web Services account\n IDs.

" + } + }, + "amiAggregation": { + "target": "com.amazonaws.inspector2#AmiAggregationResponse", + "traits": { + "smithy.api#documentation": "

An object that contains details about an aggregation response based on Amazon Machine\n Images (AMIs).

" + } + }, + "awsEcrContainerAggregation": { + "target": "com.amazonaws.inspector2#AwsEcrContainerAggregationResponse", + "traits": { + "smithy.api#documentation": "

An object that contains details about an aggregation response based on Amazon ECR container\n images.

" + } + }, + "ec2InstanceAggregation": { + "target": "com.amazonaws.inspector2#Ec2InstanceAggregationResponse", + "traits": { + "smithy.api#documentation": "

An object that contains details about an aggregation response based on Amazon EC2\n instances.

" + } + }, + "findingTypeAggregation": { + "target": "com.amazonaws.inspector2#FindingTypeAggregationResponse", + "traits": { + "smithy.api#documentation": "

An object that contains details about an aggregation response based on finding types.

" + } + }, + "imageLayerAggregation": { + "target": "com.amazonaws.inspector2#ImageLayerAggregationResponse", + "traits": { + "smithy.api#documentation": "

An object that contains details about an aggregation response based on container image\n layers.

" + } + }, + "packageAggregation": { + "target": "com.amazonaws.inspector2#PackageAggregationResponse", + "traits": { + "smithy.api#documentation": "

An object that contains details about an aggregation response based on operating system\n package type.

" + } + }, + "repositoryAggregation": { + "target": "com.amazonaws.inspector2#RepositoryAggregationResponse", + "traits": { + "smithy.api#documentation": "

An object that contains details about an aggregation response based on Amazon ECR\n repositories.

" + } + }, + "titleAggregation": { + "target": "com.amazonaws.inspector2#TitleAggregationResponse", + "traits": { + "smithy.api#documentation": "

An object that contains details about an aggregation response based on finding title.

" + } + }, + "lambdaLayerAggregation": { + "target": "com.amazonaws.inspector2#LambdaLayerAggregationResponse", + "traits": { + "smithy.api#documentation": "

An aggregation of findings by Amazon Web Services Lambda layer.

" + } + }, + "lambdaFunctionAggregation": { + "target": "com.amazonaws.inspector2#LambdaFunctionAggregationResponse", + "traits": { + "smithy.api#documentation": "

An aggregation of findings by Amazon Web Services Lambda function.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains details about the results of an aggregation type.

" + } + }, + "com.amazonaws.inspector2#AggregationResponseList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#AggregationResponse" + } + }, + "com.amazonaws.inspector2#AggregationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FINDING_TYPE", + "name": "FINDING_TYPE" + }, + { + "value": "PACKAGE", + "name": "PACKAGE" + }, + { + "value": "TITLE", + "name": "TITLE" + }, + { + "value": "REPOSITORY", + "name": "REPOSITORY" + }, + { + "value": "AMI", + "name": "AMI" + }, + { + "value": "AWS_EC2_INSTANCE", + "name": "AWS_EC2_INSTANCE" + }, + { + "value": "AWS_ECR_CONTAINER", + "name": "AWS_ECR_CONTAINER" + }, + { + "value": "IMAGE_LAYER", + "name": "IMAGE_LAYER" + }, + { + "value": "ACCOUNT", + "name": "ACCOUNT" + }, + { + "value": "AWS_LAMBDA_FUNCTION", + "name": "AWS_LAMBDA_FUNCTION" + }, + { + "value": "LAMBDA_LAYER", + "name": "LAMBDA_LAYER" + } + ] + } + }, + "com.amazonaws.inspector2#AmiAggregation": { + "type": "structure", + "members": { + "amis": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The IDs of AMIs to aggregate findings for.

" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#SortOrder", + "traits": { + "smithy.api#documentation": "

The order to sort results by.

" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#AmiSortBy", + "traits": { + "smithy.api#documentation": "

The value to sort results by.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details that define an aggregation based on Amazon machine images (AMIs).

" + } + }, + "com.amazonaws.inspector2#AmiAggregationResponse": { + "type": "structure", + "members": { + "ami": { + "target": "com.amazonaws.inspector2#AmiId", + "traits": { + "smithy.api#documentation": "

The ID of the AMI that findings were aggregated for.

", + "smithy.api#required": {} + } + }, + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID for the AMI.

" + } + }, + "severityCounts": { + "target": "com.amazonaws.inspector2#SeverityCounts", + "traits": { + "smithy.api#documentation": "

An object that contains the count of matched findings per severity.

" + } + }, + "affectedInstances": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The IDs of Amazon EC2 instances using this AMI.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A response that contains the results of a finding aggregation by AMI.

" + } + }, + "com.amazonaws.inspector2#AmiId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^ami-([a-z0-9]{8}|[a-z0-9]{17}|\\*)$" + } + }, + "com.amazonaws.inspector2#AmiSortBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CRITICAL", + "name": "CRITICAL" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "ALL", + "name": "ALL" + }, + { + "value": "AFFECTED_INSTANCES", + "name": "AFFECTED_INSTANCES" + } + ] + } + }, + "com.amazonaws.inspector2#Architecture": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "X86_64", + "name": "X86_64" + }, + { + "value": "ARM64", + "name": "ARM64" + } + ] + } + }, + "com.amazonaws.inspector2#ArchitectureList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Architecture" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.inspector2#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + } + } + }, + "com.amazonaws.inspector2#AssociateMember": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#AssociateMemberRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#AssociateMemberResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates an Amazon Web Services account with an Amazon Inspector delegated administrator. An HTTP 200 response indicates the association was successfully started, but doesn’t indicate whether it was completed. You can check if the association completed by using ListMembers for multiple accounts or GetMembers for a single account.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/members/associate" + } + } + }, + "com.amazonaws.inspector2#AssociateMemberRequest": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the member account to be associated.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#AssociateMemberResponse": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the successfully associated member account.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#AtigData": { + "type": "structure", + "members": { + "firstSeen": { + "target": "com.amazonaws.inspector2#FirstSeen", + "traits": { + "smithy.api#documentation": "

The date and time this vulnerability was first observed.

" + } + }, + "lastSeen": { + "target": "com.amazonaws.inspector2#LastSeen", + "traits": { + "smithy.api#documentation": "

The date and time this vulnerability was last observed.

" + } + }, + "targets": { + "target": "com.amazonaws.inspector2#Targets", + "traits": { + "smithy.api#documentation": "

The commercial sectors this vulnerability targets.

" + } + }, + "ttps": { + "target": "com.amazonaws.inspector2#Ttps", + "traits": { + "smithy.api#documentation": "

The MITRE ATT&CK tactics, techniques, and procedures (TTPs) associated with vulnerability.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Threat Intel Group (ATIG) details for a specific vulnerability.

" + } + }, + "com.amazonaws.inspector2#AutoEnable": { + "type": "structure", + "members": { + "ec2": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Represents whether Amazon EC2 scans are automatically enabled for new members of your Amazon Inspector\n organization.

", + "smithy.api#required": {} + } + }, + "ecr": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Represents whether Amazon ECR scans are automatically enabled for new members of your Amazon Inspector\n organization.

", + "smithy.api#required": {} + } + }, + "lambda": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Represents whether Amazon Web Services Lambda standard scans are automatically enabled for new members of your Amazon Inspector organization.\n

" + } + }, + "lambdaCode": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Represents whether Lambda code scans are automatically enabled for new members of your Amazon Inspector organization.\n \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents which scan types are automatically enabled for new members of your Amazon Inspector organization.

" + } + }, + "com.amazonaws.inspector2#AwsEc2InstanceDetails": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of the Amazon EC2 instance.

" + } + }, + "imageId": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The image ID of the Amazon EC2 instance.

" + } + }, + "ipV4Addresses": { + "target": "com.amazonaws.inspector2#IpV4AddressList", + "traits": { + "smithy.api#documentation": "

The IPv4 addresses of the Amazon EC2 instance.

" + } + }, + "ipV6Addresses": { + "target": "com.amazonaws.inspector2#IpV6AddressList", + "traits": { + "smithy.api#documentation": "

The IPv6 addresses of the Amazon EC2 instance.

" + } + }, + "keyName": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the key pair used to launch the Amazon EC2 instance.

" + } + }, + "iamInstanceProfileArn": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IAM instance profile ARN of the Amazon EC2 instance.

" + } + }, + "vpcId": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The VPC ID of the Amazon EC2 instance.

" + } + }, + "subnetId": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The subnet ID of the Amazon EC2 instance.

" + } + }, + "launchedAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time the Amazon EC2 instance was launched at.

" + } + }, + "platform": { + "target": "com.amazonaws.inspector2#Platform", + "traits": { + "smithy.api#documentation": "

The platform of the Amazon EC2 instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details of the Amazon EC2 instance involved in a finding.

" + } + }, + "com.amazonaws.inspector2#AwsEcrContainerAggregation": { + "type": "structure", + "members": { + "resourceIds": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The container resource IDs.

" + } + }, + "imageShas": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The image SHA values.

" + } + }, + "repositories": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The container repositories.

" + } + }, + "architectures": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The architecture of the containers.

" + } + }, + "imageTags": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The image tags.

" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#SortOrder", + "traits": { + "smithy.api#documentation": "

The sort order (ascending or descending).

" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#AwsEcrContainerSortBy", + "traits": { + "smithy.api#documentation": "

The value to sort by.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An aggregation of information about Amazon ECR containers.

" + } + }, + "com.amazonaws.inspector2#AwsEcrContainerAggregationResponse": { + "type": "structure", + "members": { + "resourceId": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The resource ID of the container.

", + "smithy.api#required": {} + } + }, + "imageSha": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The SHA value of the container image.

" + } + }, + "repository": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The container repository.

" + } + }, + "architecture": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The architecture of the container.

" + } + }, + "imageTags": { + "target": "com.amazonaws.inspector2#StringList", + "traits": { + "smithy.api#documentation": "

The container image stags.

" + } + }, + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the account that owns the container.

" + } + }, + "severityCounts": { + "target": "com.amazonaws.inspector2#SeverityCounts", + "traits": { + "smithy.api#documentation": "

The number of finding by severity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An aggregation of information about Amazon ECR containers.

" + } + }, + "com.amazonaws.inspector2#AwsEcrContainerImageDetails": { + "type": "structure", + "members": { + "repositoryName": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the repository the Amazon ECR container image resides in.

", + "smithy.api#required": {} + } + }, + "imageTags": { + "target": "com.amazonaws.inspector2#ImageTagList", + "traits": { + "smithy.api#documentation": "

The image tags attached to the Amazon ECR container image.

" + } + }, + "pushedAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time the Amazon ECR container image was pushed.

" + } + }, + "author": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The image author of the Amazon ECR container image.

" + } + }, + "architecture": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The architecture of the Amazon ECR container image.

" + } + }, + "imageHash": { + "target": "com.amazonaws.inspector2#ImageHash", + "traits": { + "smithy.api#documentation": "

The image hash of the Amazon ECR container image.

", + "smithy.api#required": {} + } + }, + "registry": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The registry for the Amazon ECR container image.

", + "smithy.api#required": {} + } + }, + "platform": { + "target": "com.amazonaws.inspector2#Platform", + "traits": { + "smithy.api#documentation": "

The platform of the Amazon ECR container image.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The image details of the Amazon ECR container image.

" + } + }, + "com.amazonaws.inspector2#AwsEcrContainerSortBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CRITICAL", + "name": "CRITICAL" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "ALL", + "name": "ALL" + } + ] + } + }, + "com.amazonaws.inspector2#AwsLambdaFunctionDetails": { + "type": "structure", + "members": { + "functionName": { + "target": "com.amazonaws.inspector2#FunctionName", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Web Services Lambda function.

", + "smithy.api#required": {} + } + }, + "runtime": { + "target": "com.amazonaws.inspector2#Runtime", + "traits": { + "smithy.api#documentation": "

The runtime environment for the Amazon Web Services Lambda function.

", + "smithy.api#required": {} + } + }, + "codeSha256": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The SHA256 hash of the Amazon Web Services Lambda function's deployment package.

", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.inspector2#Version", + "traits": { + "smithy.api#documentation": "

The version of the Amazon Web Services Lambda function.

", + "smithy.api#required": {} + } + }, + "executionRoleArn": { + "target": "com.amazonaws.inspector2#ExecutionRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Lambda function's execution role.

", + "smithy.api#required": {} + } + }, + "layers": { + "target": "com.amazonaws.inspector2#LayerList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Lambda function's \n layers. A Lambda function can have up to five layers.

" + } + }, + "vpcConfig": { + "target": "com.amazonaws.inspector2#LambdaVpcConfig", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Lambda function's networking configuration.

" + } + }, + "packageType": { + "target": "com.amazonaws.inspector2#PackageType", + "traits": { + "smithy.api#documentation": "

The type of deployment package. Set to Image for container image and set Zip for .zip file archive.

" + } + }, + "architectures": { + "target": "com.amazonaws.inspector2#ArchitectureList", + "traits": { + "smithy.api#documentation": "

The instruction set architecture that the Amazon Web Services Lambda function supports. Architecture is a string array with one of the \n valid values. The default architecture value is x86_64.

" + } + }, + "lastModifiedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that a user last updated the configuration, in ISO 8601 format\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of information about the Amazon Web Services Lambda function.

" + } + }, + "com.amazonaws.inspector2#BadRequestException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

One or more tags submitted as part of the request is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.inspector2#BatchGetAccountStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#BatchGetAccountStatusRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#BatchGetAccountStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/status/batch/get" + } + } + }, + "com.amazonaws.inspector2#BatchGetAccountStatusRequest": { + "type": "structure", + "members": { + "accountIds": { + "target": "com.amazonaws.inspector2#AccountIdSet", + "traits": { + "smithy.api#documentation": "

The 12-digit Amazon Web Services account IDs of the accounts to retrieve Amazon Inspector status for.

" + } + } + } + }, + "com.amazonaws.inspector2#BatchGetAccountStatusResponse": { + "type": "structure", + "members": { + "accounts": { + "target": "com.amazonaws.inspector2#AccountStateList", + "traits": { + "smithy.api#documentation": "

An array of objects that provide details on the status of Amazon Inspector for each of the requested accounts.

", + "smithy.api#required": {} + } + }, + "failedAccounts": { + "target": "com.amazonaws.inspector2#FailedAccountList", + "traits": { + "smithy.api#documentation": "

An array of objects detailing any accounts that failed to enable Amazon Inspector and why.

" + } + } + } + }, + "com.amazonaws.inspector2#BatchGetCodeSnippet": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#BatchGetCodeSnippetRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#BatchGetCodeSnippetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves code snippets from findings that Amazon Inspector detected code vulnerabilities in.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/codesnippet/batchget" + } + } + }, + "com.amazonaws.inspector2#BatchGetCodeSnippetRequest": { + "type": "structure", + "members": { + "findingArns": { + "target": "com.amazonaws.inspector2#FindingArns", + "traits": { + "smithy.api#documentation": "

An array of finding ARNs for the findings you want to retrieve code snippets from.

", + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#BatchGetCodeSnippetResponse": { + "type": "structure", + "members": { + "codeSnippetResults": { + "target": "com.amazonaws.inspector2#CodeSnippetResultList", + "traits": { + "smithy.api#documentation": "

The retrieved code snippets associated with the provided finding ARNs.

" + } + }, + "errors": { + "target": "com.amazonaws.inspector2#CodeSnippetErrorList", + "traits": { + "smithy.api#documentation": "

Any errors Amazon Inspector encountered while trying to retrieve the requested code snippets.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.inspector2#BatchGetFindingDetails": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#BatchGetFindingDetailsRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#BatchGetFindingDetailsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets vulnerability details for findings.

", + "smithy.api#examples": [ + { + "title": "Sample BatchGetFindingDetails Call", + "input": { + "findingArns": [ + "arn:aws:inspector2:eu-west-1:123456789012:finding/78b88cc9aa1d78b6e14fde90d774dde7", + "arn:aws:inspector2:eu-west-1:111111111111:finding/78b88cc9aa1d78b6e14fde90d874dde7" + ] + }, + "output": { + "findingDetails": [ + { + "findingArn": "arn:aws:inspector2:eu-west-1:123456789012:finding/78b88cc9aa1d78b6e14fde90d774dde7", + "cisaData": { + "dateAdded": 1688580990, + "dateDue": 1688580999, + "action": "For all affected software assets for which updates exist, the only acceptable remediation actions are: 1) Apply updates; OR 2) remove affected assets from agency networks." + }, + "riskScore": 66, + "evidences": [ + { + "evidenceRule": "Historically Linked to Penetration Testing Tools", + "evidenceDetail": "2 sightings on 1 source", + "severity": "Low" + } + ], + "ttps": [ + "TA0001", + "TA0002" + ], + "tools": [ + "Metasploit" + ], + "exploitObserved": { + "lastSeen": 1688580990, + "firstSeen": 1688580800 + }, + "referenceUrls": [ + "https://nvd.nist.gov/vuln/detail/CVE-2019-20367" + ], + "cwes": [ + "cwe-1234" + ], + "epssScore": 0.85 + } + ], + "errors": [ + { + "findingArn": "arn:aws:inspector2:eu-west-1:111111111111:finding/78b88cc9aa1d78b6e14fde90d874dde7", + "errorCode": "ACCESS_DENIED", + "errorMessage": "You don't have permission to access this finding" + } + ] + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/findings/details/batch/get" + } + } + }, + "com.amazonaws.inspector2#BatchGetFindingDetailsRequest": { + "type": "structure", + "members": { + "findingArns": { + "target": "com.amazonaws.inspector2#FindingArnList", + "traits": { + "smithy.api#documentation": "

A list of finding ARNs.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#BatchGetFindingDetailsResponse": { + "type": "structure", + "members": { + "findingDetails": { + "target": "com.amazonaws.inspector2#FindingDetails", + "traits": { + "smithy.api#documentation": "

A finding's vulnerability details.

" + } + }, + "errors": { + "target": "com.amazonaws.inspector2#FindingDetailsErrorList", + "traits": { + "smithy.api#documentation": "

Error information for findings that details could not be returned for.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.inspector2#BatchGetFreeTrialInfo": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#BatchGetFreeTrialInfoRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#BatchGetFreeTrialInfoResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets free trial status for multiple Amazon Web Services accounts.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/freetrialinfo/batchget" + } + } + }, + "com.amazonaws.inspector2#BatchGetFreeTrialInfoRequest": { + "type": "structure", + "members": { + "accountIds": { + "target": "com.amazonaws.inspector2#MeteringAccountIdList", + "traits": { + "smithy.api#documentation": "

The account IDs to get free trial status for.

", + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#BatchGetFreeTrialInfoResponse": { + "type": "structure", + "members": { + "accounts": { + "target": "com.amazonaws.inspector2#FreeTrialAccountInfoList", + "traits": { + "smithy.api#documentation": "

An array of objects that provide Amazon Inspector free trial details for each of the requested accounts.\n

", + "smithy.api#required": {} + } + }, + "failedAccounts": { + "target": "com.amazonaws.inspector2#FreeTrialInfoErrorList", + "traits": { + "smithy.api#documentation": "

An array of objects detailing any accounts that free trial data could not be returned for.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#BatchGetMemberEc2DeepInspectionStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#BatchGetMemberEc2DeepInspectionStatusRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#BatchGetMemberEc2DeepInspectionStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves Amazon Inspector deep inspection activation status of multiple member accounts within your organization. You must be the delegated administrator of an organization in Amazon Inspector to use this API.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/ec2deepinspectionstatus/member/batch/get" + } + } + }, + "com.amazonaws.inspector2#BatchGetMemberEc2DeepInspectionStatusRequest": { + "type": "structure", + "members": { + "accountIds": { + "target": "com.amazonaws.inspector2#AccountIdSet", + "traits": { + "smithy.api#documentation": "

The unique identifiers for the Amazon Web Services accounts to retrieve Amazon Inspector deep inspection activation status for.\n \n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#BatchGetMemberEc2DeepInspectionStatusResponse": { + "type": "structure", + "members": { + "accountIds": { + "target": "com.amazonaws.inspector2#MemberAccountEc2DeepInspectionStatusStateList", + "traits": { + "smithy.api#documentation": "

An array of objects that provide details on the activation status of Amazon Inspector deep inspection for each of the requested accounts.\n \n

" + } + }, + "failedAccountIds": { + "target": "com.amazonaws.inspector2#FailedMemberAccountEc2DeepInspectionStatusStateList", + "traits": { + "smithy.api#documentation": "

An array of objects that provide details on any accounts that failed to activate Amazon Inspector deep inspection and why.\n \n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.inspector2#BatchUpdateMemberEc2DeepInspectionStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#BatchUpdateMemberEc2DeepInspectionStatusRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#BatchUpdateMemberEc2DeepInspectionStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Activates or deactivates Amazon Inspector deep inspection for the provided member accounts in your organization. You must be the delegated administrator of an organization in Amazon Inspector to use this API.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/ec2deepinspectionstatus/member/batch/update" + } + } + }, + "com.amazonaws.inspector2#BatchUpdateMemberEc2DeepInspectionStatusRequest": { + "type": "structure", + "members": { + "accountIds": { + "target": "com.amazonaws.inspector2#MemberAccountEc2DeepInspectionStatusList", + "traits": { + "smithy.api#documentation": "

The unique identifiers for the Amazon Web Services accounts to change Amazon Inspector deep inspection status for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#BatchUpdateMemberEc2DeepInspectionStatusResponse": { + "type": "structure", + "members": { + "accountIds": { + "target": "com.amazonaws.inspector2#MemberAccountEc2DeepInspectionStatusStateList", + "traits": { + "smithy.api#documentation": "

An array of objects that provide details for each of the accounts that Amazon Inspector deep inspection status was successfully changed for. \n

" + } + }, + "failedAccountIds": { + "target": "com.amazonaws.inspector2#FailedMemberAccountEc2DeepInspectionStatusStateList", + "traits": { + "smithy.api#documentation": "

An array of objects that provide details for each of the accounts that Amazon Inspector deep inspection status could not be successfully changed for. \n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.inspector2#BenchmarkProfile": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 128 + } + } + }, + "com.amazonaws.inspector2#BenchmarkVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 8 + } + } + }, + "com.amazonaws.inspector2#CancelFindingsReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#CancelFindingsReportRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#CancelFindingsReportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels the given findings report.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/reporting/cancel" + } + } + }, + "com.amazonaws.inspector2#CancelFindingsReportRequest": { + "type": "structure", + "members": { + "reportId": { + "target": "com.amazonaws.inspector2#ReportId", + "traits": { + "smithy.api#documentation": "

The ID of the report to be canceled.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#CancelFindingsReportResponse": { + "type": "structure", + "members": { + "reportId": { + "target": "com.amazonaws.inspector2#ReportId", + "traits": { + "smithy.api#documentation": "

The ID of the canceled report.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#CancelSbomExport": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#CancelSbomExportRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#CancelSbomExportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels a software bill of materials (SBOM) report.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/sbomexport/cancel" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.inspector2#CancelSbomExportRequest": { + "type": "structure", + "members": { + "reportId": { + "target": "com.amazonaws.inspector2#ReportId", + "traits": { + "smithy.api#documentation": "

The report ID of the SBOM export to cancel.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#CancelSbomExportResponse": { + "type": "structure", + "members": { + "reportId": { + "target": "com.amazonaws.inspector2#ReportId", + "traits": { + "smithy.api#documentation": "

The report ID of the canceled SBOM export.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.inspector2#CheckCount": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 65536 + } + } + }, + "com.amazonaws.inspector2#CheckIdFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisStringFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#CisAccountIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#AccountId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.inspector2#CisCheckAggregation": { + "type": "structure", + "members": { + "scanArn": { + "target": "com.amazonaws.inspector2#CisScanArn", + "traits": { + "smithy.api#documentation": "

The scan ARN for the CIS check scan ARN.

", + "smithy.api#required": {} + } + }, + "checkId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The check ID for the CIS check.

" + } + }, + "title": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The CIS check title.

" + } + }, + "checkDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The description for the CIS check.

" + } + }, + "level": { + "target": "com.amazonaws.inspector2#CisSecurityLevel", + "traits": { + "smithy.api#documentation": "

The CIS check level.

" + } + }, + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID for the CIS check.

" + } + }, + "statusCounts": { + "target": "com.amazonaws.inspector2#StatusCounts", + "traits": { + "smithy.api#documentation": "

The CIS check status counts.

" + } + }, + "platform": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The CIS check platform.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A CIS check.

" + } + }, + "com.amazonaws.inspector2#CisCheckAggregationList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisCheckAggregation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.inspector2#CisDateFilter": { + "type": "structure", + "members": { + "earliestScanStartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The CIS date filter's earliest scan start time.

" + } + }, + "latestScanStartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The CIS date filter's latest scan start time.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The CIS date filter.

" + } + }, + "com.amazonaws.inspector2#CisFindingArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(-gov|-cn)?:inspector2:[-.a-z0-9]{0,20}:\\d{12}:owner/\\d{12}/cis-finding/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + } + }, + "com.amazonaws.inspector2#CisFindingArnFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisStringFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#CisFindingStatus": { + "type": "enum", + "members": { + "PASSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "SKIPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKIPPED" + } + } + } + }, + "com.amazonaws.inspector2#CisFindingStatusComparison": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + } + } + }, + "com.amazonaws.inspector2#CisFindingStatusFilter": { + "type": "structure", + "members": { + "comparison": { + "target": "com.amazonaws.inspector2#CisFindingStatusComparison", + "traits": { + "smithy.api#documentation": "

The comparison value of the CIS finding status filter.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.inspector2#CisFindingStatus", + "traits": { + "smithy.api#documentation": "

The value of the CIS finding status filter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The CIS finding status filter.

" + } + }, + "com.amazonaws.inspector2#CisFindingStatusFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisFindingStatusFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.inspector2#CisNumberFilter": { + "type": "structure", + "members": { + "upperInclusive": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The CIS number filter's upper inclusive.

" + } + }, + "lowerInclusive": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The CIS number filter's lower inclusive.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The CIS number filter.

" + } + }, + "com.amazonaws.inspector2#CisNumberFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisNumberFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.inspector2#CisOwnerId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\d{12}|o-[a-z0-9]{10,32}$" + } + }, + "com.amazonaws.inspector2#CisReportFormat": { + "type": "enum", + "members": { + "PDF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PDF" + } + }, + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + } + } + }, + "com.amazonaws.inspector2#CisReportStatus": { + "type": "enum", + "members": { + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + } + } + }, + "com.amazonaws.inspector2#CisResultStatus": { + "type": "enum", + "members": { + "PASSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "SKIPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKIPPED" + } + } + } + }, + "com.amazonaws.inspector2#CisResultStatusComparison": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + } + } + }, + "com.amazonaws.inspector2#CisResultStatusFilter": { + "type": "structure", + "members": { + "comparison": { + "target": "com.amazonaws.inspector2#CisResultStatusComparison", + "traits": { + "smithy.api#documentation": "

The comparison value of the CIS result status filter.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.inspector2#CisResultStatus", + "traits": { + "smithy.api#documentation": "

The value of the CIS result status filter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The CIS result status filter.

" + } + }, + "com.amazonaws.inspector2#CisResultStatusFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisResultStatusFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#CisRuleDetails": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.inspector2#CisRuleStatus": { + "type": "enum", + "members": { + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "PASSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSED" + } + }, + "NOT_EVALUATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_EVALUATED" + } + }, + "INFORMATIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFORMATIONAL" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } + }, + "NOT_APPLICABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_APPLICABLE" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + } + } + }, + "com.amazonaws.inspector2#CisScan": { + "type": "structure", + "members": { + "scanArn": { + "target": "com.amazonaws.inspector2#CisScanArn", + "traits": { + "smithy.api#documentation": "

The CIS scan's ARN.

", + "smithy.api#required": {} + } + }, + "scanConfigurationArn": { + "target": "com.amazonaws.inspector2#CisScanConfigurationArn", + "traits": { + "smithy.api#documentation": "

The CIS scan's configuration ARN.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.inspector2#CisScanStatus", + "traits": { + "smithy.api#documentation": "

The CIS scan's status.

" + } + }, + "scanName": { + "target": "com.amazonaws.inspector2#CisScanName", + "traits": { + "smithy.api#documentation": "

The the name of the scan configuration that's associated with this scan.

" + } + }, + "scanDate": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The CIS scan's date.

" + } + }, + "failedChecks": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The CIS scan's failed checks.

" + } + }, + "totalChecks": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The CIS scan's total checks.

" + } + }, + "targets": { + "target": "com.amazonaws.inspector2#CisTargets", + "traits": { + "smithy.api#documentation": "

The CIS scan's targets.

" + } + }, + "scheduledBy": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The account or organization that schedules the CIS scan.

" + } + }, + "securityLevel": { + "target": "com.amazonaws.inspector2#CisSecurityLevel", + "traits": { + "smithy.api#documentation": "

\n The security level for the CIS scan. \n Security level refers to the Benchmark levels that CIS assigns to a profile.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The CIS scan.

" + } + }, + "com.amazonaws.inspector2#CisScanArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(-us-gov|-cn)?:inspector2:[-.a-z0-9]{0,20}:\\d{12}:owner/(\\d{12}|o-[a-z0-9]{10,32})/cis-scan/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + } + }, + "com.amazonaws.inspector2#CisScanArnFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisStringFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#CisScanConfiguration": { + "type": "structure", + "members": { + "scanConfigurationArn": { + "target": "com.amazonaws.inspector2#CisScanConfigurationArn", + "traits": { + "smithy.api#documentation": "

The CIS scan configuration's scan configuration ARN.

", + "smithy.api#required": {} + } + }, + "ownerId": { + "target": "com.amazonaws.inspector2#CisOwnerId", + "traits": { + "smithy.api#documentation": "

The CIS scan configuration's owner ID.

" + } + }, + "scanName": { + "target": "com.amazonaws.inspector2#CisScanName", + "traits": { + "smithy.api#documentation": "

The name of the CIS scan configuration.

" + } + }, + "securityLevel": { + "target": "com.amazonaws.inspector2#CisSecurityLevel", + "traits": { + "smithy.api#documentation": "

The CIS scan configuration's security level.

" + } + }, + "schedule": { + "target": "com.amazonaws.inspector2#Schedule", + "traits": { + "smithy.api#documentation": "

The CIS scan configuration's schedule.

" + } + }, + "targets": { + "target": "com.amazonaws.inspector2#CisTargets", + "traits": { + "smithy.api#documentation": "

The CIS scan configuration's targets.

" + } + }, + "tags": { + "target": "com.amazonaws.inspector2#CisTagMap", + "traits": { + "smithy.api#documentation": "

The CIS scan configuration's tags.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The CIS scan configuration.

" + } + }, + "com.amazonaws.inspector2#CisScanConfigurationArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(-us-gov|-cn)?:inspector2:[a-z]{2}(-gov)?-[a-z]+-[0-9]{1}:[0-9]{12}:owner/(o-[a-z0-9]+|[0-9]{12})/cis-configuration/[0-9a-fA-F-]+$" + } + }, + "com.amazonaws.inspector2#CisScanConfigurationArnFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisStringFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#CisScanConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisScanConfiguration" + }, + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, + "com.amazonaws.inspector2#CisScanConfigurationsSortBy": { + "type": "enum", + "members": { + "SCAN_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCAN_NAME" + } + }, + "SCAN_CONFIGURATION_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCAN_CONFIGURATION_ARN" + } + } + } + }, + "com.amazonaws.inspector2#CisScanDateFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisDateFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.inspector2#CisScanList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisScan" + }, + "traits": { + "smithy.api#length": { + "max": 50 + } + } + }, + "com.amazonaws.inspector2#CisScanName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.inspector2#CisScanNameFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisStringFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#CisScanResultDetails": { + "type": "structure", + "members": { + "scanArn": { + "target": "com.amazonaws.inspector2#CisScanArn", + "traits": { + "smithy.api#documentation": "

The CIS scan result details' scan ARN.

", + "smithy.api#required": {} + } + }, + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The CIS scan result details' account ID.

" + } + }, + "targetResourceId": { + "target": "com.amazonaws.inspector2#ResourceId", + "traits": { + "smithy.api#documentation": "

The CIS scan result details' target resource ID.

" + } + }, + "platform": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The CIS scan result details' platform.

" + } + }, + "status": { + "target": "com.amazonaws.inspector2#CisFindingStatus", + "traits": { + "smithy.api#documentation": "

The CIS scan result details' status.

" + } + }, + "statusReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The CIS scan result details' status reason.

" + } + }, + "checkId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The CIS scan result details' check ID.

" + } + }, + "title": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The CIS scan result details' title.

" + } + }, + "checkDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The account ID that's associated with the CIS scan result details.

" + } + }, + "remediation": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The CIS scan result details' remediation.

" + } + }, + "level": { + "target": "com.amazonaws.inspector2#CisSecurityLevel", + "traits": { + "smithy.api#documentation": "

The CIS scan result details' level.

" + } + }, + "findingArn": { + "target": "com.amazonaws.inspector2#CisFindingArn", + "traits": { + "smithy.api#documentation": "

The CIS scan result details' finding ARN.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The CIS scan result details.

" + } + }, + "com.amazonaws.inspector2#CisScanResultDetailsFilterCriteria": { + "type": "structure", + "members": { + "findingStatusFilters": { + "target": "com.amazonaws.inspector2#CisFindingStatusFilterList", + "traits": { + "smithy.api#documentation": "

The criteria's finding status filters.

" + } + }, + "checkIdFilters": { + "target": "com.amazonaws.inspector2#CheckIdFilterList", + "traits": { + "smithy.api#documentation": "

The criteria's check ID filters.

" + } + }, + "titleFilters": { + "target": "com.amazonaws.inspector2#TitleFilterList", + "traits": { + "smithy.api#documentation": "

The criteria's title filters.

" + } + }, + "securityLevelFilters": { + "target": "com.amazonaws.inspector2#CisSecurityLevelFilterList", + "traits": { + "smithy.api#documentation": "

\n The criteria's security level filters. . \n Security level refers to the Benchmark levels that CIS assigns to a profile.\n

" + } + }, + "findingArnFilters": { + "target": "com.amazonaws.inspector2#CisFindingArnFilterList", + "traits": { + "smithy.api#documentation": "

The criteria's finding ARN filters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The CIS scan result details filter criteria.

" + } + }, + "com.amazonaws.inspector2#CisScanResultDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisScanResultDetails" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.inspector2#CisScanResultDetailsSortBy": { + "type": "enum", + "members": { + "CHECK_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHECK_ID" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATUS" + } + } + } + }, + "com.amazonaws.inspector2#CisScanResultsAggregatedByChecksFilterCriteria": { + "type": "structure", + "members": { + "accountIdFilters": { + "target": "com.amazonaws.inspector2#OneAccountIdFilterList", + "traits": { + "smithy.api#documentation": "

The criteria's account ID filters.

" + } + }, + "checkIdFilters": { + "target": "com.amazonaws.inspector2#CheckIdFilterList", + "traits": { + "smithy.api#documentation": "

The criteria's check ID filters.

" + } + }, + "titleFilters": { + "target": "com.amazonaws.inspector2#TitleFilterList", + "traits": { + "smithy.api#documentation": "

The criteria's title filters.

" + } + }, + "platformFilters": { + "target": "com.amazonaws.inspector2#PlatformFilterList", + "traits": { + "smithy.api#documentation": "

The criteria's platform filters.

" + } + }, + "failedResourcesFilters": { + "target": "com.amazonaws.inspector2#CisNumberFilterList", + "traits": { + "smithy.api#documentation": "

The criteria's failed resources filters.

" + } + }, + "securityLevelFilters": { + "target": "com.amazonaws.inspector2#CisSecurityLevelFilterList", + "traits": { + "smithy.api#documentation": "

The criteria's security level filters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The scan results aggregated by checks filter criteria.

" + } + }, + "com.amazonaws.inspector2#CisScanResultsAggregatedByChecksSortBy": { + "type": "enum", + "members": { + "CHECK_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHECK_ID" + } + }, + "TITLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TITLE" + } + }, + "PLATFORM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLATFORM" + } + }, + "FAILED_COUNTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_COUNTS" + } + }, + "SECURITY_LEVEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECURITY_LEVEL" + } + } + } + }, + "com.amazonaws.inspector2#CisScanResultsAggregatedByTargetResourceFilterCriteria": { + "type": "structure", + "members": { + "accountIdFilters": { + "target": "com.amazonaws.inspector2#AccountIdFilterList", + "traits": { + "smithy.api#documentation": "

The criteria's account ID filters.

" + } + }, + "statusFilters": { + "target": "com.amazonaws.inspector2#CisResultStatusFilterList", + "traits": { + "smithy.api#documentation": "

The criteria's status filter.

" + } + }, + "checkIdFilters": { + "target": "com.amazonaws.inspector2#CheckIdFilterList", + "traits": { + "smithy.api#documentation": "

The criteria's check ID filters.

" + } + }, + "targetResourceIdFilters": { + "target": "com.amazonaws.inspector2#ResourceIdFilterList", + "traits": { + "smithy.api#documentation": "

The criteria's target resource ID filters.

" + } + }, + "targetResourceTagFilters": { + "target": "com.amazonaws.inspector2#ResourceTagFilterList", + "traits": { + "smithy.api#documentation": "

The criteria's target resource tag filters.

" + } + }, + "platformFilters": { + "target": "com.amazonaws.inspector2#PlatformFilterList", + "traits": { + "smithy.api#documentation": "

The criteria's platform filters.

" + } + }, + "targetStatusFilters": { + "target": "com.amazonaws.inspector2#TargetStatusFilterList", + "traits": { + "smithy.api#documentation": "

The criteria's target status filters.

" + } + }, + "targetStatusReasonFilters": { + "target": "com.amazonaws.inspector2#TargetStatusReasonFilterList", + "traits": { + "smithy.api#documentation": "

The criteria's target status reason filters.

" + } + }, + "failedChecksFilters": { + "target": "com.amazonaws.inspector2#CisNumberFilterList", + "traits": { + "smithy.api#documentation": "

The criteria's failed checks filters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The scan results aggregated by target resource filter criteria.

" + } + }, + "com.amazonaws.inspector2#CisScanResultsAggregatedByTargetResourceSortBy": { + "type": "enum", + "members": { + "RESOURCE_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_ID" + } + }, + "FAILED_COUNTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_COUNTS" + } + }, + "ACCOUNT_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_ID" + } + }, + "PLATFORM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLATFORM" + } + }, + "TARGET_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TARGET_STATUS" + } + }, + "TARGET_STATUS_REASON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TARGET_STATUS_REASON" + } + } + } + }, + "com.amazonaws.inspector2#CisScanResultsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.inspector2#CisScanStatus": { + "type": "enum", + "members": { + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + } + } + }, + "com.amazonaws.inspector2#CisScanStatusComparison": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + } + } + }, + "com.amazonaws.inspector2#CisScanStatusFilter": { + "type": "structure", + "members": { + "comparison": { + "target": "com.amazonaws.inspector2#CisScanStatusComparison", + "traits": { + "smithy.api#documentation": "

The filter comparison value.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.inspector2#CisScanStatus", + "traits": { + "smithy.api#documentation": "

The filter value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The CIS scan status filter.

" + } + }, + "com.amazonaws.inspector2#CisScanStatusFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisScanStatusFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.inspector2#CisScheduledByFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisStringFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#CisSecurityLevel": { + "type": "enum", + "members": { + "LEVEL_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEVEL_1" + } + }, + "LEVEL_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEVEL_2" + } + } + } + }, + "com.amazonaws.inspector2#CisSecurityLevelComparison": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + } + } + }, + "com.amazonaws.inspector2#CisSecurityLevelFilter": { + "type": "structure", + "members": { + "comparison": { + "target": "com.amazonaws.inspector2#CisSecurityLevelComparison", + "traits": { + "smithy.api#documentation": "

The CIS security filter comparison value.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.inspector2#CisSecurityLevel", + "traits": { + "smithy.api#documentation": "

The CIS security filter value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The CIS security level filter. \n Security level refers to the Benchmark levels that CIS assigns to a profile.\n

" + } + }, + "com.amazonaws.inspector2#CisSecurityLevelFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisSecurityLevelFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#CisSessionMessage": { + "type": "structure", + "members": { + "ruleId": { + "target": "com.amazonaws.inspector2#RuleId", + "traits": { + "smithy.api#documentation": "

The rule ID for the CIS session message.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.inspector2#CisRuleStatus", + "traits": { + "smithy.api#documentation": "

The status of the CIS session message.

", + "smithy.api#required": {} + } + }, + "cisRuleDetails": { + "target": "com.amazonaws.inspector2#CisRuleDetails", + "traits": { + "smithy.api#documentation": "

The CIS rule details for the CIS session message.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The CIS session message.

" + } + }, + "com.amazonaws.inspector2#CisSessionMessages": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisSessionMessage" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 150 + } + } + }, + "com.amazonaws.inspector2#CisSortOrder": { + "type": "enum", + "members": { + "ASC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASC" + } + }, + "DESC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESC" + } + } + } + }, + "com.amazonaws.inspector2#CisStringComparison": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + }, + "PREFIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREFIX" + } + }, + "NOT_EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_EQUALS" + } + } + } + }, + "com.amazonaws.inspector2#CisStringFilter": { + "type": "structure", + "members": { + "comparison": { + "target": "com.amazonaws.inspector2#CisStringComparison", + "traits": { + "smithy.api#documentation": "

The comparison value of the CIS string filter.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The value of the CIS string filter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The CIS string filter.

" + } + }, + "com.amazonaws.inspector2#CisTagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.inspector2#MapKey" + }, + "value": { + "target": "com.amazonaws.inspector2#MapValue" + } + }, + "com.amazonaws.inspector2#CisTargetResourceAggregation": { + "type": "structure", + "members": { + "scanArn": { + "target": "com.amazonaws.inspector2#CisScanArn", + "traits": { + "smithy.api#documentation": "

The scan ARN for the CIS target resource.

", + "smithy.api#required": {} + } + }, + "targetResourceId": { + "target": "com.amazonaws.inspector2#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the target resource.

" + } + }, + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID for the CIS target resource.

" + } + }, + "targetResourceTags": { + "target": "com.amazonaws.inspector2#TargetResourceTags", + "traits": { + "smithy.api#documentation": "

The tag for the target resource.

" + } + }, + "statusCounts": { + "target": "com.amazonaws.inspector2#StatusCounts", + "traits": { + "smithy.api#documentation": "

The target resource status counts.

" + } + }, + "platform": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The platform for the CIS target resource.

" + } + }, + "targetStatus": { + "target": "com.amazonaws.inspector2#CisTargetStatus", + "traits": { + "smithy.api#documentation": "

The status of the target resource.

" + } + }, + "targetStatusReason": { + "target": "com.amazonaws.inspector2#CisTargetStatusReason", + "traits": { + "smithy.api#documentation": "

The reason for the target resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The CIS target resource aggregation.

" + } + }, + "com.amazonaws.inspector2#CisTargetResourceAggregationList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisTargetResourceAggregation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.inspector2#CisTargetStatus": { + "type": "enum", + "members": { + "TIMED_OUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMED_OUT" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + } + } + }, + "com.amazonaws.inspector2#CisTargetStatusComparison": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + } + } + }, + "com.amazonaws.inspector2#CisTargetStatusFilter": { + "type": "structure", + "members": { + "comparison": { + "target": "com.amazonaws.inspector2#CisTargetStatusComparison", + "traits": { + "smithy.api#documentation": "

The comparison value of the CIS target status filter.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.inspector2#CisTargetStatus", + "traits": { + "smithy.api#documentation": "

The value of the CIS target status filter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The CIS target status filter.

" + } + }, + "com.amazonaws.inspector2#CisTargetStatusReason": { + "type": "enum", + "members": { + "SCAN_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCAN_IN_PROGRESS" + } + }, + "UNSUPPORTED_OS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSUPPORTED_OS" + } + }, + "SSM_UNMANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSM_UNMANAGED" + } + } + } + }, + "com.amazonaws.inspector2#CisTargetStatusReasonFilter": { + "type": "structure", + "members": { + "comparison": { + "target": "com.amazonaws.inspector2#CisTargetStatusComparison", + "traits": { + "smithy.api#documentation": "

The comparison value of the CIS target status reason filter.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.inspector2#CisTargetStatusReason", + "traits": { + "smithy.api#documentation": "

The value of the CIS target status reason filter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The CIS target status reason filter.

" + } + }, + "com.amazonaws.inspector2#CisTargets": { + "type": "structure", + "members": { + "accountIds": { + "target": "com.amazonaws.inspector2#CisAccountIdList", + "traits": { + "smithy.api#documentation": "

The CIS target account ids.

" + } + }, + "targetResourceTags": { + "target": "com.amazonaws.inspector2#TargetResourceTags", + "traits": { + "smithy.api#documentation": "

The CIS target resource tags.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The CIS targets.

" + } + }, + "com.amazonaws.inspector2#CisaAction": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.inspector2#CisaData": { + "type": "structure", + "members": { + "dateAdded": { + "target": "com.amazonaws.inspector2#CisaDateAdded", + "traits": { + "smithy.api#documentation": "

The date and time CISA added this vulnerability to their catalogue.

" + } + }, + "dateDue": { + "target": "com.amazonaws.inspector2#CisaDateDue", + "traits": { + "smithy.api#documentation": "

The date and time CISA expects a fix to have been provided vulnerability.

" + } + }, + "action": { + "target": "com.amazonaws.inspector2#CisaAction", + "traits": { + "smithy.api#documentation": "

The remediation action recommended by CISA for this vulnerability.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Cybersecurity and Infrastructure Security Agency (CISA) details for a specific vulnerability.

" + } + }, + "com.amazonaws.inspector2#CisaDateAdded": { + "type": "timestamp" + }, + "com.amazonaws.inspector2#CisaDateDue": { + "type": "timestamp" + }, + "com.amazonaws.inspector2#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.inspector2#CodeFilePath": { + "type": "structure", + "members": { + "fileName": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the file the code vulnerability was found in.

", + "smithy.api#required": {} + } + }, + "filePath": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The file path to the code that a vulnerability was found in.

", + "smithy.api#required": {} + } + }, + "startLine": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The line number of the first line of code that a vulnerability was found in.

", + "smithy.api#required": {} + } + }, + "endLine": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The line number of the last line of code that a vulnerability was found in.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information on where a code vulnerability is located in your Lambda function.

" + } + }, + "com.amazonaws.inspector2#CodeLine": { + "type": "structure", + "members": { + "content": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The content of a line of code

", + "smithy.api#length": { + "min": 0, + "max": 240 + }, + "smithy.api#required": {} + } + }, + "lineNumber": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The line number that a section of code is located at.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information on the lines of code associated with a code snippet.

" + } + }, + "com.amazonaws.inspector2#CodeLineList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CodeLine" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.inspector2#CodeSnippetError": { + "type": "structure", + "members": { + "findingArn": { + "target": "com.amazonaws.inspector2#FindingArn", + "traits": { + "smithy.api#documentation": "

The ARN of the finding that a code snippet couldn't be retrieved for.

", + "smithy.api#required": {} + } + }, + "errorCode": { + "target": "com.amazonaws.inspector2#CodeSnippetErrorCode", + "traits": { + "smithy.api#documentation": "

The error code for the error that prevented a code snippet from being retrieved.

", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The error message received when Amazon Inspector failed to retrieve a code snippet.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about any errors encountered while trying to retrieve a code snippet.

" + } + }, + "com.amazonaws.inspector2#CodeSnippetErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INTERNAL_ERROR", + "name": "INTERNAL_ERROR" + }, + { + "value": "ACCESS_DENIED", + "name": "ACCESS_DENIED" + }, + { + "value": "CODE_SNIPPET_NOT_FOUND", + "name": "CODE_SNIPPET_NOT_FOUND" + }, + { + "value": "INVALID_INPUT", + "name": "INVALID_INPUT" + } + ] + } + }, + "com.amazonaws.inspector2#CodeSnippetErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CodeSnippetError" + } + }, + "com.amazonaws.inspector2#CodeSnippetResult": { + "type": "structure", + "members": { + "findingArn": { + "target": "com.amazonaws.inspector2#FindingArn", + "traits": { + "smithy.api#documentation": "

The ARN of a finding that the code snippet is associated with.

" + } + }, + "startLine": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The line number of the first line of a code snippet.

" + } + }, + "endLine": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The line number of the last line of a code snippet.

" + } + }, + "codeSnippet": { + "target": "com.amazonaws.inspector2#CodeLineList", + "traits": { + "smithy.api#documentation": "

Contains information on the retrieved code snippet.

" + } + }, + "suggestedFixes": { + "target": "com.amazonaws.inspector2#SuggestedFixes", + "traits": { + "smithy.api#documentation": "

Details of a suggested code fix.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information on a code snippet retrieved by Amazon Inspector from a code vulnerability finding.

" + } + }, + "com.amazonaws.inspector2#CodeSnippetResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CodeSnippetResult" + } + }, + "com.amazonaws.inspector2#CodeVulnerabilityDetails": { + "type": "structure", + "members": { + "filePath": { + "target": "com.amazonaws.inspector2#CodeFilePath", + "traits": { + "smithy.api#documentation": "

Contains information on where the code vulnerability is located in your code.

", + "smithy.api#required": {} + } + }, + "detectorTags": { + "target": "com.amazonaws.inspector2#DetectorTagList", + "traits": { + "smithy.api#documentation": "

The detector tag associated with the vulnerability. Detector tags group related vulnerabilities by common themes or tactics. For a list of available tags by programming language, see Java tags, or Python tags.

" + } + }, + "referenceUrls": { + "target": "com.amazonaws.inspector2#ReferenceUrls", + "traits": { + "smithy.api#documentation": "

A URL containing supporting documentation about the code vulnerability detected.

" + } + }, + "ruleId": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier for a rule that was used to detect the code vulnerability.

" + } + }, + "sourceLambdaLayerArn": { + "target": "com.amazonaws.inspector2#LambdaLayerArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lambda layer that the code vulnerability was detected in.

" + } + }, + "detectorId": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon CodeGuru detector associated with the finding. For more information on detectors see Amazon CodeGuru\n Detector Library.

", + "smithy.api#required": {} + } + }, + "detectorName": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the detector used to identify the code vulnerability. For more information on detectors see CodeGuru Detector Library.

", + "smithy.api#required": {} + } + }, + "cwes": { + "target": "com.amazonaws.inspector2#CweList", + "traits": { + "smithy.api#documentation": "

The Common Weakness Enumeration (CWE) item associated with the detected vulnerability.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information on the code vulnerability identified in your Lambda function.

" + } + }, + "com.amazonaws.inspector2#Component": { + "type": "string" + }, + "com.amazonaws.inspector2#ComponentType": { + "type": "string" + }, + "com.amazonaws.inspector2#ComputePlatform": { + "type": "structure", + "members": { + "vendor": { + "target": "com.amazonaws.inspector2#Vendor", + "traits": { + "smithy.api#documentation": "

The compute platform vendor.

" + } + }, + "product": { + "target": "com.amazonaws.inspector2#Product", + "traits": { + "smithy.api#documentation": "

The compute platform product.

" + } + }, + "version": { + "target": "com.amazonaws.inspector2#PlatformVersion", + "traits": { + "smithy.api#documentation": "

The compute platform version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A compute platform.

" + } + }, + "com.amazonaws.inspector2#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the conflicting resource.

", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The type of the conflicting resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A conflict occurred.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.inspector2#Counts": { + "type": "structure", + "members": { + "count": { + "target": "com.amazonaws.inspector2#AggCounts", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of resources.

" + } + }, + "groupKey": { + "target": "com.amazonaws.inspector2#GroupKey", + "traits": { + "smithy.api#documentation": "

The key associated with this group

" + } + } + }, + "traits": { + "smithy.api#documentation": "

a structure that contains information on the count of resources within a group.

" + } + }, + "com.amazonaws.inspector2#CountsList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Counts" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.inspector2#CoverageDateFilter": { + "type": "structure", + "members": { + "startInclusive": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "

A timestamp representing the start of the time period to filter results by.

" + } + }, + "endInclusive": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "

A timestamp representing the end of the time period to filter results by.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details of a coverage date filter.

" + } + }, + "com.amazonaws.inspector2#CoverageDateFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CoverageDateFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#CoverageFilterCriteria": { + "type": "structure", + "members": { + "scanStatusCode": { + "target": "com.amazonaws.inspector2#CoverageStringFilterList", + "traits": { + "smithy.api#documentation": "

The scan status code to filter on. Valid values are: ValidationException, InternalServerException, ResourceNotFoundException, BadRequestException, and ThrottlingException.

" + } + }, + "scanStatusReason": { + "target": "com.amazonaws.inspector2#CoverageStringFilterList", + "traits": { + "smithy.api#documentation": "

The scan status reason to filter on.

" + } + }, + "accountId": { + "target": "com.amazonaws.inspector2#CoverageStringFilterList", + "traits": { + "smithy.api#documentation": "

An array of Amazon Web Services account IDs to return coverage statistics for.

" + } + }, + "resourceId": { + "target": "com.amazonaws.inspector2#CoverageStringFilterList", + "traits": { + "smithy.api#documentation": "

An array of Amazon Web Services resource IDs to return coverage statistics for.

" + } + }, + "resourceType": { + "target": "com.amazonaws.inspector2#CoverageStringFilterList", + "traits": { + "smithy.api#documentation": "

An array of Amazon Web Services resource types to return coverage statistics for. The values can be AWS_EC2_INSTANCE, AWS_LAMBDA_FUNCTION, AWS_ECR_CONTAINER_IMAGE, AWS_ECR_REPOSITORY or AWS_ACCOUNT.

" + } + }, + "scanType": { + "target": "com.amazonaws.inspector2#CoverageStringFilterList", + "traits": { + "smithy.api#documentation": "

An array of Amazon Inspector scan types to return coverage statistics for.

" + } + }, + "ecrRepositoryName": { + "target": "com.amazonaws.inspector2#CoverageStringFilterList", + "traits": { + "smithy.api#documentation": "

The Amazon ECR repository name to filter on.

" + } + }, + "ecrImageTags": { + "target": "com.amazonaws.inspector2#CoverageStringFilterList", + "traits": { + "smithy.api#documentation": "

The Amazon ECR image tags to filter on.

" + } + }, + "ec2InstanceTags": { + "target": "com.amazonaws.inspector2#CoverageMapFilterList", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 instance tags to filter on.

" + } + }, + "lambdaFunctionName": { + "target": "com.amazonaws.inspector2#CoverageStringFilterList", + "traits": { + "smithy.api#documentation": "

Returns coverage statistics for Amazon Web Services Lambda functions filtered by function names.

" + } + }, + "lambdaFunctionTags": { + "target": "com.amazonaws.inspector2#CoverageMapFilterList", + "traits": { + "smithy.api#documentation": "

Returns coverage statistics for Amazon Web Services Lambda functions filtered by tag.

" + } + }, + "lambdaFunctionRuntime": { + "target": "com.amazonaws.inspector2#CoverageStringFilterList", + "traits": { + "smithy.api#documentation": "

Returns coverage statistics for Amazon Web Services Lambda functions filtered by runtime.

" + } + }, + "lastScannedAt": { + "target": "com.amazonaws.inspector2#CoverageDateFilterList", + "traits": { + "smithy.api#documentation": "

Filters Amazon Web Services resources based on whether Amazon Inspector has checked them for vulnerabilities within the specified time range.

" + } + }, + "scanMode": { + "target": "com.amazonaws.inspector2#CoverageStringFilterList", + "traits": { + "smithy.api#documentation": "

The filter to search for Amazon EC2 instance coverage by scan mode. Valid values are EC2_SSM_AGENT_BASED and EC2_HYBRID.

" + } + }, + "imagePulledAt": { + "target": "com.amazonaws.inspector2#CoverageDateFilterList", + "traits": { + "smithy.api#documentation": "

The date an image was last pulled at.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that identifies filter criteria for GetCoverageStatistics.

" + } + }, + "com.amazonaws.inspector2#CoverageMapComparison": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EQUALS", + "name": "EQUALS" + } + ] + } + }, + "com.amazonaws.inspector2#CoverageMapFilter": { + "type": "structure", + "members": { + "comparison": { + "target": "com.amazonaws.inspector2#CoverageMapComparison", + "traits": { + "smithy.api#documentation": "

The operator to compare coverage on.

", + "smithy.api#required": {} + } + }, + "key": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The tag key associated with the coverage map filter.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The tag value associated with the coverage map filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details of a coverage map filter.

" + } + }, + "com.amazonaws.inspector2#CoverageMapFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CoverageMapFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#CoverageResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWS_EC2_INSTANCE", + "name": "AWS_EC2_INSTANCE" + }, + { + "value": "AWS_ECR_CONTAINER_IMAGE", + "name": "AWS_ECR_CONTAINER_IMAGE" + }, + { + "value": "AWS_ECR_REPOSITORY", + "name": "AWS_ECR_REPOSITORY" + }, + { + "value": "AWS_LAMBDA_FUNCTION", + "name": "AWS_LAMBDA_FUNCTION" + } + ] + } + }, + "com.amazonaws.inspector2#CoverageStringComparison": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EQUALS", + "name": "EQUALS" + }, + { + "value": "NOT_EQUALS", + "name": "NOT_EQUALS" + } + ] + } + }, + "com.amazonaws.inspector2#CoverageStringFilter": { + "type": "structure", + "members": { + "comparison": { + "target": "com.amazonaws.inspector2#CoverageStringComparison", + "traits": { + "smithy.api#documentation": "

The operator to compare strings on.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.inspector2#CoverageStringInput", + "traits": { + "smithy.api#documentation": "

The value to compare strings on.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details of a coverage string filter.

" + } + }, + "com.amazonaws.inspector2#CoverageStringFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CoverageStringFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#CoverageStringInput": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#CoveredResource": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.inspector2#CoverageResourceType", + "traits": { + "smithy.api#documentation": "

The type of the covered resource.

", + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.inspector2#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the covered resource.

", + "smithy.api#required": {} + } + }, + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the covered resource.

", + "smithy.api#required": {} + } + }, + "scanType": { + "target": "com.amazonaws.inspector2#ScanType", + "traits": { + "smithy.api#documentation": "

The Amazon Inspector scan type covering the resource.

", + "smithy.api#required": {} + } + }, + "scanStatus": { + "target": "com.amazonaws.inspector2#ScanStatus", + "traits": { + "smithy.api#documentation": "

The status of the scan covering the resource.

" + } + }, + "resourceMetadata": { + "target": "com.amazonaws.inspector2#ResourceScanMetadata", + "traits": { + "smithy.api#documentation": "

An object that contains details about the metadata.

" + } + }, + "lastScannedAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time the resource was last checked for vulnerabilities.

" + } + }, + "scanMode": { + "target": "com.amazonaws.inspector2#ScanMode", + "traits": { + "smithy.api#documentation": "

The scan method that is applied to the instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains details about a resource covered by Amazon Inspector.

" + } + }, + "com.amazonaws.inspector2#CoveredResources": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CoveredResource" + } + }, + "com.amazonaws.inspector2#CreateCisScanConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#CreateCisScanConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#CreateCisScanConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a CIS scan configuration.

", + "smithy.api#examples": [ + { + "title": "Sample CreateCisScanConfiguration Call", + "input": { + "scanName": "sample", + "securityLevel": "LEVEL_1", + "schedule": { + "daily": { + "startTime": { + "timeOfDay": "12:34", + "timezone": "UTC" + } + } + }, + "targets": { + "accountIds": [ + "SELF" + ], + "targetResourceTags": { + "key": [ + "value" + ] + } + } + }, + "output": { + "scanConfigurationArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-configuration/624b746d-e080-44ae-8c1d-48e653365a38" + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/cis/scan-configuration/create" + } + } + }, + "com.amazonaws.inspector2#CreateCisScanConfigurationRequest": { + "type": "structure", + "members": { + "scanName": { + "target": "com.amazonaws.inspector2#CisScanName", + "traits": { + "smithy.api#documentation": "

The scan name for the CIS scan configuration.

", + "smithy.api#required": {} + } + }, + "securityLevel": { + "target": "com.amazonaws.inspector2#CisSecurityLevel", + "traits": { + "smithy.api#documentation": "

\n The security level for the CIS scan configuration. \n Security level refers to the Benchmark levels that CIS assigns to a profile.\n

", + "smithy.api#required": {} + } + }, + "schedule": { + "target": "com.amazonaws.inspector2#Schedule", + "traits": { + "smithy.api#documentation": "

The schedule for the CIS scan configuration.

", + "smithy.api#required": {} + } + }, + "targets": { + "target": "com.amazonaws.inspector2#CreateCisTargets", + "traits": { + "smithy.api#documentation": "

The targets for the CIS scan configuration.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.inspector2#CisTagMap", + "traits": { + "smithy.api#documentation": "

The tags for the CIS scan configuration.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#CreateCisScanConfigurationResponse": { + "type": "structure", + "members": { + "scanConfigurationArn": { + "target": "com.amazonaws.inspector2#CisScanConfigurationArn", + "traits": { + "smithy.api#documentation": "

The scan configuration ARN for the CIS scan configuration.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.inspector2#CreateCisTargets": { + "type": "structure", + "members": { + "accountIds": { + "target": "com.amazonaws.inspector2#TargetAccountList", + "traits": { + "smithy.api#documentation": "

The CIS target account ids.

", + "smithy.api#required": {} + } + }, + "targetResourceTags": { + "target": "com.amazonaws.inspector2#TargetResourceTags", + "traits": { + "smithy.api#documentation": "

The CIS target resource tags.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Creates CIS targets.

" + } + }, + "com.amazonaws.inspector2#CreateFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#CreateFilterRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#CreateFilterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#BadRequestException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a filter resource using specified filter criteria. When the filter action is set to SUPPRESS this action creates a suppression rule.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/filters/create" + } + } + }, + "com.amazonaws.inspector2#CreateFilterRequest": { + "type": "structure", + "members": { + "action": { + "target": "com.amazonaws.inspector2#FilterAction", + "traits": { + "smithy.api#documentation": "

Defines the action that is to be applied to the findings that match the filter.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.inspector2#FilterDescription", + "traits": { + "smithy.api#documentation": "

A description of the filter.

" + } + }, + "filterCriteria": { + "target": "com.amazonaws.inspector2#FilterCriteria", + "traits": { + "smithy.api#documentation": "

Defines the criteria to be used in the filter for querying findings.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.inspector2#FilterName", + "traits": { + "smithy.api#documentation": "

The name of the filter. Minimum length of 3. Maximum length of 64. Valid characters\n include alphanumeric characters, dot (.), underscore (_), and dash (-). Spaces are not\n allowed.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.inspector2#TagMap", + "traits": { + "smithy.api#documentation": "

A list of tags for the filter.

" + } + }, + "reason": { + "target": "com.amazonaws.inspector2#FilterReason", + "traits": { + "smithy.api#documentation": "

The reason for creating the filter.

" + } + } + } + }, + "com.amazonaws.inspector2#CreateFilterResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.inspector2#FilterArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the successfully created filter.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#CreateFindingsReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#CreateFindingsReportRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#CreateFindingsReportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a finding report. By default only ACTIVE findings are returned in the report. To see SUPRESSED or CLOSED findings you must specify a value for the findingStatus filter criteria.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/reporting/create" + } + } + }, + "com.amazonaws.inspector2#CreateFindingsReportRequest": { + "type": "structure", + "members": { + "filterCriteria": { + "target": "com.amazonaws.inspector2#FilterCriteria", + "traits": { + "smithy.api#documentation": "

The filter criteria to apply to the results of the finding report.

" + } + }, + "reportFormat": { + "target": "com.amazonaws.inspector2#ReportFormat", + "traits": { + "smithy.api#documentation": "

The format to generate the report in.

", + "smithy.api#required": {} + } + }, + "s3Destination": { + "target": "com.amazonaws.inspector2#Destination", + "traits": { + "smithy.api#documentation": "

The Amazon S3 export destination for the report.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#CreateFindingsReportResponse": { + "type": "structure", + "members": { + "reportId": { + "target": "com.amazonaws.inspector2#ReportId", + "traits": { + "smithy.api#documentation": "

The ID of the report.

" + } + } + } + }, + "com.amazonaws.inspector2#CreateSbomExport": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#CreateSbomExportRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#CreateSbomExportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a software bill of materials (SBOM) report.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/sbomexport/create" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.inspector2#CreateSbomExportRequest": { + "type": "structure", + "members": { + "resourceFilterCriteria": { + "target": "com.amazonaws.inspector2#ResourceFilterCriteria", + "traits": { + "smithy.api#documentation": "

The resource filter criteria for the software bill of materials (SBOM) report.

" + } + }, + "reportFormat": { + "target": "com.amazonaws.inspector2#SbomReportFormat", + "traits": { + "smithy.api#documentation": "

The output format for the software bill of materials (SBOM) report.

", + "smithy.api#required": {} + } + }, + "s3Destination": { + "target": "com.amazonaws.inspector2#Destination", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#CreateSbomExportResponse": { + "type": "structure", + "members": { + "reportId": { + "target": "com.amazonaws.inspector2#ReportId", + "traits": { + "smithy.api#documentation": "

The report ID for the software bill of materials (SBOM) report.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.inspector2#Currency": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "USD", + "value": "USD" + } + ] + } + }, + "com.amazonaws.inspector2#Cvss2": { + "type": "structure", + "members": { + "baseScore": { + "target": "com.amazonaws.inspector2#Cvss2BaseScore", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The CVSS v2 base score for the vulnerability.

" + } + }, + "scoringVector": { + "target": "com.amazonaws.inspector2#Cvss2ScoringVector", + "traits": { + "smithy.api#documentation": "

The scoring vector associated with the CVSS v2 score.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Common Vulnerability Scoring System (CVSS) version 2 details for the vulnerability.

" + } + }, + "com.amazonaws.inspector2#Cvss2BaseScore": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.inspector2#Cvss2ScoringVector": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.inspector2#Cvss3": { + "type": "structure", + "members": { + "baseScore": { + "target": "com.amazonaws.inspector2#Cvss3BaseScore", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The CVSS v3 base score for the vulnerability.

" + } + }, + "scoringVector": { + "target": "com.amazonaws.inspector2#Cvss3ScoringVector", + "traits": { + "smithy.api#documentation": "

The scoring vector associated with the CVSS v3 score.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Common Vulnerability Scoring System (CVSS) version 3 details for the vulnerability.

" + } + }, + "com.amazonaws.inspector2#Cvss3BaseScore": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.inspector2#Cvss3ScoringVector": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.inspector2#CvssScore": { + "type": "structure", + "members": { + "baseScore": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The base CVSS score used for the finding.

", + "smithy.api#required": {} + } + }, + "scoringVector": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The vector string of the CVSS score.

", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The version of CVSS used for the score.

", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source of the CVSS score.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The CVSS score for a finding.

" + } + }, + "com.amazonaws.inspector2#CvssScoreAdjustment": { + "type": "structure", + "members": { + "metric": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The metric used to adjust the CVSS score.

", + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The reason the CVSS score has been adjustment.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details on adjustments Amazon Inspector made to the CVSS score for a finding.

" + } + }, + "com.amazonaws.inspector2#CvssScoreAdjustmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CvssScoreAdjustment" + } + }, + "com.amazonaws.inspector2#CvssScoreDetails": { + "type": "structure", + "members": { + "scoreSource": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source for the CVSS score.

", + "smithy.api#required": {} + } + }, + "cvssSource": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source of the CVSS data.

" + } + }, + "version": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The CVSS version used in scoring.

", + "smithy.api#required": {} + } + }, + "score": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The CVSS score.

", + "smithy.api#required": {} + } + }, + "scoringVector": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The vector for the CVSS score.

", + "smithy.api#required": {} + } + }, + "adjustments": { + "target": "com.amazonaws.inspector2#CvssScoreAdjustmentList", + "traits": { + "smithy.api#documentation": "

An object that contains details about adjustment Amazon Inspector made to the CVSS score.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the CVSS score.

" + } + }, + "com.amazonaws.inspector2#CvssScoreList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CvssScore" + } + }, + "com.amazonaws.inspector2#Cwe": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.inspector2#CweList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#NonEmptyString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#Cwes": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Cwe" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.inspector2#DailySchedule": { + "type": "structure", + "members": { + "startTime": { + "target": "com.amazonaws.inspector2#Time", + "traits": { + "smithy.api#documentation": "

The schedule start time.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A daily schedule.

" + } + }, + "com.amazonaws.inspector2#DateFilter": { + "type": "structure", + "members": { + "startInclusive": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp representing the start of the time period filtered on.

" + } + }, + "endInclusive": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp representing the end of the time period filtered on.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details on the time range used to filter findings.

" + } + }, + "com.amazonaws.inspector2#DateFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#DateFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#DateTimeTimestamp": { + "type": "timestamp" + }, + "com.amazonaws.inspector2#Day": { + "type": "enum", + "members": { + "SUN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUN" + } + }, + "MON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MON" + } + }, + "TUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TUE" + } + }, + "WED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WED" + } + }, + "THU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THU" + } + }, + "FRI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FRI" + } + }, + "SAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAT" + } + } + } + }, + "com.amazonaws.inspector2#DaysList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Day" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 7 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.inspector2#DelegatedAdmin": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the Amazon Inspector delegated administrator for your organization.

" + } + }, + "relationshipStatus": { + "target": "com.amazonaws.inspector2#RelationshipStatus", + "traits": { + "smithy.api#documentation": "

The status of the Amazon Inspector delegated administrator.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details of the Amazon Inspector delegated administrator for your organization.

" + } + }, + "com.amazonaws.inspector2#DelegatedAdminAccount": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the Amazon Inspector delegated administrator for your organization.

" + } + }, + "status": { + "target": "com.amazonaws.inspector2#DelegatedAdminStatus", + "traits": { + "smithy.api#documentation": "

The status of the Amazon Inspector delegated administrator.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details of the Amazon Inspector delegated administrator for your organization.

" + } + }, + "com.amazonaws.inspector2#DelegatedAdminAccountList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#DelegatedAdminAccount" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.inspector2#DelegatedAdminStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "DISABLE_IN_PROGRESS", + "name": "DISABLE_IN_PROGRESS" + } + ] + } + }, + "com.amazonaws.inspector2#DeleteCisScanConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#DeleteCisScanConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#DeleteCisScanConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a CIS scan configuration.

", + "smithy.api#examples": [ + { + "title": "Sample DeleteCisScanConfiguration Call", + "input": { + "scanConfigurationArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-configuration/624b746d-e080-44ae-8c1d-48e653365a38" + }, + "output": { + "scanConfigurationArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-configuration/624b746d-e080-44ae-8c1d-48e653365a38" + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/cis/scan-configuration/delete" + } + } + }, + "com.amazonaws.inspector2#DeleteCisScanConfigurationRequest": { + "type": "structure", + "members": { + "scanConfigurationArn": { + "target": "com.amazonaws.inspector2#CisScanConfigurationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the CIS scan configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#DeleteCisScanConfigurationResponse": { + "type": "structure", + "members": { + "scanConfigurationArn": { + "target": "com.amazonaws.inspector2#CisScanConfigurationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the CIS scan configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.inspector2#DeleteFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#DeleteFilterRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#DeleteFilterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a filter resource.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/filters/delete" + } + } + }, + "com.amazonaws.inspector2#DeleteFilterRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.inspector2#FilterArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the filter to be deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#DeleteFilterResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.inspector2#FilterArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the filter that has been deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#DescribeOrganizationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#DescribeOrganizationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#DescribeOrganizationConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Describe Amazon Inspector configuration settings for an Amazon Web Services organization.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/organizationconfiguration/describe" + } + } + }, + "com.amazonaws.inspector2#DescribeOrganizationConfigurationRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.inspector2#DescribeOrganizationConfigurationResponse": { + "type": "structure", + "members": { + "autoEnable": { + "target": "com.amazonaws.inspector2#AutoEnable", + "traits": { + "smithy.api#documentation": "

The scan types are automatically enabled for new members of your organization.

" + } + }, + "maxAccountLimitReached": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Represents whether your organization has reached the maximum Amazon Web Services account limit for Amazon Inspector.

" + } + } + } + }, + "com.amazonaws.inspector2#Destination": { + "type": "structure", + "members": { + "bucketName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket to export findings to.

", + "smithy.api#required": {} + } + }, + "keyPrefix": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The prefix that the findings will be written under.

" + } + }, + "kmsKeyArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key used to encrypt data when exporting findings.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details of the Amazon S3 bucket and KMS key used to export findings.

" + } + }, + "com.amazonaws.inspector2#DetectionPlatforms": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#NonEmptyString" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.inspector2#DetectorTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#NonEmptyString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#Disable": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#DisableRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#DisableResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disables Amazon Inspector scans for one or more Amazon Web Services accounts. Disabling all scan types in an account\n disables the Amazon Inspector service.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/disable" + } + } + }, + "com.amazonaws.inspector2#DisableDelegatedAdminAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#DisableDelegatedAdminAccountRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#DisableDelegatedAdminAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#ConflictException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disables the Amazon Inspector delegated administrator for your organization.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/delegatedadminaccounts/disable" + } + } + }, + "com.amazonaws.inspector2#DisableDelegatedAdminAccountRequest": { + "type": "structure", + "members": { + "delegatedAdminAccountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the current Amazon Inspector delegated administrator.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#DisableDelegatedAdminAccountResponse": { + "type": "structure", + "members": { + "delegatedAdminAccountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the successfully disabled delegated administrator.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#DisableRequest": { + "type": "structure", + "members": { + "accountIds": { + "target": "com.amazonaws.inspector2#AccountIdSet", + "traits": { + "smithy.api#documentation": "

An array of account IDs you want to disable Amazon Inspector scans for.

" + } + }, + "resourceTypes": { + "target": "com.amazonaws.inspector2#DisableResourceTypeList", + "traits": { + "smithy.api#documentation": "

The resource scan types you want to disable.

" + } + } + } + }, + "com.amazonaws.inspector2#DisableResourceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#ResourceScanType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.inspector2#DisableResponse": { + "type": "structure", + "members": { + "accounts": { + "target": "com.amazonaws.inspector2#AccountList", + "traits": { + "smithy.api#documentation": "

Information on the accounts that have had Amazon Inspector scans successfully disabled. Details are\n provided for each account.

", + "smithy.api#required": {} + } + }, + "failedAccounts": { + "target": "com.amazonaws.inspector2#FailedAccountList", + "traits": { + "smithy.api#documentation": "

Information on any accounts for which Amazon Inspector scans could not be disabled. Details are\n provided for each account.

" + } + } + } + }, + "com.amazonaws.inspector2#DisassociateMember": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#DisassociateMemberRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#DisassociateMemberResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates a member account from an Amazon Inspector delegated administrator.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/members/disassociate" + } + } + }, + "com.amazonaws.inspector2#DisassociateMemberRequest": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the member account to disassociate.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#DisassociateMemberResponse": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the successfully disassociated member.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#Ec2Configuration": { + "type": "structure", + "members": { + "scanMode": { + "target": "com.amazonaws.inspector2#Ec2ScanMode", + "traits": { + "smithy.api#documentation": "

The scan method that is applied to the instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Enables agent-based scanning, which scans instances that are not managed by SSM.

" + } + }, + "com.amazonaws.inspector2#Ec2ConfigurationState": { + "type": "structure", + "members": { + "scanModeState": { + "target": "com.amazonaws.inspector2#Ec2ScanModeState", + "traits": { + "smithy.api#documentation": "

An object that contains details about the state of the Amazon EC2 scan mode.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the state of the EC2 scan configuration for your environment.

" + } + }, + "com.amazonaws.inspector2#Ec2DeepInspectionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVATED", + "name": "ACTIVATED" + }, + { + "value": "DEACTIVATED", + "name": "DEACTIVATED" + }, + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.inspector2#Ec2InstanceAggregation": { + "type": "structure", + "members": { + "amis": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The AMI IDs associated with the Amazon EC2 instances to aggregate findings for.

" + } + }, + "operatingSystems": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The operating system types to aggregate findings for. Valid values must be uppercase and\n underscore separated, examples are ORACLE_LINUX_7 and\n ALPINE_LINUX_3_8.

" + } + }, + "instanceIds": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 instance IDs to aggregate findings for.

" + } + }, + "instanceTags": { + "target": "com.amazonaws.inspector2#MapFilterList", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 instance tags to aggregate findings for.

" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#SortOrder", + "traits": { + "smithy.api#documentation": "

The order to sort results by.

" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#Ec2InstanceSortBy", + "traits": { + "smithy.api#documentation": "

The value to sort results by.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details that define an aggregation based on Amazon EC2 instances.

" + } + }, + "com.amazonaws.inspector2#Ec2InstanceAggregationResponse": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 instance ID.

", + "smithy.api#required": {} + } + }, + "ami": { + "target": "com.amazonaws.inspector2#AmiId", + "traits": { + "smithy.api#documentation": "

The Amazon Machine Image (AMI) of the Amazon EC2 instance.

" + } + }, + "operatingSystem": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The operating system of the Amazon EC2 instance.

" + } + }, + "instanceTags": { + "target": "com.amazonaws.inspector2#TagMap", + "traits": { + "smithy.api#documentation": "

The tags attached to the instance.

" + } + }, + "accountId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account for the Amazon EC2 instance.

" + } + }, + "severityCounts": { + "target": "com.amazonaws.inspector2#SeverityCounts", + "traits": { + "smithy.api#documentation": "

An object that contains the count of matched findings per severity.

" + } + }, + "networkFindings": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The number of network findings for the Amazon EC2 instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A response that contains the results of a finding aggregation by Amazon EC2 instance.

" + } + }, + "com.amazonaws.inspector2#Ec2InstanceSortBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NETWORK_FINDINGS", + "name": "NETWORK_FINDINGS" + }, + { + "value": "CRITICAL", + "name": "CRITICAL" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "ALL", + "name": "ALL" + } + ] + } + }, + "com.amazonaws.inspector2#Ec2Metadata": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.inspector2#TagMap", + "traits": { + "smithy.api#documentation": "

The tags attached to the instance.

" + } + }, + "amiId": { + "target": "com.amazonaws.inspector2#AmiId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) used to launch the instance.

" + } + }, + "platform": { + "target": "com.amazonaws.inspector2#Ec2Platform", + "traits": { + "smithy.api#documentation": "

The platform of the instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Meta data details of an Amazon EC2 instance.

" + } + }, + "com.amazonaws.inspector2#Ec2Platform": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "WINDOWS", + "name": "WINDOWS" + }, + { + "value": "LINUX", + "name": "LINUX" + }, + { + "value": "UNKNOWN", + "name": "UNKNOWN" + }, + { + "value": "MACOS", + "name": "MACOS" + } + ] + } + }, + "com.amazonaws.inspector2#Ec2ScanMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EC2_SSM_AGENT_BASED", + "name": "EC2_SSM_AGENT_BASED" + }, + { + "value": "EC2_HYBRID", + "name": "EC2_HYBRID" + } + ] + } + }, + "com.amazonaws.inspector2#Ec2ScanModeState": { + "type": "structure", + "members": { + "scanMode": { + "target": "com.amazonaws.inspector2#Ec2ScanMode", + "traits": { + "smithy.api#documentation": "

The scan method that is applied to the instance.

" + } + }, + "scanModeStatus": { + "target": "com.amazonaws.inspector2#Ec2ScanModeStatus", + "traits": { + "smithy.api#documentation": "

The status of the Amazon EC2 scan mode setting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The state of your Amazon EC2 scan mode configuration.

" + } + }, + "com.amazonaws.inspector2#Ec2ScanModeStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SUCCESS", + "name": "SUCCESS" + }, + { + "value": "PENDING", + "name": "PENDING" + } + ] + } + }, + "com.amazonaws.inspector2#EcrConfiguration": { + "type": "structure", + "members": { + "rescanDuration": { + "target": "com.amazonaws.inspector2#EcrRescanDuration", + "traits": { + "smithy.api#documentation": "

The rescan duration configured for image push date.

", + "smithy.api#required": {} + } + }, + "pullDateRescanDuration": { + "target": "com.amazonaws.inspector2#EcrPullDateRescanDuration", + "traits": { + "smithy.api#documentation": "

The rescan duration configured for image pull date.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the ECR automated re-scan duration setting for your environment.

" + } + }, + "com.amazonaws.inspector2#EcrConfigurationState": { + "type": "structure", + "members": { + "rescanDurationState": { + "target": "com.amazonaws.inspector2#EcrRescanDurationState", + "traits": { + "smithy.api#documentation": "

An object that contains details about the state of the ECR re-scan settings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the state of the ECR scans for your environment.

" + } + }, + "com.amazonaws.inspector2#EcrContainerImageMetadata": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.inspector2#TagList", + "traits": { + "smithy.api#documentation": "

Tags associated with the Amazon ECR image metadata.

" + } + }, + "imagePulledAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "

The date an image was last pulled at.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information on the Amazon ECR image metadata associated with a finding.

" + } + }, + "com.amazonaws.inspector2#EcrPullDateRescanDuration": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DAYS_14", + "name": "DAYS_14" + }, + { + "value": "DAYS_30", + "name": "DAYS_30" + }, + { + "value": "DAYS_60", + "name": "DAYS_60" + }, + { + "value": "DAYS_90", + "name": "DAYS_90" + }, + { + "value": "DAYS_180", + "name": "DAYS_180" + } + ] + } + }, + "com.amazonaws.inspector2#EcrRepositoryMetadata": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon ECR repository.

" + } + }, + "scanFrequency": { + "target": "com.amazonaws.inspector2#EcrScanFrequency", + "traits": { + "smithy.api#documentation": "

The frequency of scans.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information on the Amazon ECR repository metadata associated with a finding.

" + } + }, + "com.amazonaws.inspector2#EcrRescanDuration": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LIFETIME", + "name": "LIFETIME" + }, + { + "value": "DAYS_30", + "name": "DAYS_30" + }, + { + "value": "DAYS_180", + "name": "DAYS_180" + }, + { + "value": "DAYS_14", + "name": "DAYS_14" + }, + { + "value": "DAYS_60", + "name": "DAYS_60" + }, + { + "value": "DAYS_90", + "name": "DAYS_90" + } + ] + } + }, + "com.amazonaws.inspector2#EcrRescanDurationState": { + "type": "structure", + "members": { + "rescanDuration": { + "target": "com.amazonaws.inspector2#EcrRescanDuration", + "traits": { + "smithy.api#documentation": "

The rescan duration configured for image push date.\n \n

" + } + }, + "status": { + "target": "com.amazonaws.inspector2#EcrRescanDurationStatus", + "traits": { + "smithy.api#documentation": "

The status of changes to the ECR automated re-scan duration.

" + } + }, + "updatedAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "

A timestamp representing when the last time the ECR scan duration setting was changed.

" + } + }, + "pullDateRescanDuration": { + "target": "com.amazonaws.inspector2#EcrPullDateRescanDuration", + "traits": { + "smithy.api#documentation": "

The rescan duration configured for image pull date.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the state of your ECR re-scan duration settings. The ECR re-scan duration defines how long an ECR image will be actively scanned by Amazon Inspector. When the number of days since an image was last pushed exceeds the duration configured for image pull date, and the duration configured for image pull date, the monitoring state of that image becomes inactive and all associated findings are scheduled for closure.

" + } + }, + "com.amazonaws.inspector2#EcrRescanDurationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SUCCESS", + "name": "SUCCESS" + }, + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.inspector2#EcrScanFrequency": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MANUAL", + "name": "MANUAL" + }, + { + "value": "SCAN_ON_PUSH", + "name": "SCAN_ON_PUSH" + }, + { + "value": "CONTINUOUS_SCAN", + "name": "CONTINUOUS_SCAN" + } + ] + } + }, + "com.amazonaws.inspector2#Enable": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#EnableRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#EnableResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Enables Amazon Inspector scans for one or more Amazon Web Services accounts.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/enable" + } + } + }, + "com.amazonaws.inspector2#EnableDelegatedAdminAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#EnableDelegatedAdminAccountRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#EnableDelegatedAdminAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#ConflictException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Enables the Amazon Inspector delegated administrator for your Organizations organization.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/delegatedadminaccounts/enable" + } + } + }, + "com.amazonaws.inspector2#EnableDelegatedAdminAccountRequest": { + "type": "structure", + "members": { + "delegatedAdminAccountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the Amazon Inspector delegated administrator.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.inspector2#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token for the request.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.inspector2#EnableDelegatedAdminAccountResponse": { + "type": "structure", + "members": { + "delegatedAdminAccountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the successfully Amazon Inspector delegated administrator.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#EnableRequest": { + "type": "structure", + "members": { + "accountIds": { + "target": "com.amazonaws.inspector2#AccountIdSet", + "traits": { + "smithy.api#documentation": "

A list of account IDs you want to enable Amazon Inspector scans for.

" + } + }, + "resourceTypes": { + "target": "com.amazonaws.inspector2#EnableResourceTypeList", + "traits": { + "smithy.api#documentation": "

The resource scan types you want to enable.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.inspector2#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotency token for the request.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.inspector2#EnableResourceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#ResourceScanType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + }, + "com.amazonaws.inspector2#EnableResponse": { + "type": "structure", + "members": { + "accounts": { + "target": "com.amazonaws.inspector2#AccountList", + "traits": { + "smithy.api#documentation": "

Information on the accounts that have had Amazon Inspector scans successfully enabled. Details are\n provided for each account.

", + "smithy.api#required": {} + } + }, + "failedAccounts": { + "target": "com.amazonaws.inspector2#FailedAccountList", + "traits": { + "smithy.api#documentation": "

Information on any accounts for which Amazon Inspector scans could not be enabled. Details are\n provided for each account.

" + } + } + } + }, + "com.amazonaws.inspector2#Epss": { + "type": "structure", + "members": { + "score": { + "target": "com.amazonaws.inspector2#EpssScore", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The Exploit Prediction Scoring System (EPSS) score.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the Exploit Prediction Scoring System (EPSS) score.

" + } + }, + "com.amazonaws.inspector2#EpssDetails": { + "type": "structure", + "members": { + "score": { + "target": "com.amazonaws.inspector2#EpssScoreValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The EPSS score.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the Exploit Prediction Scoring System (EPSS) score for a finding.

" + } + }, + "com.amazonaws.inspector2#EpssScore": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.inspector2#EpssScoreValue": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0.0, + "max": 1.0 + } + } + }, + "com.amazonaws.inspector2#ErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALREADY_ENABLED", + "name": "ALREADY_ENABLED" + }, + { + "value": "ENABLE_IN_PROGRESS", + "name": "ENABLE_IN_PROGRESS" + }, + { + "value": "DISABLE_IN_PROGRESS", + "name": "DISABLE_IN_PROGRESS" + }, + { + "value": "SUSPEND_IN_PROGRESS", + "name": "SUSPEND_IN_PROGRESS" + }, + { + "value": "RESOURCE_NOT_FOUND", + "name": "RESOURCE_NOT_FOUND" + }, + { + "value": "ACCESS_DENIED", + "name": "ACCESS_DENIED" + }, + { + "value": "INTERNAL_ERROR", + "name": "INTERNAL_ERROR" + }, + { + "value": "SSM_UNAVAILABLE", + "name": "SSM_UNAVAILABLE" + }, + { + "value": "SSM_THROTTLED", + "name": "SSM_THROTTLED" + }, + { + "value": "EVENTBRIDGE_UNAVAILABLE", + "name": "EVENTBRIDGE_UNAVAILABLE" + }, + { + "value": "EVENTBRIDGE_THROTTLED", + "name": "EVENTBRIDGE_THROTTLED" + }, + { + "value": "RESOURCE_SCAN_NOT_DISABLED", + "name": "RESOURCE_SCAN_NOT_DISABLED" + }, + { + "value": "DISASSOCIATE_ALL_MEMBERS", + "name": "DISASSOCIATE_ALL_MEMBERS" + }, + { + "value": "ACCOUNT_IS_ISOLATED", + "name": "ACCOUNT_IS_ISOLATED" + }, + { + "value": "EC2_SSM_RESOURCE_DATA_SYNC_LIMIT_EXCEEDED", + "name": "EC2_SSM_RESOURCE_DATA_SYNC_LIMIT_EXCEEDED" + }, + { + "value": "EC2_SSM_ASSOCIATION_VERSION_LIMIT_EXCEEDED", + "name": "EC2_SSM_ASSOCIATION_VERSION_LIMIT_EXCEEDED" + } + ] + } + }, + "com.amazonaws.inspector2#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.inspector2#Evidence": { + "type": "structure", + "members": { + "evidenceRule": { + "target": "com.amazonaws.inspector2#EvidenceRule", + "traits": { + "smithy.api#documentation": "

The evidence rule.

" + } + }, + "evidenceDetail": { + "target": "com.amazonaws.inspector2#EvidenceDetail", + "traits": { + "smithy.api#documentation": "

The evidence details.

" + } + }, + "severity": { + "target": "com.amazonaws.inspector2#EvidenceSeverity", + "traits": { + "smithy.api#documentation": "

The evidence severity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details of the evidence for a vulnerability identified in a finding.

" + } + }, + "com.amazonaws.inspector2#EvidenceDetail": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.inspector2#EvidenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Evidence" + } + }, + "com.amazonaws.inspector2#EvidenceRule": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.inspector2#EvidenceSeverity": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.inspector2#ExecutionRoleArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, + "com.amazonaws.inspector2#ExploitAvailable": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "YES", + "name": "YES" + }, + { + "value": "NO", + "name": "NO" + } + ] + } + }, + "com.amazonaws.inspector2#ExploitObserved": { + "type": "structure", + "members": { + "lastSeen": { + "target": "com.amazonaws.inspector2#LastSeen", + "traits": { + "smithy.api#documentation": "

The date an time when the exploit was last seen.

" + } + }, + "firstSeen": { + "target": "com.amazonaws.inspector2#FirstSeen", + "traits": { + "smithy.api#documentation": "

The date an time when the exploit was first seen.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information on when this exploit was observed.

" + } + }, + "com.amazonaws.inspector2#ExploitabilityDetails": { + "type": "structure", + "members": { + "lastKnownExploitAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time of the last exploit associated with a finding discovered in your environment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of an exploit available for a finding discovered in your environment.

" + } + }, + "com.amazonaws.inspector2#ExternalReportStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SUCCEEDED", + "name": "SUCCEEDED" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "CANCELLED", + "name": "CANCELLED" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.inspector2#FailedAccount": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.inspector2#Status", + "traits": { + "smithy.api#documentation": "

The status of Amazon Inspector for the account.

" + } + }, + "resourceStatus": { + "target": "com.amazonaws.inspector2#ResourceStatus", + "traits": { + "smithy.api#documentation": "

An object detailing which resources Amazon Inspector is enabled to scan for the account.

" + } + }, + "errorCode": { + "target": "com.amazonaws.inspector2#ErrorCode", + "traits": { + "smithy.api#documentation": "

The error code explaining why the account failed to enable Amazon Inspector.

", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The error message received when the account failed to enable Amazon Inspector.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object with details on why an account failed to enable Amazon Inspector.

" + } + }, + "com.amazonaws.inspector2#FailedAccountList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#FailedAccount" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.inspector2#FailedMemberAccountEc2DeepInspectionStatusState": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the Amazon Web Services account of the organization member that failed to activate Amazon Inspector deep inspection.

", + "smithy.api#required": {} + } + }, + "ec2ScanStatus": { + "target": "com.amazonaws.inspector2#Status", + "traits": { + "smithy.api#documentation": "

The status of EC2 scanning in the account that failed to activate Amazon Inspector deep inspection.

" + } + }, + "errorMessage": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The error message explaining why the account failed to activate Amazon Inspector deep inspection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains details about a member account in your organization that failed to activate Amazon Inspector deep inspection.

" + } + }, + "com.amazonaws.inspector2#FailedMemberAccountEc2DeepInspectionStatusStateList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#FailedMemberAccountEc2DeepInspectionStatusState" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.inspector2#FilePath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#Filter": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.inspector2#FilterArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) associated with this filter.

", + "smithy.api#required": {} + } + }, + "ownerId": { + "target": "com.amazonaws.inspector2#OwnerId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the account that created the filter.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.inspector2#FilterName", + "traits": { + "smithy.api#documentation": "

The name of the filter.

", + "smithy.api#required": {} + } + }, + "criteria": { + "target": "com.amazonaws.inspector2#FilterCriteria", + "traits": { + "smithy.api#documentation": "

Details on the filter criteria associated with this filter.

", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.inspector2#FilterAction", + "traits": { + "smithy.api#documentation": "

The action that is to be applied to the findings that match the filter.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time this filter was created at.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time the filter was last updated at.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.inspector2#FilterDescription", + "traits": { + "smithy.api#documentation": "

A description of the filter.

" + } + }, + "reason": { + "target": "com.amazonaws.inspector2#FilterReason", + "traits": { + "smithy.api#documentation": "

The reason for the filter.

" + } + }, + "tags": { + "target": "com.amazonaws.inspector2#TagMap", + "traits": { + "smithy.api#documentation": "

The tags attached to the filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a filter.

" + } + }, + "com.amazonaws.inspector2#FilterAction": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "SUPPRESS", + "name": "SUPPRESS" + } + ] + } + }, + "com.amazonaws.inspector2#FilterArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.inspector2#FilterArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#FilterArn" + } + }, + "com.amazonaws.inspector2#FilterCriteria": { + "type": "structure", + "members": { + "findingArn": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Details on the finding ARNs used to filter findings.

" + } + }, + "awsAccountId": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Details of the Amazon Web Services account IDs used to filter findings.

" + } + }, + "findingType": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Details on the finding types used to filter findings.

" + } + }, + "severity": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Details on the severity used to filter findings.

" + } + }, + "firstObservedAt": { + "target": "com.amazonaws.inspector2#DateFilterList", + "traits": { + "smithy.api#documentation": "

Details on the date and time a finding was first seen used to filter findings.

" + } + }, + "lastObservedAt": { + "target": "com.amazonaws.inspector2#DateFilterList", + "traits": { + "smithy.api#documentation": "

Details on the date and time a finding was last seen used to filter findings.

" + } + }, + "updatedAt": { + "target": "com.amazonaws.inspector2#DateFilterList", + "traits": { + "smithy.api#documentation": "

Details on the date and time a finding was last updated at used to filter findings.

" + } + }, + "findingStatus": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Details on the finding status types used to filter findings.

" + } + }, + "title": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Details on the finding title used to filter findings.

" + } + }, + "inspectorScore": { + "target": "com.amazonaws.inspector2#NumberFilterList", + "traits": { + "smithy.api#documentation": "

The Amazon Inspector score to filter on.

" + } + }, + "resourceType": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Details on the resource types used to filter findings.

" + } + }, + "resourceId": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Details on the resource IDs used to filter findings.

" + } + }, + "resourceTags": { + "target": "com.amazonaws.inspector2#MapFilterList", + "traits": { + "smithy.api#documentation": "

Details on the resource tags used to filter findings.

" + } + }, + "ec2InstanceImageId": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Details of the Amazon EC2 instance image IDs used to filter findings.

" + } + }, + "ec2InstanceVpcId": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Details of the Amazon EC2 instance VPC IDs used to filter findings.

" + } + }, + "ec2InstanceSubnetId": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Details of the Amazon EC2 instance subnet IDs used to filter findings.

" + } + }, + "ecrImagePushedAt": { + "target": "com.amazonaws.inspector2#DateFilterList", + "traits": { + "smithy.api#documentation": "

Details on the Amazon ECR image push date and time used to filter findings.

" + } + }, + "ecrImageArchitecture": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Details of the Amazon ECR image architecture types used to filter findings.

" + } + }, + "ecrImageRegistry": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Details on the Amazon ECR registry used to filter findings.

" + } + }, + "ecrImageRepositoryName": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Details on the name of the Amazon ECR repository used to filter findings.

" + } + }, + "ecrImageTags": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The tags attached to the Amazon ECR container image.

" + } + }, + "ecrImageHash": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Details of the Amazon ECR image hashes used to filter findings.

" + } + }, + "portRange": { + "target": "com.amazonaws.inspector2#PortRangeFilterList", + "traits": { + "smithy.api#documentation": "

Details on the port ranges used to filter findings.

" + } + }, + "networkProtocol": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Details on network protocol used to filter findings.

" + } + }, + "componentId": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Details of the component IDs used to filter findings.

" + } + }, + "componentType": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Details of the component types used to filter findings.

" + } + }, + "vulnerabilityId": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Details on the vulnerability ID used to filter findings.

" + } + }, + "vulnerabilitySource": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Details on the vulnerability type used to filter findings.

" + } + }, + "vendorSeverity": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Details on the vendor severity used to filter findings.

" + } + }, + "vulnerablePackages": { + "target": "com.amazonaws.inspector2#PackageFilterList", + "traits": { + "smithy.api#documentation": "

Details on the vulnerable packages used to filter findings.

" + } + }, + "relatedVulnerabilities": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Details on the related vulnerabilities used to filter findings.

" + } + }, + "fixAvailable": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Details on whether a fix is available through a version update. This value can be YES, NO, or PARTIAL. A PARTIAL fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.

" + } + }, + "lambdaFunctionName": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Filters the list of Amazon Web Services Lambda functions by the name of the function.

" + } + }, + "lambdaFunctionLayers": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Filters the list of Amazon Web Services Lambda functions by the function's \n layers. A Lambda function can have up to five layers.

" + } + }, + "lambdaFunctionRuntime": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Filters the list of Amazon Web Services Lambda functions by the runtime environment for the Lambda function.

" + } + }, + "lambdaFunctionLastModifiedAt": { + "target": "com.amazonaws.inspector2#DateFilterList", + "traits": { + "smithy.api#documentation": "

Filters the list of Amazon Web Services Lambda functions by the date and time that a user last updated the configuration, in ISO 8601 format\n

" + } + }, + "lambdaFunctionExecutionRoleArn": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Filters the list of Amazon Web Services Lambda functions by execution role.

" + } + }, + "exploitAvailable": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Filters the list of Amazon Web Services Lambda findings by the availability of exploits.

" + } + }, + "codeVulnerabilityDetectorName": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The name of the detector used to identify a code vulnerability in a Lambda function used to filter findings.

" + } + }, + "codeVulnerabilityDetectorTags": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The detector type tag associated with the vulnerability used to filter findings. Detector tags group related vulnerabilities by common themes or tactics. For a list of available tags by programming language, see Java tags, or Python tags.

" + } + }, + "codeVulnerabilityFilePath": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The file path to the file in a Lambda function that contains a code vulnerability used to filter findings.

" + } + }, + "epssScore": { + "target": "com.amazonaws.inspector2#NumberFilterList", + "traits": { + "smithy.api#documentation": "

The EPSS score used to filter findings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details on the criteria used to define the filter.

" + } + }, + "com.amazonaws.inspector2#FilterDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.inspector2#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Filter" + } + }, + "com.amazonaws.inspector2#FilterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.inspector2#FilterReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.inspector2#Finding": { + "type": "structure", + "members": { + "findingArn": { + "target": "com.amazonaws.inspector2#FindingArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the finding.

", + "smithy.api#required": {} + } + }, + "awsAccountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with the finding.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.inspector2#FindingType", + "traits": { + "smithy.api#documentation": "

The type of the finding. The type value determines the valid values for resource in your request. For more information, see Finding types in the Amazon Inspector user guide.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.inspector2#FindingDescription", + "traits": { + "smithy.api#documentation": "

The description of the finding.

", + "smithy.api#required": {} + } + }, + "title": { + "target": "com.amazonaws.inspector2#FindingTitle", + "traits": { + "smithy.api#documentation": "

The title of the finding.

" + } + }, + "remediation": { + "target": "com.amazonaws.inspector2#Remediation", + "traits": { + "smithy.api#documentation": "

An object that contains the details about how to remediate a finding.

", + "smithy.api#required": {} + } + }, + "severity": { + "target": "com.amazonaws.inspector2#Severity", + "traits": { + "smithy.api#documentation": "

The severity of the finding. UNTRIAGED applies to PACKAGE_VULNERABILITY type findings that the vendor has not assigned a severity yet. For more information, see Severity levels for findings in the Amazon Inspector user guide.

", + "smithy.api#required": {} + } + }, + "firstObservedAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the finding was first observed.

", + "smithy.api#required": {} + } + }, + "lastObservedAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "

\n The date and time the finding was last observed. \n This timestamp for this field remains unchanged until a finding is updated.\n

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time the finding was last updated at.

" + } + }, + "status": { + "target": "com.amazonaws.inspector2#FindingStatus", + "traits": { + "smithy.api#documentation": "

The status of the finding.

", + "smithy.api#required": {} + } + }, + "resources": { + "target": "com.amazonaws.inspector2#ResourceList", + "traits": { + "smithy.api#documentation": "

Contains information on the resources involved in a finding. The resource value determines the valid values for type in your request. For more information, see Finding types in the Amazon Inspector user guide.

", + "smithy.api#required": {} + } + }, + "inspectorScore": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The Amazon Inspector score given to the finding.

" + } + }, + "inspectorScoreDetails": { + "target": "com.amazonaws.inspector2#InspectorScoreDetails", + "traits": { + "smithy.api#documentation": "

An object that contains details of the Amazon Inspector score.

" + } + }, + "networkReachabilityDetails": { + "target": "com.amazonaws.inspector2#NetworkReachabilityDetails", + "traits": { + "smithy.api#documentation": "

An object that contains the details of a network reachability finding.

" + } + }, + "packageVulnerabilityDetails": { + "target": "com.amazonaws.inspector2#PackageVulnerabilityDetails", + "traits": { + "smithy.api#documentation": "

An object that contains the details of a package vulnerability finding.

" + } + }, + "fixAvailable": { + "target": "com.amazonaws.inspector2#FixAvailable", + "traits": { + "smithy.api#documentation": "

Details on whether a fix is available through a version update. This value can be YES, NO, or PARTIAL. A PARTIAL fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.

" + } + }, + "exploitAvailable": { + "target": "com.amazonaws.inspector2#ExploitAvailable", + "traits": { + "smithy.api#documentation": "

If a finding discovered in your environment has an exploit available.

" + } + }, + "exploitabilityDetails": { + "target": "com.amazonaws.inspector2#ExploitabilityDetails", + "traits": { + "smithy.api#documentation": "

The details of an exploit available for a finding discovered in your environment.

" + } + }, + "codeVulnerabilityDetails": { + "target": "com.amazonaws.inspector2#CodeVulnerabilityDetails", + "traits": { + "smithy.api#documentation": "

Details about the code vulnerability identified in a Lambda function used to filter findings.

" + } + }, + "epss": { + "target": "com.amazonaws.inspector2#EpssDetails", + "traits": { + "smithy.api#documentation": "

The finding's EPSS score.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about an Amazon Inspector finding.

" + } + }, + "com.amazonaws.inspector2#FindingArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:inspector2:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:finding/[a-f0-9]{32}$" + } + }, + "com.amazonaws.inspector2#FindingArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#FindingArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#FindingArns": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#FindingArn" + } + }, + "com.amazonaws.inspector2#FindingDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#FindingDetail": { + "type": "structure", + "members": { + "findingArn": { + "target": "com.amazonaws.inspector2#FindingArn", + "traits": { + "smithy.api#documentation": "

The finding ARN that the vulnerability details are associated with.

" + } + }, + "cisaData": { + "target": "com.amazonaws.inspector2#CisaData" + }, + "riskScore": { + "target": "com.amazonaws.inspector2#RiskScore", + "traits": { + "smithy.api#documentation": "

The risk score of the vulnerability.

" + } + }, + "evidences": { + "target": "com.amazonaws.inspector2#EvidenceList", + "traits": { + "smithy.api#documentation": "

Information on the evidence of the vulnerability.

" + } + }, + "ttps": { + "target": "com.amazonaws.inspector2#Ttps", + "traits": { + "smithy.api#documentation": "

The MITRE adversary tactics, techniques, or procedures (TTPs) associated with the vulnerability.

" + } + }, + "tools": { + "target": "com.amazonaws.inspector2#Tools", + "traits": { + "smithy.api#documentation": "

The known malware tools or kits that can exploit the vulnerability.

" + } + }, + "exploitObserved": { + "target": "com.amazonaws.inspector2#ExploitObserved" + }, + "referenceUrls": { + "target": "com.amazonaws.inspector2#VulnerabilityReferenceUrls", + "traits": { + "smithy.api#documentation": "

The reference URLs for the vulnerability data.

" + } + }, + "cwes": { + "target": "com.amazonaws.inspector2#Cwes", + "traits": { + "smithy.api#documentation": "

The Common Weakness Enumerations (CWEs) associated with the vulnerability.

" + } + }, + "epssScore": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The Exploit Prediction Scoring System (EPSS) score of the vulnerability.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details of the vulnerability identified in a finding.

" + } + }, + "com.amazonaws.inspector2#FindingDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#FindingDetail" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.inspector2#FindingDetailsError": { + "type": "structure", + "members": { + "findingArn": { + "target": "com.amazonaws.inspector2#FindingArn", + "traits": { + "smithy.api#documentation": "

The finding ARN that returned an error.

", + "smithy.api#required": {} + } + }, + "errorCode": { + "target": "com.amazonaws.inspector2#FindingDetailsErrorCode", + "traits": { + "smithy.api#documentation": "

The error code.

", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The error message.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about an error encountered when trying to return vulnerability data for a finding.

" + } + }, + "com.amazonaws.inspector2#FindingDetailsErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INTERNAL_ERROR", + "name": "INTERNAL_ERROR" + }, + { + "value": "ACCESS_DENIED", + "name": "ACCESS_DENIED" + }, + { + "value": "FINDING_DETAILS_NOT_FOUND", + "name": "FINDING_DETAILS_NOT_FOUND" + }, + { + "value": "INVALID_INPUT", + "name": "INVALID_INPUT" + } + ] + } + }, + "com.amazonaws.inspector2#FindingDetailsErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#FindingDetailsError" + } + }, + "com.amazonaws.inspector2#FindingList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Finding" + }, + "traits": { + "smithy.api#length": { + "max": 25 + } + } + }, + "com.amazonaws.inspector2#FindingStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "SUPPRESSED", + "name": "SUPPRESSED" + }, + { + "value": "CLOSED", + "name": "CLOSED" + } + ] + } + }, + "com.amazonaws.inspector2#FindingTitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#FindingType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NETWORK_REACHABILITY", + "name": "NETWORK_REACHABILITY" + }, + { + "value": "PACKAGE_VULNERABILITY", + "name": "PACKAGE_VULNERABILITY" + }, + { + "value": "CODE_VULNERABILITY", + "name": "CODE_VULNERABILITY" + } + ] + } + }, + "com.amazonaws.inspector2#FindingTypeAggregation": { + "type": "structure", + "members": { + "findingType": { + "target": "com.amazonaws.inspector2#AggregationFindingType", + "traits": { + "smithy.api#documentation": "

The finding type to aggregate.

" + } + }, + "resourceType": { + "target": "com.amazonaws.inspector2#AggregationResourceType", + "traits": { + "smithy.api#documentation": "

The resource type to aggregate.

" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#SortOrder", + "traits": { + "smithy.api#documentation": "

The order to sort results by.

" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#FindingTypeSortBy", + "traits": { + "smithy.api#documentation": "

The value to sort results by.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details that define an aggregation based on finding type.

" + } + }, + "com.amazonaws.inspector2#FindingTypeAggregationResponse": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account associated with the findings.

" + } + }, + "severityCounts": { + "target": "com.amazonaws.inspector2#SeverityCounts", + "traits": { + "smithy.api#documentation": "

The value to sort results by.

" + } + }, + "exploitAvailableCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The number of findings that have an exploit available.

" + } + }, + "fixAvailableCount": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

\n Details about the number of fixes.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A response that contains the results of a finding type aggregation.

" + } + }, + "com.amazonaws.inspector2#FindingTypeSortBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CRITICAL", + "name": "CRITICAL" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "ALL", + "name": "ALL" + } + ] + } + }, + "com.amazonaws.inspector2#FirstSeen": { + "type": "timestamp" + }, + "com.amazonaws.inspector2#FixAvailable": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "YES", + "name": "YES" + }, + { + "value": "NO", + "name": "NO" + }, + { + "value": "PARTIAL", + "name": "PARTIAL" + } + ] + } + }, + "com.amazonaws.inspector2#FreeTrialAccountInfo": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#MeteringAccountId", + "traits": { + "smithy.api#documentation": "

The account associated with the Amazon Inspector free trial information.

", + "smithy.api#required": {} + } + }, + "freeTrialInfo": { + "target": "com.amazonaws.inspector2#FreeTrialInfoList", + "traits": { + "smithy.api#documentation": "

Contains information about the Amazon Inspector free trial for an account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the Amazon Inspector free trial for an account.

" + } + }, + "com.amazonaws.inspector2#FreeTrialAccountInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#FreeTrialAccountInfo" + } + }, + "com.amazonaws.inspector2#FreeTrialInfo": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.inspector2#FreeTrialType", + "traits": { + "smithy.api#documentation": "

The type of scan covered by the Amazon Inspector free trail.

", + "smithy.api#required": {} + } + }, + "start": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the Amazon Inspector free trail started for a given account.

", + "smithy.api#required": {} + } + }, + "end": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the Amazon Inspector free trail ends for a given account.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.inspector2#FreeTrialStatus", + "traits": { + "smithy.api#documentation": "

The order to sort results by.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains information about the Amazon Inspector free trial for an account.

" + } + }, + "com.amazonaws.inspector2#FreeTrialInfoError": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#MeteringAccountId", + "traits": { + "smithy.api#documentation": "

The account associated with the Amazon Inspector free trial information.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "com.amazonaws.inspector2#FreeTrialInfoErrorCode", + "traits": { + "smithy.api#documentation": "

The error code.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The error message returned.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an error received while accessing free trail data for an account.

" + } + }, + "com.amazonaws.inspector2#FreeTrialInfoErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ACCESS_DENIED", + "value": "ACCESS_DENIED" + }, + { + "name": "INTERNAL_ERROR", + "value": "INTERNAL_ERROR" + } + ] + } + }, + "com.amazonaws.inspector2#FreeTrialInfoErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#FreeTrialInfoError" + } + }, + "com.amazonaws.inspector2#FreeTrialInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#FreeTrialInfo" + } + }, + "com.amazonaws.inspector2#FreeTrialStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ACTIVE", + "value": "ACTIVE" + }, + { + "name": "INACTIVE", + "value": "INACTIVE" + } + ] + } + }, + "com.amazonaws.inspector2#FreeTrialType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "EC2", + "value": "EC2" + }, + { + "name": "ECR", + "value": "ECR" + }, + { + "name": "LAMBDA", + "value": "LAMBDA" + }, + { + "name": "LAMBDA_CODE", + "value": "LAMBDA_CODE" + } + ] + } + }, + "com.amazonaws.inspector2#FunctionName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" + } + }, + "com.amazonaws.inspector2#GetCisScanReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#GetCisScanReportRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#GetCisScanReportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a CIS scan report.

", + "smithy.api#examples": [ + { + "title": "Sample GetCisScanReport Call", + "input": { + "scanArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38", + "reportFormat": "PDF" + }, + "output": { + "url": "www.s3.amazon.com/abcdef", + "status": "SUCCEEDED" + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/cis/scan/report/get" + } + } + }, + "com.amazonaws.inspector2#GetCisScanReportRequest": { + "type": "structure", + "members": { + "scanArn": { + "target": "com.amazonaws.inspector2#CisScanArn", + "traits": { + "smithy.api#documentation": "

The scan ARN.

", + "smithy.api#required": {} + } + }, + "targetAccounts": { + "target": "com.amazonaws.inspector2#ReportTargetAccounts", + "traits": { + "smithy.api#documentation": "

The target accounts.

" + } + }, + "reportFormat": { + "target": "com.amazonaws.inspector2#CisReportFormat", + "traits": { + "smithy.api#default": "PDF", + "smithy.api#documentation": "

\n The format of the report. \n Valid values are PDF and CSV. \n If no value is specified, the report format defaults to PDF.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#GetCisScanReportResponse": { + "type": "structure", + "members": { + "url": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n The URL where a PDF or CSV of the CIS scan report can be downloaded.\n

" + } + }, + "status": { + "target": "com.amazonaws.inspector2#CisReportStatus", + "traits": { + "smithy.api#documentation": "

The status.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.inspector2#GetCisScanResultDetails": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#GetCisScanResultDetailsRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#GetCisScanResultDetailsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves CIS scan result details.

", + "smithy.api#examples": [ + { + "title": "Sample GetCisScanResultDetails Call", + "input": { + "scanArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38", + "targetResourceId": "i-12341234", + "accountId": "123412341234" + }, + "output": { + "scanResultDetails": [ + { + "scanArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38", + "accountId": "123412341234", + "targetResourceId": "i-12341234", + "platform": "AMAZON_LINUX_2", + "status": "PASSED", + "checkId": "1.1.1.1", + "title": "title1", + "checkDescription": "description", + "remediation": "fix", + "level": "LEVEL_1" + } + ] + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/cis/scan-result/details/get" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "scanResultDetails", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.inspector2#GetCisScanResultDetailsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.inspector2#GetCisScanResultDetailsRequest": { + "type": "structure", + "members": { + "scanArn": { + "target": "com.amazonaws.inspector2#CisScanArn", + "traits": { + "smithy.api#documentation": "

The scan ARN.

", + "smithy.api#required": {} + } + }, + "targetResourceId": { + "target": "com.amazonaws.inspector2#ResourceId", + "traits": { + "smithy.api#documentation": "

The target resource ID.

", + "smithy.api#required": {} + } + }, + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID.

", + "smithy.api#required": {} + } + }, + "filterCriteria": { + "target": "com.amazonaws.inspector2#CisScanResultDetailsFilterCriteria", + "traits": { + "smithy.api#documentation": "

The filter criteria.

" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#CisScanResultDetailsSortBy", + "traits": { + "smithy.api#default": "CHECK_ID", + "smithy.api#documentation": "

The sort by order.

" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#CisSortOrder", + "traits": { + "smithy.api#documentation": "

The sort order.

" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token from a previous request that's used to retrieve the next page of results.

" + } + }, + "maxResults": { + "target": "com.amazonaws.inspector2#GetCisScanResultDetailsMaxResults", + "traits": { + "smithy.api#default": 300, + "smithy.api#documentation": "

The maximum number of CIS scan result details to be returned in a single page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#GetCisScanResultDetailsResponse": { + "type": "structure", + "members": { + "scanResultDetails": { + "target": "com.amazonaws.inspector2#CisScanResultDetailsList", + "traits": { + "smithy.api#documentation": "

The scan result details.

" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token from a previous request that's used to retrieve the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.inspector2#GetConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#GetConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#GetConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves setting configurations for Inspector scans.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/configuration/get" + } + } + }, + "com.amazonaws.inspector2#GetConfigurationRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.inspector2#GetConfigurationResponse": { + "type": "structure", + "members": { + "ecrConfiguration": { + "target": "com.amazonaws.inspector2#EcrConfigurationState", + "traits": { + "smithy.api#documentation": "

Specifies how the ECR automated re-scan duration is currently configured for your environment.

" + } + }, + "ec2Configuration": { + "target": "com.amazonaws.inspector2#Ec2ConfigurationState", + "traits": { + "smithy.api#documentation": "

Specifies how the Amazon EC2 automated scan mode is currently configured for your environment.

" + } + } + } + }, + "com.amazonaws.inspector2#GetDelegatedAdminAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#GetDelegatedAdminAccountRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#GetDelegatedAdminAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about the Amazon Inspector delegated administrator for your\n organization.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/delegatedadminaccounts/get" + } + } + }, + "com.amazonaws.inspector2#GetDelegatedAdminAccountRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.inspector2#GetDelegatedAdminAccountResponse": { + "type": "structure", + "members": { + "delegatedAdmin": { + "target": "com.amazonaws.inspector2#DelegatedAdmin", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the Amazon Inspector delegated administrator.

" + } + } + } + }, + "com.amazonaws.inspector2#GetEc2DeepInspectionConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#GetEc2DeepInspectionConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#GetEc2DeepInspectionConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the activation status of Amazon Inspector deep inspection and custom paths associated with your account. \n

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/ec2deepinspectionconfiguration/get" + } + } + }, + "com.amazonaws.inspector2#GetEc2DeepInspectionConfigurationRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#GetEc2DeepInspectionConfigurationResponse": { + "type": "structure", + "members": { + "packagePaths": { + "target": "com.amazonaws.inspector2#PathList", + "traits": { + "smithy.api#documentation": "

The Amazon Inspector deep inspection custom paths for your account.

" + } + }, + "orgPackagePaths": { + "target": "com.amazonaws.inspector2#PathList", + "traits": { + "smithy.api#documentation": "

The Amazon Inspector deep inspection custom paths for your organization.

" + } + }, + "status": { + "target": "com.amazonaws.inspector2#Ec2DeepInspectionStatus", + "traits": { + "smithy.api#documentation": "

The activation status of Amazon Inspector deep inspection in your account.

" + } + }, + "errorMessage": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An error message explaining why Amazon Inspector deep inspection configurations could not be retrieved for your account.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.inspector2#GetEncryptionKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#GetEncryptionKeyRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#GetEncryptionKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets an encryption key.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/encryptionkey/get" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.inspector2#GetEncryptionKeyRequest": { + "type": "structure", + "members": { + "scanType": { + "target": "com.amazonaws.inspector2#ScanType", + "traits": { + "smithy.api#documentation": "

The scan type the key encrypts.

", + "smithy.api#httpQuery": "scanType", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "com.amazonaws.inspector2#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type the key encrypts.

", + "smithy.api#httpQuery": "resourceType", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#GetEncryptionKeyResponse": { + "type": "structure", + "members": { + "kmsKeyId": { + "target": "com.amazonaws.inspector2#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

A kms key ID.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.inspector2#GetFindingsReportStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#GetFindingsReportStatusRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#GetFindingsReportStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the status of a findings report.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/reporting/status/get" + } + } + }, + "com.amazonaws.inspector2#GetFindingsReportStatusRequest": { + "type": "structure", + "members": { + "reportId": { + "target": "com.amazonaws.inspector2#ReportId", + "traits": { + "smithy.api#documentation": "

The ID of the report to retrieve the status of.

" + } + } + } + }, + "com.amazonaws.inspector2#GetFindingsReportStatusResponse": { + "type": "structure", + "members": { + "reportId": { + "target": "com.amazonaws.inspector2#ReportId", + "traits": { + "smithy.api#documentation": "

The ID of the report.

" + } + }, + "status": { + "target": "com.amazonaws.inspector2#ExternalReportStatus", + "traits": { + "smithy.api#documentation": "

The status of the report.

" + } + }, + "errorCode": { + "target": "com.amazonaws.inspector2#ReportingErrorCode", + "traits": { + "smithy.api#documentation": "

The error code of the report.

" + } + }, + "errorMessage": { + "target": "com.amazonaws.inspector2#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message of the report.

" + } + }, + "destination": { + "target": "com.amazonaws.inspector2#Destination", + "traits": { + "smithy.api#documentation": "

The destination of the report.

" + } + }, + "filterCriteria": { + "target": "com.amazonaws.inspector2#FilterCriteria", + "traits": { + "smithy.api#documentation": "

The filter criteria associated with the report.

" + } + } + } + }, + "com.amazonaws.inspector2#GetMember": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#GetMemberRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#GetMemberResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets member information for your organization.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/members/get" + } + } + }, + "com.amazonaws.inspector2#GetMemberRequest": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the member account to retrieve information on.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#GetMemberResponse": { + "type": "structure", + "members": { + "member": { + "target": "com.amazonaws.inspector2#Member", + "traits": { + "smithy.api#documentation": "

Details of the retrieved member account.

" + } + } + } + }, + "com.amazonaws.inspector2#GetSbomExport": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#GetSbomExportRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#GetSbomExportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets details of a software bill of materials (SBOM) report.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/sbomexport/get" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.inspector2#GetSbomExportRequest": { + "type": "structure", + "members": { + "reportId": { + "target": "com.amazonaws.inspector2#ReportId", + "traits": { + "smithy.api#documentation": "

The report ID of the SBOM export to get details for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#GetSbomExportResponse": { + "type": "structure", + "members": { + "reportId": { + "target": "com.amazonaws.inspector2#ReportId", + "traits": { + "smithy.api#documentation": "

The report ID of the software bill of materials (SBOM) report.

" + } + }, + "format": { + "target": "com.amazonaws.inspector2#SbomReportFormat", + "traits": { + "smithy.api#documentation": "

The format of the software bill of materials (SBOM) report.

" + } + }, + "status": { + "target": "com.amazonaws.inspector2#ExternalReportStatus", + "traits": { + "smithy.api#documentation": "

The status of the software bill of materials (SBOM) report.

" + } + }, + "errorCode": { + "target": "com.amazonaws.inspector2#ReportingErrorCode", + "traits": { + "smithy.api#documentation": "

An error code.

" + } + }, + "errorMessage": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An error message.

" + } + }, + "s3Destination": { + "target": "com.amazonaws.inspector2#Destination" + }, + "filterCriteria": { + "target": "com.amazonaws.inspector2#ResourceFilterCriteria", + "traits": { + "smithy.api#documentation": "

Contains details about the resource filter criteria used for the software bill of materials (SBOM) report.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.inspector2#GroupKey": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SCAN_STATUS_CODE", + "name": "SCAN_STATUS_CODE" + }, + { + "value": "SCAN_STATUS_REASON", + "name": "SCAN_STATUS_REASON" + }, + { + "value": "ACCOUNT_ID", + "name": "ACCOUNT_ID" + }, + { + "value": "RESOURCE_TYPE", + "name": "RESOURCE_TYPE" + }, + { + "value": "ECR_REPOSITORY_NAME", + "name": "ECR_REPOSITORY_NAME" + } + ] + } + }, + "com.amazonaws.inspector2#ImageHash": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 71, + "max": 71 + }, + "smithy.api#pattern": "^sha256:[a-z0-9]{64}$" + } + }, + "com.amazonaws.inspector2#ImageLayerAggregation": { + "type": "structure", + "members": { + "repositories": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The repository associated with the container image hosting the layers.

" + } + }, + "resourceIds": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The ID of the container image layer.

" + } + }, + "layerHashes": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The hashes associated with the layers.

" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#SortOrder", + "traits": { + "smithy.api#documentation": "

The order to sort results by.

" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#ImageLayerSortBy", + "traits": { + "smithy.api#documentation": "

The value to sort results by.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details that define an aggregation based on container image layers.

" + } + }, + "com.amazonaws.inspector2#ImageLayerAggregationResponse": { + "type": "structure", + "members": { + "repository": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The repository the layer resides in.

", + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The resource ID of the container image layer.

", + "smithy.api#required": {} + } + }, + "layerHash": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The layer hash.

", + "smithy.api#required": {} + } + }, + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the container image hosting the layer image.

", + "smithy.api#required": {} + } + }, + "severityCounts": { + "target": "com.amazonaws.inspector2#SeverityCounts", + "traits": { + "smithy.api#documentation": "

An object that represents the count of matched findings per severity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A response that contains the results of a finding aggregation by image layer.

" + } + }, + "com.amazonaws.inspector2#ImageLayerSortBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CRITICAL", + "name": "CRITICAL" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "ALL", + "name": "ALL" + } + ] + } + }, + "com.amazonaws.inspector2#ImageTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#NonEmptyString" + } + }, + "com.amazonaws.inspector2#Inspector2": { + "type": "service", + "version": "2020-06-08", + "operations": [ + { + "target": "com.amazonaws.inspector2#AssociateMember" + }, + { + "target": "com.amazonaws.inspector2#BatchGetAccountStatus" + }, + { + "target": "com.amazonaws.inspector2#BatchGetCodeSnippet" + }, + { + "target": "com.amazonaws.inspector2#BatchGetFindingDetails" + }, + { + "target": "com.amazonaws.inspector2#BatchGetFreeTrialInfo" + }, + { + "target": "com.amazonaws.inspector2#BatchGetMemberEc2DeepInspectionStatus" + }, + { + "target": "com.amazonaws.inspector2#BatchUpdateMemberEc2DeepInspectionStatus" + }, + { + "target": "com.amazonaws.inspector2#CancelFindingsReport" + }, + { + "target": "com.amazonaws.inspector2#CancelSbomExport" + }, + { + "target": "com.amazonaws.inspector2#CreateCisScanConfiguration" + }, + { + "target": "com.amazonaws.inspector2#CreateFilter" + }, + { + "target": "com.amazonaws.inspector2#CreateFindingsReport" + }, + { + "target": "com.amazonaws.inspector2#CreateSbomExport" + }, + { + "target": "com.amazonaws.inspector2#DeleteCisScanConfiguration" + }, + { + "target": "com.amazonaws.inspector2#DeleteFilter" + }, + { + "target": "com.amazonaws.inspector2#DescribeOrganizationConfiguration" + }, + { + "target": "com.amazonaws.inspector2#Disable" + }, + { + "target": "com.amazonaws.inspector2#DisableDelegatedAdminAccount" + }, + { + "target": "com.amazonaws.inspector2#DisassociateMember" + }, + { + "target": "com.amazonaws.inspector2#Enable" + }, + { + "target": "com.amazonaws.inspector2#EnableDelegatedAdminAccount" + }, + { + "target": "com.amazonaws.inspector2#GetCisScanReport" + }, + { + "target": "com.amazonaws.inspector2#GetCisScanResultDetails" + }, + { + "target": "com.amazonaws.inspector2#GetConfiguration" + }, + { + "target": "com.amazonaws.inspector2#GetDelegatedAdminAccount" + }, + { + "target": "com.amazonaws.inspector2#GetEc2DeepInspectionConfiguration" + }, + { + "target": "com.amazonaws.inspector2#GetEncryptionKey" + }, + { + "target": "com.amazonaws.inspector2#GetFindingsReportStatus" + }, + { + "target": "com.amazonaws.inspector2#GetMember" + }, + { + "target": "com.amazonaws.inspector2#GetSbomExport" + }, + { + "target": "com.amazonaws.inspector2#ListAccountPermissions" + }, + { + "target": "com.amazonaws.inspector2#ListCisScanConfigurations" + }, + { + "target": "com.amazonaws.inspector2#ListCisScanResultsAggregatedByChecks" + }, + { + "target": "com.amazonaws.inspector2#ListCisScanResultsAggregatedByTargetResource" + }, + { + "target": "com.amazonaws.inspector2#ListCisScans" + }, + { + "target": "com.amazonaws.inspector2#ListCoverage" + }, + { + "target": "com.amazonaws.inspector2#ListCoverageStatistics" + }, + { + "target": "com.amazonaws.inspector2#ListDelegatedAdminAccounts" + }, + { + "target": "com.amazonaws.inspector2#ListFilters" + }, + { + "target": "com.amazonaws.inspector2#ListFindingAggregations" + }, + { + "target": "com.amazonaws.inspector2#ListFindings" + }, + { + "target": "com.amazonaws.inspector2#ListMembers" + }, + { + "target": "com.amazonaws.inspector2#ListTagsForResource" + }, + { + "target": "com.amazonaws.inspector2#ListUsageTotals" + }, + { + "target": "com.amazonaws.inspector2#ResetEncryptionKey" + }, + { + "target": "com.amazonaws.inspector2#SearchVulnerabilities" + }, + { + "target": "com.amazonaws.inspector2#SendCisSessionHealth" + }, + { + "target": "com.amazonaws.inspector2#SendCisSessionTelemetry" + }, + { + "target": "com.amazonaws.inspector2#StartCisSession" + }, + { + "target": "com.amazonaws.inspector2#StopCisSession" + }, + { + "target": "com.amazonaws.inspector2#TagResource" + }, + { + "target": "com.amazonaws.inspector2#UntagResource" + }, + { + "target": "com.amazonaws.inspector2#UpdateCisScanConfiguration" + }, + { + "target": "com.amazonaws.inspector2#UpdateConfiguration" + }, + { + "target": "com.amazonaws.inspector2#UpdateEc2DeepInspectionConfiguration" + }, + { + "target": "com.amazonaws.inspector2#UpdateEncryptionKey" + }, + { + "target": "com.amazonaws.inspector2#UpdateFilter" + }, + { + "target": "com.amazonaws.inspector2#UpdateOrganizationConfiguration" + }, + { + "target": "com.amazonaws.inspector2#UpdateOrgEc2DeepInspectionConfiguration" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Inspector2", + "arnNamespace": "inspector2", + "cloudTrailEventSource": "inspector2.amazon.aws", + "cloudFormationName": "Inspector2" + }, + "aws.auth#sigv4": { + "name": "inspector2" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*" + ] + }, + "smithy.api#documentation": "

Amazon Inspector is a vulnerability discovery service that automates continuous scanning for\n security vulnerabilities within your Amazon EC2, Amazon ECR, and Amazon Web Services Lambda environments.

", + "smithy.api#title": "Inspector2", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://inspector2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://inspector2-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://inspector2.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://inspector2.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://inspector2.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://inspector2.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://inspector2.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://inspector2.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://inspector2.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://inspector2.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://inspector2.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://inspector2.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://inspector2.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://inspector2.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://inspector2.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://inspector2.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://inspector2.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://inspector2.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://inspector2.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://inspector2.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://inspector2.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://inspector2.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://inspector2.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://inspector2-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://inspector2-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://inspector2.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://inspector2-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://inspector2-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://inspector2.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://inspector2.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://inspector2-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://inspector2-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://inspector2.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://inspector2.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://inspector2-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://inspector2.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://inspector2-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://inspector2.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.inspector2#InspectorScoreDetails": { + "type": "structure", + "members": { + "adjustedCvss": { + "target": "com.amazonaws.inspector2#CvssScoreDetails", + "traits": { + "smithy.api#documentation": "

An object that contains details about the CVSS score given to a finding.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the Amazon Inspector score given to a finding.

" + } + }, + "com.amazonaws.inspector2#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "retryAfterSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of seconds to wait before retrying the request.

", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request has failed due to an internal failure of the Amazon Inspector service.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.inspector2#IpV4Address": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 7, + "max": 15 + }, + "smithy.api#pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$" + } + }, + "com.amazonaws.inspector2#IpV4AddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#IpV4Address" + } + }, + "com.amazonaws.inspector2#IpV6Address": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 47 + } + } + }, + "com.amazonaws.inspector2#IpV6AddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#IpV6Address" + } + }, + "com.amazonaws.inspector2#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(-(us-gov|cn))?:kms:([a-z0-9][-.a-z0-9]{0,62})?:[0-9]{12}?:key/(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|(mrk-[0-9a-zA-Z]{32}))$" + } + }, + "com.amazonaws.inspector2#LambdaFunctionAggregation": { + "type": "structure", + "members": { + "resourceIds": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The resource IDs to include in the aggregation results.

" + } + }, + "functionNames": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Lambda function names to include in the aggregation results.

" + } + }, + "runtimes": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

Returns findings aggregated by Amazon Web Services Lambda function runtime environments.

" + } + }, + "functionTags": { + "target": "com.amazonaws.inspector2#MapFilterList", + "traits": { + "smithy.api#documentation": "

The tags to include in the aggregation results.

" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#SortOrder", + "traits": { + "smithy.api#documentation": "

The order to use for sorting the results.

" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#LambdaFunctionSortBy", + "traits": { + "smithy.api#documentation": "

The finding severity to use for sorting the results.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details that define a findings aggregation based on Amazon Web Services Lambda functions.

" + } + }, + "com.amazonaws.inspector2#LambdaFunctionAggregationResponse": { + "type": "structure", + "members": { + "resourceId": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The resource IDs included in the aggregation results.

", + "smithy.api#required": {} + } + }, + "functionName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Lambda function names included in the aggregation results.

" + } + }, + "runtime": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The runtimes included in the aggregation results.

" + } + }, + "lambdaTags": { + "target": "com.amazonaws.inspector2#TagMap", + "traits": { + "smithy.api#documentation": "

The tags included in the aggregation results.

" + } + }, + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the Amazon Web Services Lambda function.\n

" + } + }, + "severityCounts": { + "target": "com.amazonaws.inspector2#SeverityCounts" + }, + "lastModifiedAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "

The date that the Amazon Web Services Lambda function included in the aggregation results was last changed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A response that contains the results of an Amazon Web Services Lambda function finding aggregation.

" + } + }, + "com.amazonaws.inspector2#LambdaFunctionMetadata": { + "type": "structure", + "members": { + "functionTags": { + "target": "com.amazonaws.inspector2#TagMap", + "traits": { + "smithy.api#documentation": "

The resource tags on an Amazon Web Services Lambda function.

" + } + }, + "layers": { + "target": "com.amazonaws.inspector2#LambdaLayerList", + "traits": { + "smithy.api#documentation": "

The layers for an Amazon Web Services Lambda function. A Lambda function can have up to five layers.

" + } + }, + "functionName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of a function.

" + } + }, + "runtime": { + "target": "com.amazonaws.inspector2#Runtime", + "traits": { + "smithy.api#documentation": "

An Amazon Web Services Lambda function's runtime.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Lambda function metadata.

" + } + }, + "com.amazonaws.inspector2#LambdaFunctionSortBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CRITICAL", + "name": "CRITICAL" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "ALL", + "name": "ALL" + } + ] + } + }, + "com.amazonaws.inspector2#LambdaLayerAggregation": { + "type": "structure", + "members": { + "functionNames": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The names of the Amazon Web Services Lambda functions associated with the layers.

" + } + }, + "resourceIds": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The resource IDs for the Amazon Web Services Lambda function layers.

" + } + }, + "layerArns": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Lambda function layer.\n

" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#SortOrder", + "traits": { + "smithy.api#documentation": "

The order to use for sorting the results.

" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#LambdaLayerSortBy", + "traits": { + "smithy.api#documentation": "

The finding severity to use for sorting the results.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details that define a findings aggregation based on an Amazon Web Services Lambda function's layers.

" + } + }, + "com.amazonaws.inspector2#LambdaLayerAggregationResponse": { + "type": "structure", + "members": { + "functionName": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The names of the Amazon Web Services Lambda functions associated with the layers.

", + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Resource ID of the Amazon Web Services Lambda function layer.

", + "smithy.api#required": {} + } + }, + "layerArn": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Lambda function layer.

", + "smithy.api#required": {} + } + }, + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the Amazon Web Services Lambda function layer.

", + "smithy.api#required": {} + } + }, + "severityCounts": { + "target": "com.amazonaws.inspector2#SeverityCounts" + } + }, + "traits": { + "smithy.api#documentation": "

A response that contains the results of an Amazon Web Services Lambda function layer finding aggregation.

" + } + }, + "com.amazonaws.inspector2#LambdaLayerArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\\d{12}:layer:[a-zA-Z0-9-_]+:[0-9]+$" + } + }, + "com.amazonaws.inspector2#LambdaLayerList": { + "type": "list", + "member": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.inspector2#LambdaLayerSortBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CRITICAL", + "name": "CRITICAL" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "ALL", + "name": "ALL" + } + ] + } + }, + "com.amazonaws.inspector2#LambdaVpcConfig": { + "type": "structure", + "members": { + "subnetIds": { + "target": "com.amazonaws.inspector2#SubnetIdList", + "traits": { + "smithy.api#documentation": "

A list of VPC subnet IDs.

" + } + }, + "securityGroupIds": { + "target": "com.amazonaws.inspector2#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

The VPC security groups and subnets that are attached to an Amazon Web Services Lambda function. For more information, see VPC Settings.

" + } + }, + "vpcId": { + "target": "com.amazonaws.inspector2#VpcId", + "traits": { + "smithy.api#documentation": "

The ID of the VPC.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The VPC security groups and subnets that are attached to an Amazon Web Services Lambda function. For more information, see VPC Settings.

" + } + }, + "com.amazonaws.inspector2#LastSeen": { + "type": "timestamp" + }, + "com.amazonaws.inspector2#LayerList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#LambdaLayerArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.inspector2#ListAccountPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#ListAccountPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#ListAccountPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the permissions an account has to configure Amazon Inspector.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/accountpermissions/list" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "permissions" + } + } + }, + "com.amazonaws.inspector2#ListAccountPermissionsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#ListAccountPermissionsRequest": { + "type": "structure", + "members": { + "service": { + "target": "com.amazonaws.inspector2#Service", + "traits": { + "smithy.api#documentation": "

The service scan type to check permissions for.

" + } + }, + "maxResults": { + "target": "com.amazonaws.inspector2#ListAccountPermissionsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

" + } + } + } + }, + "com.amazonaws.inspector2#ListAccountPermissionsResponse": { + "type": "structure", + "members": { + "permissions": { + "target": "com.amazonaws.inspector2#Permissions", + "traits": { + "smithy.api#documentation": "

Contains details on the permissions an account has to configure Amazon Inspector.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" + } + } + } + }, + "com.amazonaws.inspector2#ListCisScanConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#ListCisScanConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#ListCisScanConfigurationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists CIS scan configurations.

", + "smithy.api#examples": [ + { + "title": "Sample ListCisScanConfigurations Call", + "input": {}, + "output": { + "scanConfigurations": [ + { + "scanConfigurationArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-configuration/624b746d-e080-44ae-8c1d-48e653365a38", + "ownerId": "123412341234", + "scanName": "sample", + "securityLevel": "LEVEL_1", + "schedule": { + "daily": { + "startTime": { + "timeOfDay": "12:34", + "timezone": "UTC" + } + } + }, + "targets": { + "accountIds": [ + "123412341234" + ], + "targetResourceTags": { + "key": [ + "value" + ] + } + } + } + ] + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/cis/scan-configuration/list" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "scanConfigurations", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.inspector2#ListCisScanConfigurationsFilterCriteria": { + "type": "structure", + "members": { + "scanNameFilters": { + "target": "com.amazonaws.inspector2#CisScanNameFilterList", + "traits": { + "smithy.api#documentation": "

The list of scan name filters.

" + } + }, + "targetResourceTagFilters": { + "target": "com.amazonaws.inspector2#ResourceTagFilterList", + "traits": { + "smithy.api#documentation": "

The list of target resource tag filters.

" + } + }, + "scanConfigurationArnFilters": { + "target": "com.amazonaws.inspector2#CisScanConfigurationArnFilterList", + "traits": { + "smithy.api#documentation": "

The list of scan configuration ARN filters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of CIS scan configurations filter criteria.

" + } + }, + "com.amazonaws.inspector2#ListCisScanConfigurationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.inspector2#ListCisScanConfigurationsRequest": { + "type": "structure", + "members": { + "filterCriteria": { + "target": "com.amazonaws.inspector2#ListCisScanConfigurationsFilterCriteria", + "traits": { + "smithy.api#documentation": "

The CIS scan configuration filter criteria.

" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#CisScanConfigurationsSortBy", + "traits": { + "smithy.api#default": "SCAN_NAME", + "smithy.api#documentation": "

The CIS scan configuration sort by order.

" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#CisSortOrder", + "traits": { + "smithy.api#documentation": "

The CIS scan configuration sort order order.

" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token from a previous request that's used to retrieve the next page of results.

" + } + }, + "maxResults": { + "target": "com.amazonaws.inspector2#ListCisScanConfigurationsMaxResults", + "traits": { + "smithy.api#default": 100, + "smithy.api#documentation": "

The maximum number of CIS scan configurations to be returned in a single page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#ListCisScanConfigurationsResponse": { + "type": "structure", + "members": { + "scanConfigurations": { + "target": "com.amazonaws.inspector2#CisScanConfigurationList", + "traits": { + "smithy.api#documentation": "

The CIS scan configuration scan configurations.

" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token from a previous request that's used to retrieve the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.inspector2#ListCisScanResultsAggregatedByChecks": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#ListCisScanResultsAggregatedByChecksRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#ListCisScanResultsAggregatedByChecksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists scan results aggregated by checks.

", + "smithy.api#examples": [ + { + "title": "Sample ListCisScanResultsAggregatedByChecks Call", + "input": { + "scanArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38" + }, + "output": { + "checkAggregations": [ + { + "scanArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38", + "checkId": "1.1.1.1", + "title": "title1", + "checkDescription": "description", + "level": "LEVEL_1", + "accountId": "123412341234", + "statusCounts": { + "failed": 0, + "skipped": 1, + "passed": 2 + }, + "platform": "AMAZON_LINUX_2" + } + ] + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/cis/scan-result/check/list" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "checkAggregations", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.inspector2#ListCisScanResultsAggregatedByChecksRequest": { + "type": "structure", + "members": { + "scanArn": { + "target": "com.amazonaws.inspector2#CisScanArn", + "traits": { + "smithy.api#documentation": "

The scan ARN.

", + "smithy.api#required": {} + } + }, + "filterCriteria": { + "target": "com.amazonaws.inspector2#CisScanResultsAggregatedByChecksFilterCriteria", + "traits": { + "smithy.api#documentation": "

The filter criteria.

" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#CisScanResultsAggregatedByChecksSortBy", + "traits": { + "smithy.api#default": "FAILED_COUNTS", + "smithy.api#documentation": "

The sort by order.

" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#CisSortOrder", + "traits": { + "smithy.api#documentation": "

The sort order.

" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token from a previous request that's used to retrieve the next page of results.

" + } + }, + "maxResults": { + "target": "com.amazonaws.inspector2#CisScanResultsMaxResults", + "traits": { + "smithy.api#default": 100, + "smithy.api#documentation": "

The maximum number of scan results aggregated by checks to be returned in a single page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#ListCisScanResultsAggregatedByChecksResponse": { + "type": "structure", + "members": { + "checkAggregations": { + "target": "com.amazonaws.inspector2#CisCheckAggregationList", + "traits": { + "smithy.api#documentation": "

The check aggregations.

" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token from a previous request that's used to retrieve the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.inspector2#ListCisScanResultsAggregatedByTargetResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#ListCisScanResultsAggregatedByTargetResourceRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#ListCisScanResultsAggregatedByTargetResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists scan results aggregated by a target resource.

", + "smithy.api#examples": [ + { + "title": "Sample ListCisScanResultsAggregatedByTargetResource Call", + "input": { + "scanArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38" + }, + "output": { + "targetResourceAggregations": [ + { + "scanArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38", + "targetResourceId": "i-12341234", + "accountId": "123412341234", + "targetResourceTags": { + "key": [ + "value" + ] + }, + "statusCounts": { + "failed": 0, + "skipped": 1, + "passed": 2 + }, + "platform": "AMAZON_LINUX_2", + "targetStatus": "COMPLETED" + } + ] + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/cis/scan-result/resource/list" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "targetResourceAggregations", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.inspector2#ListCisScanResultsAggregatedByTargetResourceRequest": { + "type": "structure", + "members": { + "scanArn": { + "target": "com.amazonaws.inspector2#CisScanArn", + "traits": { + "smithy.api#documentation": "

The scan ARN.

", + "smithy.api#required": {} + } + }, + "filterCriteria": { + "target": "com.amazonaws.inspector2#CisScanResultsAggregatedByTargetResourceFilterCriteria", + "traits": { + "smithy.api#documentation": "

The filter criteria.

" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#CisScanResultsAggregatedByTargetResourceSortBy", + "traits": { + "smithy.api#default": "FAILED_COUNTS", + "smithy.api#documentation": "

The sort by order.

" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#CisSortOrder", + "traits": { + "smithy.api#documentation": "

The sort order.

" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token from a previous request that's used to retrieve the next page of results.

" + } + }, + "maxResults": { + "target": "com.amazonaws.inspector2#CisScanResultsMaxResults", + "traits": { + "smithy.api#default": 100, + "smithy.api#documentation": "

The maximum number of scan results aggregated by a target resource to be returned in a single page of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#ListCisScanResultsAggregatedByTargetResourceResponse": { + "type": "structure", + "members": { + "targetResourceAggregations": { + "target": "com.amazonaws.inspector2#CisTargetResourceAggregationList", + "traits": { + "smithy.api#documentation": "

The resource aggregations.

" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token from a previous request that's used to retrieve the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.inspector2#ListCisScans": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#ListCisScansRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#ListCisScansResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a CIS scan list.

", + "smithy.api#examples": [ + { + "title": "Sample ListCisScans Call", + "input": {}, + "output": { + "scans": [ + { + "scanArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38", + "scanConfigurationArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-configuration/624b746d-e080-44ae-8c1d-48e653365a38", + "status": "COMPLETED", + "scanName": "sample", + "scanDate": "2023-04-12T23:20:50.52Z", + "failedChecks": 2, + "totalChecks": 150, + "targets": { + "accountIds": [ + "123412341234" + ], + "targetResourceTags": { + "key": [ + "value" + ] + } + }, + "scheduledBy": "Delegated Admin", + "securityLevel": "LEVEL_1" + } + ] + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/cis/scan/list" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "scans", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.inspector2#ListCisScansDetailLevel": { + "type": "enum", + "members": { + "ORGANIZATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORGANIZATION" + } + }, + "MEMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEMBER" + } + } + } + }, + "com.amazonaws.inspector2#ListCisScansFilterCriteria": { + "type": "structure", + "members": { + "scanNameFilters": { + "target": "com.amazonaws.inspector2#CisScanNameFilterList", + "traits": { + "smithy.api#documentation": "

The list of scan name filters.

" + } + }, + "targetResourceTagFilters": { + "target": "com.amazonaws.inspector2#ResourceTagFilterList", + "traits": { + "smithy.api#documentation": "

The list of target resource tag filters.

" + } + }, + "targetResourceIdFilters": { + "target": "com.amazonaws.inspector2#ResourceIdFilterList", + "traits": { + "smithy.api#documentation": "

The list of target resource ID filters.

" + } + }, + "scanStatusFilters": { + "target": "com.amazonaws.inspector2#CisScanStatusFilterList", + "traits": { + "smithy.api#documentation": "

The list of scan status filters.

" + } + }, + "scanAtFilters": { + "target": "com.amazonaws.inspector2#CisScanDateFilterList", + "traits": { + "smithy.api#documentation": "

The list of scan at filters.

" + } + }, + "scanConfigurationArnFilters": { + "target": "com.amazonaws.inspector2#CisScanConfigurationArnFilterList", + "traits": { + "smithy.api#documentation": "

The list of scan configuration ARN filters.

" + } + }, + "scanArnFilters": { + "target": "com.amazonaws.inspector2#CisScanArnFilterList", + "traits": { + "smithy.api#documentation": "

The list of scan ARN filters.

" + } + }, + "scheduledByFilters": { + "target": "com.amazonaws.inspector2#CisScheduledByFilterList", + "traits": { + "smithy.api#documentation": "

The list of scheduled by filters.

" + } + }, + "failedChecksFilters": { + "target": "com.amazonaws.inspector2#CisNumberFilterList", + "traits": { + "smithy.api#documentation": "

The list of failed checks filters.

" + } + }, + "targetAccountIdFilters": { + "target": "com.amazonaws.inspector2#AccountIdFilterList", + "traits": { + "smithy.api#documentation": "

The list of target account ID filters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of CIS scans filter criteria.

" + } + }, + "com.amazonaws.inspector2#ListCisScansMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.inspector2#ListCisScansRequest": { + "type": "structure", + "members": { + "filterCriteria": { + "target": "com.amazonaws.inspector2#ListCisScansFilterCriteria", + "traits": { + "smithy.api#documentation": "

The CIS scan filter criteria.

" + } + }, + "detailLevel": { + "target": "com.amazonaws.inspector2#ListCisScansDetailLevel", + "traits": { + "smithy.api#documentation": "

The detail applied to the CIS scan.

" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#ListCisScansSortBy", + "traits": { + "smithy.api#default": "SCAN_START_DATE", + "smithy.api#documentation": "

The CIS scans sort by order.

" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#CisSortOrder", + "traits": { + "smithy.api#documentation": "

The CIS scans sort order.

" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token from a previous request that's used to retrieve the next page of results.

" + } + }, + "maxResults": { + "target": "com.amazonaws.inspector2#ListCisScansMaxResults", + "traits": { + "smithy.api#default": 100, + "smithy.api#documentation": "

The maximum number of results to be returned.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#ListCisScansResponse": { + "type": "structure", + "members": { + "scans": { + "target": "com.amazonaws.inspector2#CisScanList", + "traits": { + "smithy.api#documentation": "

The CIS scans.

" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination token from a previous request that's used to retrieve the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.inspector2#ListCisScansSortBy": { + "type": "enum", + "members": { + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATUS" + } + }, + "SCHEDULED_BY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCHEDULED_BY" + } + }, + "SCAN_START_DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCAN_START_DATE" + } + }, + "FAILED_CHECKS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_CHECKS" + } + } + } + }, + "com.amazonaws.inspector2#ListCoverage": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#ListCoverageRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#ListCoverageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists coverage details for you environment.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/coverage/list" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "coveredResources" + } + } + }, + "com.amazonaws.inspector2#ListCoverageMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.inspector2#ListCoverageRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.inspector2#ListCoverageMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

" + } + }, + "filterCriteria": { + "target": "com.amazonaws.inspector2#CoverageFilterCriteria", + "traits": { + "smithy.api#documentation": "

An object that contains details on the filters to apply to the coverage data for your\n environment.

" + } + } + } + }, + "com.amazonaws.inspector2#ListCoverageResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" + } + }, + "coveredResources": { + "target": "com.amazonaws.inspector2#CoveredResources", + "traits": { + "smithy.api#documentation": "

An object that contains details on the covered resources in your environment.

" + } + } + } + }, + "com.amazonaws.inspector2#ListCoverageStatistics": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#ListCoverageStatisticsRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#ListCoverageStatisticsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists Amazon Inspector coverage statistics for your environment.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/coverage/statistics/list" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "countsByGroup" + } + } + }, + "com.amazonaws.inspector2#ListCoverageStatisticsRequest": { + "type": "structure", + "members": { + "filterCriteria": { + "target": "com.amazonaws.inspector2#CoverageFilterCriteria", + "traits": { + "smithy.api#documentation": "

An object that contains details on the filters to apply to the coverage data for your\n environment.

" + } + }, + "groupBy": { + "target": "com.amazonaws.inspector2#GroupKey", + "traits": { + "smithy.api#documentation": "

The value to group the results by.

" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" + } + } + } + }, + "com.amazonaws.inspector2#ListCoverageStatisticsResponse": { + "type": "structure", + "members": { + "countsByGroup": { + "target": "com.amazonaws.inspector2#CountsList", + "traits": { + "smithy.api#documentation": "

An array with the number for each group.

" + } + }, + "totalCounts": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The total number for all groups.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" + } + } + } + }, + "com.amazonaws.inspector2#ListDelegatedAdminAccounts": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#ListDelegatedAdminAccountsRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#ListDelegatedAdminAccountsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists information about the Amazon Inspector delegated administrator of your\n organization.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/delegatedadminaccounts/list" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "delegatedAdminAccounts" + } + } + }, + "com.amazonaws.inspector2#ListDelegatedAdminAccountsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.inspector2#ListDelegatedAdminMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

" + } + } + } + }, + "com.amazonaws.inspector2#ListDelegatedAdminAccountsResponse": { + "type": "structure", + "members": { + "delegatedAdminAccounts": { + "target": "com.amazonaws.inspector2#DelegatedAdminAccountList", + "traits": { + "smithy.api#documentation": "

Details of the Amazon Inspector delegated administrator of your organization.

" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" + } + } + } + }, + "com.amazonaws.inspector2#ListDelegatedAdminMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.inspector2#ListFilterMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.inspector2#ListFilters": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#ListFiltersRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#ListFiltersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the filters associated with your account.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/filters/list" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "filters" + } + } + }, + "com.amazonaws.inspector2#ListFiltersRequest": { + "type": "structure", + "members": { + "arns": { + "target": "com.amazonaws.inspector2#FilterArnList", + "traits": { + "smithy.api#documentation": "

The Amazon resource number (ARN) of the filter.

" + } + }, + "action": { + "target": "com.amazonaws.inspector2#FilterAction", + "traits": { + "smithy.api#documentation": "

The action the filter applies to matched findings.

" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

" + } + }, + "maxResults": { + "target": "com.amazonaws.inspector2#ListFilterMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" + } + } + } + }, + "com.amazonaws.inspector2#ListFiltersResponse": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.inspector2#FilterList", + "traits": { + "smithy.api#documentation": "

Contains details on the filters associated with your account.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" + } + } + } + }, + "com.amazonaws.inspector2#ListFindingAggregations": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#ListFindingAggregationsRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#ListFindingAggregationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists aggregated finding data for your environment based on specific criteria.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/findings/aggregation/list" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "responses" + } + } + }, + "com.amazonaws.inspector2#ListFindingAggregationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.inspector2#ListFindingAggregationsRequest": { + "type": "structure", + "members": { + "aggregationType": { + "target": "com.amazonaws.inspector2#AggregationType", + "traits": { + "smithy.api#documentation": "

The type of the aggregation request.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

" + } + }, + "maxResults": { + "target": "com.amazonaws.inspector2#ListFindingAggregationsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" + } + }, + "accountIds": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account IDs to retrieve finding aggregation data for.

" + } + }, + "aggregationRequest": { + "target": "com.amazonaws.inspector2#AggregationRequest", + "traits": { + "smithy.api#documentation": "

Details of the aggregation request that is used to filter your aggregation results.

" + } + } + } + }, + "com.amazonaws.inspector2#ListFindingAggregationsResponse": { + "type": "structure", + "members": { + "aggregationType": { + "target": "com.amazonaws.inspector2#AggregationType", + "traits": { + "smithy.api#documentation": "

The type of aggregation to perform.

", + "smithy.api#required": {} + } + }, + "responses": { + "target": "com.amazonaws.inspector2#AggregationResponseList", + "traits": { + "smithy.api#documentation": "

Objects that contain the results of an aggregation operation.

" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" + } + } + } + }, + "com.amazonaws.inspector2#ListFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#ListFindingsRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#ListFindingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists findings for your environment.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/findings/list" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "findings" + } + } + }, + "com.amazonaws.inspector2#ListFindingsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.inspector2#ListFindingsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.inspector2#ListFindingsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

" + } + }, + "filterCriteria": { + "target": "com.amazonaws.inspector2#FilterCriteria", + "traits": { + "smithy.api#documentation": "

Details on the filters to apply to your finding results.

" + } + }, + "sortCriteria": { + "target": "com.amazonaws.inspector2#SortCriteria", + "traits": { + "smithy.api#documentation": "

Details on the sort criteria to apply to your finding results.

" + } + } + } + }, + "com.amazonaws.inspector2#ListFindingsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" + } + }, + "findings": { + "target": "com.amazonaws.inspector2#FindingList", + "traits": { + "smithy.api#documentation": "

Contains details on the findings in your environment.

" + } + } + } + }, + "com.amazonaws.inspector2#ListMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#ListMembersRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#ListMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List members associated with the Amazon Inspector delegated administrator for your\n organization.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/members/list" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "members" + } + } + }, + "com.amazonaws.inspector2#ListMembersMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.inspector2#ListMembersRequest": { + "type": "structure", + "members": { + "onlyAssociated": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to list only currently associated members if True or to\n list all members within the organization if False.

" + } + }, + "maxResults": { + "target": "com.amazonaws.inspector2#ListMembersMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

" + } + } + } + }, + "com.amazonaws.inspector2#ListMembersResponse": { + "type": "structure", + "members": { + "members": { + "target": "com.amazonaws.inspector2#MemberList", + "traits": { + "smithy.api#documentation": "

An object that contains details for each member account.

" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination parameter to be used on the next list operation to retrieve more\n items.

" + } + } + } + }, + "com.amazonaws.inspector2#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all tags attached to a given resource.

", + "smithy.api#http": { + "uri": "/tags/{resourceArn}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.inspector2#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.inspector2#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon resource number (ARN) of the resource to list tags of.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.inspector2#TagMap", + "traits": { + "smithy.api#documentation": "

The tags associated with the resource.

" + } + } + } + }, + "com.amazonaws.inspector2#ListUsageTotals": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#ListUsageTotalsRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#ListUsageTotalsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the Amazon Inspector usage totals over the last 30 days.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/usage/list" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "totals" + } + } + }, + "com.amazonaws.inspector2#ListUsageTotalsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.inspector2#ListUsageTotalsNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.inspector2#ListUsageTotalsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.inspector2#ListUsageTotalsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#ListUsageTotalsNextToken", + "traits": { + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

" + } + }, + "accountIds": { + "target": "com.amazonaws.inspector2#UsageAccountIdList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account IDs to retrieve usage totals for.

" + } + } + } + }, + "com.amazonaws.inspector2#ListUsageTotalsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.inspector2#ListUsageTotalsNextToken", + "traits": { + "smithy.api#documentation": "

The pagination parameter to be used on the next list operation to retrieve more items.

" + } + }, + "totals": { + "target": "com.amazonaws.inspector2#UsageTotalList", + "traits": { + "smithy.api#documentation": "

An object with details on the total usage for the requested account.

" + } + } + } + }, + "com.amazonaws.inspector2#MapComparison": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EQUALS", + "name": "EQUALS" + } + ] + } + }, + "com.amazonaws.inspector2#MapFilter": { + "type": "structure", + "members": { + "comparison": { + "target": "com.amazonaws.inspector2#MapComparison", + "traits": { + "smithy.api#documentation": "

The operator to use when comparing values in the filter.

", + "smithy.api#required": {} + } + }, + "key": { + "target": "com.amazonaws.inspector2#MapKey", + "traits": { + "smithy.api#documentation": "

The tag key used in the filter.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.inspector2#MapValue", + "traits": { + "smithy.api#documentation": "

The tag value used in the filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that describes details of a map filter.

" + } + }, + "com.amazonaws.inspector2#MapFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#MapFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#MapKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.inspector2#MapValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 256 + } + } + }, + "com.amazonaws.inspector2#Member": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the member account.

" + } + }, + "relationshipStatus": { + "target": "com.amazonaws.inspector2#RelationshipStatus", + "traits": { + "smithy.api#documentation": "

The status of the member account.

" + } + }, + "delegatedAdminAccountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the Amazon Inspector delegated administrator for this member account.

" + } + }, + "updatedAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "

A timestamp showing when the status of this member was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details on a member account in your organization.

" + } + }, + "com.amazonaws.inspector2#MemberAccountEc2DeepInspectionStatus": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the Amazon Web Services account of the organization member.

", + "smithy.api#required": {} + } + }, + "activateDeepInspection": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether Amazon Inspector deep inspection is active in the account. If TRUE Amazon Inspector deep inspection is active, if FALSE it is not active.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains details about the status of Amazon Inspector deep inspection for a member account in your organization.

" + } + }, + "com.amazonaws.inspector2#MemberAccountEc2DeepInspectionStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#MemberAccountEc2DeepInspectionStatus" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.inspector2#MemberAccountEc2DeepInspectionStatusState": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the Amazon Web Services account of the organization member

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.inspector2#Ec2DeepInspectionStatus", + "traits": { + "smithy.api#documentation": "

The state of Amazon Inspector deep inspection in the member account.

" + } + }, + "errorMessage": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The error message explaining why the account failed to activate Amazon Inspector deep inspection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains details about the state of Amazon Inspector deep inspection for a member account.

" + } + }, + "com.amazonaws.inspector2#MemberAccountEc2DeepInspectionStatusStateList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#MemberAccountEc2DeepInspectionStatusState" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.inspector2#MemberList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Member" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.inspector2#MeteringAccountId": { + "type": "string", + "traits": { + "smithy.api#pattern": "[0-9]{12}" + } + }, + "com.amazonaws.inspector2#MeteringAccountIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#MeteringAccountId" + } + }, + "com.amazonaws.inspector2#MonthlyCostEstimate": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.inspector2#MonthlySchedule": { + "type": "structure", + "members": { + "startTime": { + "target": "com.amazonaws.inspector2#Time", + "traits": { + "smithy.api#documentation": "

The monthly schedule's start time.

", + "smithy.api#required": {} + } + }, + "day": { + "target": "com.amazonaws.inspector2#Day", + "traits": { + "smithy.api#documentation": "

The monthly schedule's day.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A monthly schedule.

" + } + }, + "com.amazonaws.inspector2#NetworkPath": { + "type": "structure", + "members": { + "steps": { + "target": "com.amazonaws.inspector2#StepList", + "traits": { + "smithy.api#documentation": "

The details on the steps in the network path.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information on the network path associated with a finding.

" + } + }, + "com.amazonaws.inspector2#NetworkProtocol": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TCP", + "name": "TCP" + }, + { + "value": "UDP", + "name": "UDP" + } + ] + } + }, + "com.amazonaws.inspector2#NetworkReachabilityDetails": { + "type": "structure", + "members": { + "openPortRange": { + "target": "com.amazonaws.inspector2#PortRange", + "traits": { + "smithy.api#documentation": "

An object that contains details about the open port range associated with a finding.

", + "smithy.api#required": {} + } + }, + "protocol": { + "target": "com.amazonaws.inspector2#NetworkProtocol", + "traits": { + "smithy.api#documentation": "

The protocol associated with a finding.

", + "smithy.api#required": {} + } + }, + "networkPath": { + "target": "com.amazonaws.inspector2#NetworkPath", + "traits": { + "smithy.api#documentation": "

An object that contains details about a network path associated with a finding.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of a network reachability finding.

" + } + }, + "com.amazonaws.inspector2#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1000000 + } + } + }, + "com.amazonaws.inspector2#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.inspector2#NonEmptyStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#NonEmptyString" + } + }, + "com.amazonaws.inspector2#NumberFilter": { + "type": "structure", + "members": { + "upperInclusive": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The highest number to be included in the filter.

" + } + }, + "lowerInclusive": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The lowest number to be included in the filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that describes the details of a number filter.

" + } + }, + "com.amazonaws.inspector2#NumberFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#NumberFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#OneAccountIdFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisStringFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.inspector2#OneTimeSchedule": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

A one time schedule.

" + } + }, + "com.amazonaws.inspector2#Operation": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLE_SCANNING", + "name": "ENABLE_SCANNING" + }, + { + "value": "DISABLE_SCANNING", + "name": "DISABLE_SCANNING" + }, + { + "value": "ENABLE_REPOSITORY", + "name": "ENABLE_REPOSITORY" + }, + { + "value": "DISABLE_REPOSITORY", + "name": "DISABLE_REPOSITORY" + } + ] + } + }, + "com.amazonaws.inspector2#OwnerId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 34 + }, + "smithy.api#pattern": "(^\\d{12}$)|(^o-[a-z0-9]{10,32}$)" + } + }, + "com.amazonaws.inspector2#PackageAggregation": { + "type": "structure", + "members": { + "packageNames": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The names of packages to aggregate findings on.

" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#SortOrder", + "traits": { + "smithy.api#documentation": "

The order to sort results by.

" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#PackageSortBy", + "traits": { + "smithy.api#documentation": "

The value to sort results by.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details that define an aggregation based on operating system package type.

" + } + }, + "com.amazonaws.inspector2#PackageAggregationResponse": { + "type": "structure", + "members": { + "packageName": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the operating system package.

", + "smithy.api#required": {} + } + }, + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account associated with the findings.

" + } + }, + "severityCounts": { + "target": "com.amazonaws.inspector2#SeverityCounts", + "traits": { + "smithy.api#documentation": "

An object that contains the count of matched findings per severity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A response that contains the results of a finding aggregation by image layer.

" + } + }, + "com.amazonaws.inspector2#PackageArchitecture": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.inspector2#PackageEpoch": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.inspector2#PackageFilter": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.inspector2#StringFilter", + "traits": { + "smithy.api#documentation": "

An object that contains details on the name of the package to filter on.

" + } + }, + "version": { + "target": "com.amazonaws.inspector2#StringFilter", + "traits": { + "smithy.api#documentation": "

The package version to filter on.

" + } + }, + "epoch": { + "target": "com.amazonaws.inspector2#NumberFilter", + "traits": { + "smithy.api#documentation": "

An object that contains details on the package epoch to filter on.

" + } + }, + "release": { + "target": "com.amazonaws.inspector2#StringFilter", + "traits": { + "smithy.api#documentation": "

An object that contains details on the package release to filter on.

" + } + }, + "architecture": { + "target": "com.amazonaws.inspector2#StringFilter", + "traits": { + "smithy.api#documentation": "

An object that contains details on the package architecture type to filter on.

" + } + }, + "sourceLayerHash": { + "target": "com.amazonaws.inspector2#StringFilter", + "traits": { + "smithy.api#documentation": "

An object that contains details on the source layer hash to filter on.

" + } + }, + "sourceLambdaLayerArn": { + "target": "com.amazonaws.inspector2#StringFilter" + } + }, + "traits": { + "smithy.api#documentation": "

Contains information on the details of a package filter.

" + } + }, + "com.amazonaws.inspector2#PackageFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#PackageFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#PackageManager": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BUNDLER", + "name": "BUNDLER" + }, + { + "value": "CARGO", + "name": "CARGO" + }, + { + "value": "COMPOSER", + "name": "COMPOSER" + }, + { + "value": "NPM", + "name": "NPM" + }, + { + "value": "NUGET", + "name": "NUGET" + }, + { + "value": "PIPENV", + "name": "PIPENV" + }, + { + "value": "POETRY", + "name": "POETRY" + }, + { + "value": "YARN", + "name": "YARN" + }, + { + "value": "GOBINARY", + "name": "GOBINARY" + }, + { + "value": "GOMOD", + "name": "GOMOD" + }, + { + "value": "JAR", + "name": "JAR" + }, + { + "value": "OS", + "name": "OS" + }, + { + "value": "PIP", + "name": "PIP" + }, + { + "value": "PYTHONPKG", + "name": "PYTHONPKG" + }, + { + "value": "NODEPKG", + "name": "NODEPKG" + }, + { + "value": "POM", + "name": "POM" + }, + { + "value": "GEMSPEC", + "name": "GEMSPEC" + } + ] + } + }, + "com.amazonaws.inspector2#PackageName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#PackageRelease": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#PackageSortBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CRITICAL", + "name": "CRITICAL" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "ALL", + "name": "ALL" + } + ] + } + }, + "com.amazonaws.inspector2#PackageType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "IMAGE", + "name": "IMAGE" + }, + { + "value": "ZIP", + "name": "ZIP" + } + ] + } + }, + "com.amazonaws.inspector2#PackageVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#PackageVulnerabilityDetails": { + "type": "structure", + "members": { + "vulnerabilityId": { + "target": "com.amazonaws.inspector2#VulnerabilityId", + "traits": { + "smithy.api#documentation": "

The ID given to this vulnerability.

", + "smithy.api#required": {} + } + }, + "vulnerablePackages": { + "target": "com.amazonaws.inspector2#VulnerablePackageList", + "traits": { + "smithy.api#documentation": "

The packages impacted by this vulnerability.

" + } + }, + "source": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The source of the vulnerability information.

", + "smithy.api#required": {} + } + }, + "cvss": { + "target": "com.amazonaws.inspector2#CvssScoreList", + "traits": { + "smithy.api#documentation": "

An object that contains details about the CVSS score of a finding.

" + } + }, + "relatedVulnerabilities": { + "target": "com.amazonaws.inspector2#VulnerabilityIdList", + "traits": { + "smithy.api#documentation": "

One or more vulnerabilities related to the one identified in this finding.

" + } + }, + "sourceUrl": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A URL to the source of the vulnerability information.

" + } + }, + "vendorSeverity": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The severity the vendor has given to this vulnerability type.

" + } + }, + "vendorCreatedAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time that this vulnerability was first added to the vendor's database.

" + } + }, + "vendorUpdatedAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "

The date and time the vendor last updated this vulnerability in their database.

" + } + }, + "referenceUrls": { + "target": "com.amazonaws.inspector2#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

One or more URLs that contain details about this vulnerability type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a package vulnerability finding.

" + } + }, + "com.amazonaws.inspector2#Path": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^(?:/(?:\\.[-\\w]+|[-\\w]+(?:\\.[-\\w]+)?))+/?$" + } + }, + "com.amazonaws.inspector2#PathList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Path" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.inspector2#Permission": { + "type": "structure", + "members": { + "service": { + "target": "com.amazonaws.inspector2#Service", + "traits": { + "smithy.api#documentation": "

The services that the permissions allow an account to perform the given operations for.

", + "smithy.api#required": {} + } + }, + "operation": { + "target": "com.amazonaws.inspector2#Operation", + "traits": { + "smithy.api#documentation": "

The operations that can be performed with the given permissions.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information on the permissions an account has within Amazon Inspector.

" + } + }, + "com.amazonaws.inspector2#Permissions": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Permission" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#Platform": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#PlatformFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisStringFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#PlatformVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 8 + } + } + }, + "com.amazonaws.inspector2#Port": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 65535 + } + } + }, + "com.amazonaws.inspector2#PortRange": { + "type": "structure", + "members": { + "begin": { + "target": "com.amazonaws.inspector2#Port", + "traits": { + "smithy.api#documentation": "

The beginning port in a port range.

", + "smithy.api#required": {} + } + }, + "end": { + "target": "com.amazonaws.inspector2#Port", + "traits": { + "smithy.api#documentation": "

The ending port in a port range.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the port range associated with a finding.

" + } + }, + "com.amazonaws.inspector2#PortRangeFilter": { + "type": "structure", + "members": { + "beginInclusive": { + "target": "com.amazonaws.inspector2#Port", + "traits": { + "smithy.api#documentation": "

The port number the port range begins at.

" + } + }, + "endInclusive": { + "target": "com.amazonaws.inspector2#Port", + "traits": { + "smithy.api#documentation": "

The port number the port range ends at.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that describes the details of a port range filter.

" + } + }, + "com.amazonaws.inspector2#PortRangeFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#PortRangeFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#Product": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 32 + } + } + }, + "com.amazonaws.inspector2#Reason": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#Recommendation": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The recommended course of action to remediate the finding.

" + } + }, + "Url": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The URL address to the CVE remediation recommendations.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the recommended course of action to remediate the finding.

" + } + }, + "com.amazonaws.inspector2#ReferenceUrls": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#NonEmptyString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#RelatedVulnerabilities": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#RelatedVulnerability" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.inspector2#RelatedVulnerability": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.inspector2#RelationshipStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "INVITED", + "name": "INVITED" + }, + { + "value": "DISABLED", + "name": "DISABLED" + }, + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "REMOVED", + "name": "REMOVED" + }, + { + "value": "RESIGNED", + "name": "RESIGNED" + }, + { + "value": "DELETED", + "name": "DELETED" + }, + { + "value": "EMAIL_VERIFICATION_IN_PROGRESS", + "name": "EMAIL_VERIFICATION_IN_PROGRESS" + }, + { + "value": "EMAIL_VERIFICATION_FAILED", + "name": "EMAIL_VERIFICATION_FAILED" + }, + { + "value": "REGION_DISABLED", + "name": "REGION_DISABLED" + }, + { + "value": "ACCOUNT_SUSPENDED", + "name": "ACCOUNT_SUSPENDED" + }, + { + "value": "CANNOT_CREATE_DETECTOR_IN_ORG_MASTER", + "name": "CANNOT_CREATE_DETECTOR_IN_ORG_MASTER" + } + ] + } + }, + "com.amazonaws.inspector2#Remediation": { + "type": "structure", + "members": { + "recommendation": { + "target": "com.amazonaws.inspector2#Recommendation", + "traits": { + "smithy.api#documentation": "

An object that contains information about the recommended course of action to remediate the finding.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information on how to remediate a finding.

" + } + }, + "com.amazonaws.inspector2#ReportFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CSV", + "name": "CSV" + }, + { + "value": "JSON", + "name": "JSON" + } + ] + } + }, + "com.amazonaws.inspector2#ReportId": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\b[a-f0-9]{8}\\b-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-\\b[a-f0-9]{12}\\b" + } + }, + "com.amazonaws.inspector2#ReportTargetAccounts": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#AccountId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.inspector2#ReportingErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INTERNAL_ERROR", + "name": "INTERNAL_ERROR" + }, + { + "value": "INVALID_PERMISSIONS", + "name": "INVALID_PERMISSIONS" + }, + { + "value": "NO_FINDINGS_FOUND", + "name": "NO_FINDINGS_FOUND" + }, + { + "value": "BUCKET_NOT_FOUND", + "name": "BUCKET_NOT_FOUND" + }, + { + "value": "INCOMPATIBLE_BUCKET_REGION", + "name": "INCOMPATIBLE_BUCKET_REGION" + }, + { + "value": "MALFORMED_KMS_KEY", + "name": "MALFORMED_KMS_KEY" + } + ] + } + }, + "com.amazonaws.inspector2#RepositoryAggregation": { + "type": "structure", + "members": { + "repositories": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The names of repositories to aggregate findings on.

" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#SortOrder", + "traits": { + "smithy.api#documentation": "

The order to sort results by.

" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#RepositorySortBy", + "traits": { + "smithy.api#documentation": "

The value to sort results by.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details that define an aggregation based on repository.

" + } + }, + "com.amazonaws.inspector2#RepositoryAggregationResponse": { + "type": "structure", + "members": { + "repository": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the repository associated with the findings.

", + "smithy.api#required": {} + } + }, + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account associated with the findings.

" + } + }, + "severityCounts": { + "target": "com.amazonaws.inspector2#SeverityCounts", + "traits": { + "smithy.api#documentation": "

An object that represent the count of matched findings per severity.

" + } + }, + "affectedImages": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The number of container images impacted by the findings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A response that contains details on the results of a finding aggregation by repository.

" + } + }, + "com.amazonaws.inspector2#RepositorySortBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CRITICAL", + "name": "CRITICAL" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "ALL", + "name": "ALL" + }, + { + "value": "AFFECTED_IMAGES", + "name": "AFFECTED_IMAGES" + } + ] + } + }, + "com.amazonaws.inspector2#ResetEncryptionKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#ResetEncryptionKeyRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#ResetEncryptionKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Resets an encryption key. After the key is reset your resources will be encrypted by an Amazon Web Services owned key.

", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/encryptionkey/reset" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.inspector2#ResetEncryptionKeyRequest": { + "type": "structure", + "members": { + "scanType": { + "target": "com.amazonaws.inspector2#ScanType", + "traits": { + "smithy.api#documentation": "

The scan type the key encrypts.

", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "com.amazonaws.inspector2#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type the key encrypts.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#ResetEncryptionKeyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.inspector2#Resource": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.inspector2#ResourceType", + "traits": { + "smithy.api#documentation": "

The type of resource.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the resource.

", + "smithy.api#required": {} + } + }, + "partition": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The partition of the resource.

" + } + }, + "region": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region the impacted resource is located in.

" + } + }, + "tags": { + "target": "com.amazonaws.inspector2#TagMap", + "traits": { + "smithy.api#documentation": "

The tags attached to the resource.

" + } + }, + "details": { + "target": "com.amazonaws.inspector2#ResourceDetails", + "traits": { + "smithy.api#documentation": "

An object that contains details about the resource involved in a finding.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the resource involved in a finding.

" + } + }, + "com.amazonaws.inspector2#ResourceDetails": { + "type": "structure", + "members": { + "awsEc2Instance": { + "target": "com.amazonaws.inspector2#AwsEc2InstanceDetails", + "traits": { + "smithy.api#documentation": "

An object that contains details about the Amazon EC2 instance involved in the finding.

" + } + }, + "awsEcrContainerImage": { + "target": "com.amazonaws.inspector2#AwsEcrContainerImageDetails", + "traits": { + "smithy.api#documentation": "

An object that contains details about the Amazon ECR container image involved in the finding.

" + } + }, + "awsLambdaFunction": { + "target": "com.amazonaws.inspector2#AwsLambdaFunctionDetails", + "traits": { + "smithy.api#documentation": "

A summary of the information about an Amazon Web Services Lambda function affected by a finding.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about the resource involved in the finding.

" + } + }, + "com.amazonaws.inspector2#ResourceFilterCriteria": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#ResourceStringFilterList", + "traits": { + "smithy.api#documentation": "

The account IDs used as resource filter criteria.

" + } + }, + "resourceId": { + "target": "com.amazonaws.inspector2#ResourceStringFilterList", + "traits": { + "smithy.api#documentation": "

The resource IDs used as resource filter criteria.

" + } + }, + "resourceType": { + "target": "com.amazonaws.inspector2#ResourceStringFilterList", + "traits": { + "smithy.api#documentation": "

The resource types used as resource filter criteria.

" + } + }, + "ecrRepositoryName": { + "target": "com.amazonaws.inspector2#ResourceStringFilterList", + "traits": { + "smithy.api#documentation": "

The ECR repository names used as resource filter criteria.

" + } + }, + "lambdaFunctionName": { + "target": "com.amazonaws.inspector2#ResourceStringFilterList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Lambda function name used as resource filter criteria.

" + } + }, + "ecrImageTags": { + "target": "com.amazonaws.inspector2#ResourceStringFilterList", + "traits": { + "smithy.api#documentation": "

The ECR image tags used as resource filter criteria.

" + } + }, + "ec2InstanceTags": { + "target": "com.amazonaws.inspector2#ResourceMapFilterList", + "traits": { + "smithy.api#documentation": "

The EC2 instance tags used as resource filter criteria.

" + } + }, + "lambdaFunctionTags": { + "target": "com.amazonaws.inspector2#ResourceMapFilterList", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Lambda function tags used as resource filter criteria.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The resource filter criteria for a Software bill of materials (SBOM) report.

" + } + }, + "com.amazonaws.inspector2#ResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 341 + }, + "smithy.api#pattern": "(^arn:.*:ecr:.*:\\d{12}:repository\\/(?:[a-z0-9]+(?:[._-][a-z0-9]+)*\\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*(\\/sha256:[a-z0-9]{64})?$)|(^i-([a-z0-9]{8}|[a-z0-9]{17}|\\\\*)$|(^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$))" + } + }, + "com.amazonaws.inspector2#ResourceIdFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisStringFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#ResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Resource" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#ResourceMapComparison": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EQUALS", + "name": "EQUALS" + } + ] + } + }, + "com.amazonaws.inspector2#ResourceMapFilter": { + "type": "structure", + "members": { + "comparison": { + "target": "com.amazonaws.inspector2#ResourceMapComparison", + "traits": { + "smithy.api#documentation": "

The filter's comparison.

", + "smithy.api#required": {} + } + }, + "key": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The filter's key.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The filter's value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A resource map filter for a software bill of material report.

" + } + }, + "com.amazonaws.inspector2#ResourceMapFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#ResourceMapFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.inspector2#ResourceScanMetadata": { + "type": "structure", + "members": { + "ecrRepository": { + "target": "com.amazonaws.inspector2#EcrRepositoryMetadata", + "traits": { + "smithy.api#documentation": "

An object that contains details about the repository an Amazon ECR image resides in.

" + } + }, + "ecrImage": { + "target": "com.amazonaws.inspector2#EcrContainerImageMetadata", + "traits": { + "smithy.api#documentation": "

An object that contains details about the container metadata for an Amazon ECR image.

" + } + }, + "ec2": { + "target": "com.amazonaws.inspector2#Ec2Metadata", + "traits": { + "smithy.api#documentation": "

An object that contains metadata details for an Amazon EC2 instance.

" + } + }, + "lambdaFunction": { + "target": "com.amazonaws.inspector2#LambdaFunctionMetadata", + "traits": { + "smithy.api#documentation": "

An object that contains metadata details for an Amazon Web Services Lambda function.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains details about the metadata for an Amazon ECR resource.

" + } + }, + "com.amazonaws.inspector2#ResourceScanType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EC2", + "name": "EC2" + }, + { + "value": "ECR", + "name": "ECR" + }, + { + "value": "LAMBDA", + "name": "LAMBDA" + }, + { + "value": "LAMBDA_CODE", + "name": "LAMBDA_CODE" + } + ] + } + }, + "com.amazonaws.inspector2#ResourceState": { + "type": "structure", + "members": { + "ec2": { + "target": "com.amazonaws.inspector2#State", + "traits": { + "smithy.api#documentation": "

An object detailing the state of Amazon Inspector scanning for Amazon EC2 resources.

", + "smithy.api#required": {} + } + }, + "ecr": { + "target": "com.amazonaws.inspector2#State", + "traits": { + "smithy.api#documentation": "

An object detailing the state of Amazon Inspector scanning for Amazon ECR resources.

", + "smithy.api#required": {} + } + }, + "lambda": { + "target": "com.amazonaws.inspector2#State" + }, + "lambdaCode": { + "target": "com.amazonaws.inspector2#State" + } + }, + "traits": { + "smithy.api#documentation": "

Details the state of Amazon Inspector for each resource type Amazon Inspector scans.

" + } + }, + "com.amazonaws.inspector2#ResourceStatus": { + "type": "structure", + "members": { + "ec2": { + "target": "com.amazonaws.inspector2#Status", + "traits": { + "smithy.api#documentation": "

The status of Amazon Inspector scanning for Amazon EC2 resources.

", + "smithy.api#required": {} + } + }, + "ecr": { + "target": "com.amazonaws.inspector2#Status", + "traits": { + "smithy.api#documentation": "

The status of Amazon Inspector scanning for Amazon ECR resources.

", + "smithy.api#required": {} + } + }, + "lambda": { + "target": "com.amazonaws.inspector2#Status", + "traits": { + "smithy.api#documentation": "

The status of Amazon Inspector scanning for Amazon Web Services Lambda function.

" + } + }, + "lambdaCode": { + "target": "com.amazonaws.inspector2#Status", + "traits": { + "smithy.api#documentation": "

The status of Amazon Inspector scanning for custom application code for Amazon Web Services Lambda functions. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details the status of Amazon Inspector for each resource type Amazon Inspector scans.

" + } + }, + "com.amazonaws.inspector2#ResourceStringComparison": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EQUALS", + "name": "EQUALS" + }, + { + "value": "NOT_EQUALS", + "name": "NOT_EQUALS" + } + ] + } + }, + "com.amazonaws.inspector2#ResourceStringFilter": { + "type": "structure", + "members": { + "comparison": { + "target": "com.amazonaws.inspector2#ResourceStringComparison", + "traits": { + "smithy.api#documentation": "

The filter's comparison.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.inspector2#ResourceStringInput", + "traits": { + "smithy.api#documentation": "

The filter's value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A resource string filter for a software bill of materials report.

" + } + }, + "com.amazonaws.inspector2#ResourceStringFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#ResourceStringFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#ResourceStringInput": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#ResourceTagFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#TagFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#ResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWS_EC2_INSTANCE", + "name": "AWS_EC2_INSTANCE" + }, + { + "value": "AWS_ECR_CONTAINER_IMAGE", + "name": "AWS_ECR_CONTAINER_IMAGE" + }, + { + "value": "AWS_ECR_REPOSITORY", + "name": "AWS_ECR_REPOSITORY" + }, + { + "value": "AWS_LAMBDA_FUNCTION", + "name": "AWS_LAMBDA_FUNCTION" + } + ] + } + }, + "com.amazonaws.inspector2#RiskScore": { + "type": "integer" + }, + "com.amazonaws.inspector2#RuleId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.inspector2#Runtime": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NODEJS", + "name": "NODEJS" + }, + { + "value": "NODEJS_12_X", + "name": "NODEJS_12_X" + }, + { + "value": "NODEJS_14_X", + "name": "NODEJS_14_X" + }, + { + "value": "NODEJS_16_X", + "name": "NODEJS_16_X" + }, + { + "value": "JAVA_8", + "name": "JAVA_8" + }, + { + "value": "JAVA_8_AL2", + "name": "JAVA_8_AL2" + }, + { + "value": "JAVA_11", + "name": "JAVA_11" + }, + { + "value": "PYTHON_3_7", + "name": "PYTHON_3_7" + }, + { + "value": "PYTHON_3_8", + "name": "PYTHON_3_8" + }, + { + "value": "PYTHON_3_9", + "name": "PYTHON_3_9" + }, + { + "value": "UNSUPPORTED", + "name": "UNSUPPORTED" + }, + { + "value": "NODEJS_18_X", + "name": "NODEJS_18_X" + }, + { + "value": "GO_1_X", + "name": "GO_1_X" + }, + { + "value": "JAVA_17", + "name": "JAVA_17" + }, + { + "value": "PYTHON_3_10", + "name": "PYTHON_3_10" + } + ] + } + }, + "com.amazonaws.inspector2#SbomReportFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CYCLONEDX_1_4", + "name": "CYCLONEDX_1_4" + }, + { + "value": "SPDX_2_3", + "name": "SPDX_2_3" + } + ] + } + }, + "com.amazonaws.inspector2#ScanMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EC2_SSM_AGENT_BASED", + "name": "EC2_SSM_AGENT_BASED" + }, + { + "value": "EC2_AGENTLESS", + "name": "EC2_AGENTLESS" + } + ] + } + }, + "com.amazonaws.inspector2#ScanStatus": { + "type": "structure", + "members": { + "statusCode": { + "target": "com.amazonaws.inspector2#ScanStatusCode", + "traits": { + "smithy.api#documentation": "

The status code of the scan.

", + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.inspector2#ScanStatusReason", + "traits": { + "smithy.api#documentation": "

The scan status. Possible return values and descriptions are:

\n

\n PENDING_INITIAL_SCAN - This resource has been identified for scanning, results will be available soon.

\n

\n ACCESS_DENIED - Resource access policy restricting Amazon Inspector access. Please update the IAM policy.

\n

\n INTERNAL_ERROR - Amazon Inspector has encountered an internal error for this resource. Amazon Inspector service will automatically resolve the issue and resume the scanning. No action required from the user.

\n

\n UNMANAGED_EC2_INSTANCE - The EC2 instance is not managed by SSM, please use the following SSM automation to remediate the issue: https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-awssupport-troubleshoot-managed-instance.html. Once the instance becomes managed by SSM, Inspector will automatically begin scanning this instance.

\n

\n UNSUPPORTED_OS - Amazon Inspector does not support this OS, architecture, or image manifest type at this time. To see a complete list of supported operating systems see: https://docs.aws.amazon.com/inspector/latest/user/supported.html.

\n

\n SCAN_ELIGIBILITY_EXPIRED - The configured scan duration has lapsed for this image.

\n

\n RESOURCE_TERMINATED - This resource has been terminated. The findings and coverage associated with this resource are in the process of being cleaned up.

\n

\n SUCCESSFUL - The scan was successful.

\n

\n NO_RESOURCES_FOUND - Reserved for future use.

\n

\n IMAGE_SIZE_EXCEEDED - Reserved for future use.

\n

\n SCAN_FREQUENCY_MANUAL - This image will not be covered by Amazon Inspector due to the repository scan frequency configuration.

\n

\n SCAN_FREQUENCY_SCAN_ON_PUSH - This image will be scanned one time and will not new findings because of the scan frequency configuration.

\n

\n EC2_INSTANCE_STOPPED - This EC2 instance is in a stopped state, therefore, Amazon Inspector will pause scanning. The existing findings will continue to exist until the instance is terminated. Once the instance is re-started, Inspector will automatically start scanning the instance again. Please note that you will not be charged for this instance while it’s in a stopped state.

\n

\n PENDING_DISABLE - This resource is pending cleanup during disablement. The customer will not be billed while a resource is in the pending disable status.

\n

\n NO INVENTORY - Amazon Inspector couldn’t find software application inventory to scan for vulnerabilities. This might be caused due to required Amazon Inspector associations being deleted or failing to run on your resource. Please verify the status of InspectorInventoryCollection-do-not-delete association in the SSM console for the resource. Additionally, you can verify the instance’s inventory in the SSM Fleet Manager console.

\n

\n STALE_INVENTORY - Amazon Inspector wasn’t able to collect an updated software application inventory in the last 7 days. Please confirm the required Amazon Inspector associations still exist and you can still see an updated inventory in the SSM console.

\n

\n EXCLUDED_BY_TAG - This resource was not scanned because it has been excluded by a tag.

\n

\n UNSUPPORTED_RUNTIME - The function was not scanned because it has an unsupported runtime. To see a complete list of supported runtimes see: https://docs.aws.amazon.com/inspector/latest/user/supported.html.

\n

\n UNSUPPORTED_MEDIA_TYPE - The ECR image has an unsupported media type.

\n

\n UNSUPPORTED_CONFIG_FILE - Reserved for future use.

\n

\n DEEP_INSPECTION_PACKAGE_COLLECTION_LIMIT_EXCEEDED - The instance has exceeded the 5000 package limit for Amazon Inspector Deep inspection. To resume Deep inspection for this instance you can try to adjust the custom paths associated with the account.

\n

\n DEEP_INSPECTION_DAILY_SSM_INVENTORY_LIMIT_EXCEEDED - The SSM agent couldn't send inventory to Amazon Inspector because the SSM quota for Inventory data collected per instance per day has already been reached for this instance.

\n

\n DEEP_INSPECTION_COLLECTION_TIME_LIMIT_EXCEEDED - Amazon Inspector failed to extract the package inventory because the package collection time exceeding the maximum threshold of 15 minutes.

\n

\n DEEP_INSPECTION_NO_INVENTORY The Amazon Inspector plugin hasn't yet been able to collect an inventory of packages for this instance. This is usually the result of a pending scan, however, if this status persists after 6 hours, use SSM to ensure that the required Amazon Inspector associations exist and are running for the instance.

\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the scan.

" + } + }, + "com.amazonaws.inspector2#ScanStatusCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "INACTIVE", + "name": "INACTIVE" + } + ] + } + }, + "com.amazonaws.inspector2#ScanStatusReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING_INITIAL_SCAN", + "name": "PENDING_INITIAL_SCAN" + }, + { + "value": "ACCESS_DENIED", + "name": "ACCESS_DENIED" + }, + { + "value": "INTERNAL_ERROR", + "name": "INTERNAL_ERROR" + }, + { + "value": "UNMANAGED_EC2_INSTANCE", + "name": "UNMANAGED_EC2_INSTANCE" + }, + { + "value": "UNSUPPORTED_OS", + "name": "UNSUPPORTED_OS" + }, + { + "value": "SCAN_ELIGIBILITY_EXPIRED", + "name": "SCAN_ELIGIBILITY_EXPIRED" + }, + { + "value": "RESOURCE_TERMINATED", + "name": "RESOURCE_TERMINATED" + }, + { + "value": "SUCCESSFUL", + "name": "SUCCESSFUL" + }, + { + "value": "NO_RESOURCES_FOUND", + "name": "NO_RESOURCES_FOUND" + }, + { + "value": "IMAGE_SIZE_EXCEEDED", + "name": "IMAGE_SIZE_EXCEEDED" + }, + { + "value": "SCAN_FREQUENCY_MANUAL", + "name": "SCAN_FREQUENCY_MANUAL" + }, + { + "value": "SCAN_FREQUENCY_SCAN_ON_PUSH", + "name": "SCAN_FREQUENCY_SCAN_ON_PUSH" + }, + { + "value": "EC2_INSTANCE_STOPPED", + "name": "EC2_INSTANCE_STOPPED" + }, + { + "value": "PENDING_DISABLE", + "name": "PENDING_DISABLE" + }, + { + "value": "NO_INVENTORY", + "name": "NO_INVENTORY" + }, + { + "value": "STALE_INVENTORY", + "name": "STALE_INVENTORY" + }, + { + "value": "EXCLUDED_BY_TAG", + "name": "EXCLUDED_BY_TAG" + }, + { + "value": "UNSUPPORTED_RUNTIME", + "name": "UNSUPPORTED_RUNTIME" + }, + { + "value": "UNSUPPORTED_MEDIA_TYPE", + "name": "UNSUPPORTED_MEDIA_TYPE" + }, + { + "value": "UNSUPPORTED_CONFIG_FILE", + "name": "UNSUPPORTED_CONFIG_FILE" + }, + { + "value": "DEEP_INSPECTION_PACKAGE_COLLECTION_LIMIT_EXCEEDED", + "name": "DEEP_INSPECTION_PACKAGE_COLLECTION_LIMIT_EXCEEDED" + }, + { + "value": "DEEP_INSPECTION_DAILY_SSM_INVENTORY_LIMIT_EXCEEDED", + "name": "DEEP_INSPECTION_DAILY_SSM_INVENTORY_LIMIT_EXCEEDED" + }, + { + "value": "DEEP_INSPECTION_COLLECTION_TIME_LIMIT_EXCEEDED", + "name": "DEEP_INSPECTION_COLLECTION_TIME_LIMIT_EXCEEDED" + }, + { + "value": "DEEP_INSPECTION_NO_INVENTORY", + "name": "DEEP_INSPECTION_NO_INVENTORY" + }, + { + "value": "AGENTLESS_INSTANCE_STORAGE_LIMIT_EXCEEDED", + "name": "AGENTLESS_INSTANCE_STORAGE_LIMIT_EXCEEDED" + }, + { + "value": "AGENTLESS_INSTANCE_COLLECTION_TIME_LIMIT_EXCEEDED", + "name": "AGENTLESS_INSTANCE_COLLECTION_TIME_LIMIT_EXCEEDED" + } + ] + } + }, + "com.amazonaws.inspector2#ScanType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NETWORK", + "name": "NETWORK" + }, + { + "value": "PACKAGE", + "name": "PACKAGE" + }, + { + "value": "CODE", + "name": "CODE" + } + ] + } + }, + "com.amazonaws.inspector2#Schedule": { + "type": "union", + "members": { + "oneTime": { + "target": "com.amazonaws.inspector2#OneTimeSchedule", + "traits": { + "smithy.api#documentation": "

The schedule's one time.

" + } + }, + "daily": { + "target": "com.amazonaws.inspector2#DailySchedule", + "traits": { + "smithy.api#documentation": "

The schedule's daily.

" + } + }, + "weekly": { + "target": "com.amazonaws.inspector2#WeeklySchedule", + "traits": { + "smithy.api#documentation": "

The schedule's weekly.

" + } + }, + "monthly": { + "target": "com.amazonaws.inspector2#MonthlySchedule", + "traits": { + "smithy.api#documentation": "

The schedule's monthly.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A schedule.

" + } + }, + "com.amazonaws.inspector2#SearchVulnerabilities": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#SearchVulnerabilitiesRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#SearchVulnerabilitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists Amazon Inspector coverage details for a specific vulnerability.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/vulnerabilities/search" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "vulnerabilities" + } + } + }, + "com.amazonaws.inspector2#SearchVulnerabilitiesFilterCriteria": { + "type": "structure", + "members": { + "vulnerabilityIds": { + "target": "com.amazonaws.inspector2#VulnIdList", + "traits": { + "smithy.api#documentation": "

The IDs for specific vulnerabilities.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details on the criteria used to define the filter for a vulnerability search.\n

" + } + }, + "com.amazonaws.inspector2#SearchVulnerabilitiesRequest": { + "type": "structure", + "members": { + "filterCriteria": { + "target": "com.amazonaws.inspector2#SearchVulnerabilitiesFilterCriteria", + "traits": { + "smithy.api#documentation": "

The criteria used to filter the results of a vulnerability search.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#SearchVulnerabilitiesResponse": { + "type": "structure", + "members": { + "vulnerabilities": { + "target": "com.amazonaws.inspector2#Vulnerabilities", + "traits": { + "smithy.api#documentation": "

Details about the listed vulnerability.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.inspector2#NextToken", + "traits": { + "smithy.api#documentation": "

The pagination parameter to be used on the next list operation to retrieve more items.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.inspector2#SecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^sg-([a-z0-9]{8}|[a-z0-9]{17}|\\*)$" + } + }, + "com.amazonaws.inspector2#SecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#SecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "max": 5 + } + } + }, + "com.amazonaws.inspector2#SendCisSessionHealth": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#SendCisSessionHealthRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#SendCisSessionHealthResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#ConflictException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Sends a CIS session health. \n This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. \n The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.\n

", + "smithy.api#examples": [ + { + "title": "Sample SendCisSessionHealth Call", + "input": { + "scanJobId": "624b746d-e080-44ae-8c1d-48e653365a38", + "sessionToken": "624b746d-e080-44ae-8c1d-48e653365a31" + }, + "output": {} + } + ], + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/cissession/health/send" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.inspector2#SendCisSessionHealthRequest": { + "type": "structure", + "members": { + "scanJobId": { + "target": "com.amazonaws.inspector2#UUID", + "traits": { + "smithy.api#documentation": "

A unique identifier for the scan job.

", + "smithy.api#required": {} + } + }, + "sessionToken": { + "target": "com.amazonaws.inspector2#UUID", + "traits": { + "smithy.api#documentation": "

The unique token that identifies the CIS session.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#SendCisSessionHealthResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.inspector2#SendCisSessionTelemetry": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#SendCisSessionTelemetryRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#SendCisSessionTelemetryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#ConflictException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Sends a CIS session telemetry. \n This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. \n The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.\n

", + "smithy.api#examples": [ + { + "title": "Sample SendCisSessionTelemetry Call", + "input": { + "scanJobId": "624b746d-e080-44ae-8c1d-48e653365a38", + "sessionToken": "624b746d-e080-44ae-8c1d-48e653365a31", + "messages": [ + { + "ruleId": "1.12.1", + "status": "FAILED", + "cisRuleDetails": "dGVzdCBleGFtcGxlCg==" + }, + { + "ruleId": "1.2.1", + "status": "PASSED", + "cisRuleDetails": "dGVzdCBleGFtcGxlCg==dGVzdCBleGFtcGxlCg" + } + ] + }, + "output": {} + } + ], + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/cissession/telemetry/send" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.inspector2#SendCisSessionTelemetryRequest": { + "type": "structure", + "members": { + "scanJobId": { + "target": "com.amazonaws.inspector2#UUID", + "traits": { + "smithy.api#documentation": "

A unique identifier for the scan job.

", + "smithy.api#required": {} + } + }, + "sessionToken": { + "target": "com.amazonaws.inspector2#UUID", + "traits": { + "smithy.api#documentation": "

The unique token that identifies the CIS session.

", + "smithy.api#required": {} + } + }, + "messages": { + "target": "com.amazonaws.inspector2#CisSessionMessages", + "traits": { + "smithy.api#documentation": "

The CIS session telemetry messages.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#SendCisSessionTelemetryResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.inspector2#Service": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EC2", + "name": "EC2" + }, + { + "value": "ECR", + "name": "ECR" + }, + { + "value": "LAMBDA", + "name": "LAMBDA" + } + ] + } + }, + "com.amazonaws.inspector2#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the resource that exceeds a service quota.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

You have exceeded your service quota. To perform the requested action, remove some of\n the relevant resources, or use Service Quotas to request a service quota increase.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.inspector2#Severity": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INFORMATIONAL", + "name": "INFORMATIONAL" + }, + { + "value": "LOW", + "name": "LOW" + }, + { + "value": "MEDIUM", + "name": "MEDIUM" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "CRITICAL", + "name": "CRITICAL" + }, + { + "value": "UNTRIAGED", + "name": "UNTRIAGED" + } + ] + } + }, + "com.amazonaws.inspector2#SeverityCounts": { + "type": "structure", + "members": { + "all": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The total count of findings from all severities.

" + } + }, + "medium": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The total count of medium severity findings.

" + } + }, + "high": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The total count of high severity findings.

" + } + }, + "critical": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The total count of critical severity findings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains the counts of aggregated finding per severity.

" + } + }, + "com.amazonaws.inspector2#SortCriteria": { + "type": "structure", + "members": { + "field": { + "target": "com.amazonaws.inspector2#SortField", + "traits": { + "smithy.api#documentation": "

The finding detail field by which results are sorted.

", + "smithy.api#required": {} + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#SortOrder", + "traits": { + "smithy.api#documentation": "

The order by which findings are sorted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the criteria used to sort finding results.

" + } + }, + "com.amazonaws.inspector2#SortField": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWS_ACCOUNT_ID", + "name": "AWS_ACCOUNT_ID" + }, + { + "value": "FINDING_TYPE", + "name": "FINDING_TYPE" + }, + { + "value": "SEVERITY", + "name": "SEVERITY" + }, + { + "value": "FIRST_OBSERVED_AT", + "name": "FIRST_OBSERVED_AT" + }, + { + "value": "LAST_OBSERVED_AT", + "name": "LAST_OBSERVED_AT" + }, + { + "value": "FINDING_STATUS", + "name": "FINDING_STATUS" + }, + { + "value": "RESOURCE_TYPE", + "name": "RESOURCE_TYPE" + }, + { + "value": "ECR_IMAGE_PUSHED_AT", + "name": "ECR_IMAGE_PUSHED_AT" + }, + { + "value": "ECR_IMAGE_REPOSITORY_NAME", + "name": "ECR_IMAGE_REPOSITORY_NAME" + }, + { + "value": "ECR_IMAGE_REGISTRY", + "name": "ECR_IMAGE_REGISTRY" + }, + { + "value": "NETWORK_PROTOCOL", + "name": "NETWORK_PROTOCOL" + }, + { + "value": "COMPONENT_TYPE", + "name": "COMPONENT_TYPE" + }, + { + "value": "VULNERABILITY_ID", + "name": "VULNERABILITY_ID" + }, + { + "value": "VULNERABILITY_SOURCE", + "name": "VULNERABILITY_SOURCE" + }, + { + "value": "INSPECTOR_SCORE", + "name": "INSPECTOR_SCORE" + }, + { + "value": "VENDOR_SEVERITY", + "name": "VENDOR_SEVERITY" + }, + { + "value": "EPSS_SCORE", + "name": "EPSS_SCORE" + } + ] + } + }, + "com.amazonaws.inspector2#SortOrder": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ASC", + "name": "ASC" + }, + { + "value": "DESC", + "name": "DESC" + } + ] + } + }, + "com.amazonaws.inspector2#SourceLayerHash": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 71, + "max": 71 + }, + "smithy.api#pattern": "^sha256:[a-z0-9]{64}$" + } + }, + "com.amazonaws.inspector2#StartCisSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#StartCisSessionRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#StartCisSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#ConflictException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Starts a CIS session. \n This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. \n The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.\n

", + "smithy.api#examples": [ + { + "title": "Sample SendCisSessionHealth Call", + "input": { + "scanJobId": "624b746d-e080-44ae-8c1d-48e653365a38", + "message": { + "sessionToken": "624b746d-e080-44ae-8c1d-48e653365a31" + } + }, + "output": {} + } + ], + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/cissession/start" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.inspector2#StartCisSessionMessage": { + "type": "structure", + "members": { + "sessionToken": { + "target": "com.amazonaws.inspector2#UUID", + "traits": { + "smithy.api#documentation": "

The unique token that identifies the CIS session.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The start CIS session message.

" + } + }, + "com.amazonaws.inspector2#StartCisSessionRequest": { + "type": "structure", + "members": { + "scanJobId": { + "target": "com.amazonaws.inspector2#UUID", + "traits": { + "smithy.api#documentation": "

A unique identifier for the scan job.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "com.amazonaws.inspector2#StartCisSessionMessage", + "traits": { + "smithy.api#documentation": "

The start CIS session message.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#StartCisSessionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.inspector2#State": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.inspector2#Status", + "traits": { + "smithy.api#documentation": "

The status of Amazon Inspector for the account.

", + "smithy.api#required": {} + } + }, + "errorCode": { + "target": "com.amazonaws.inspector2#ErrorCode", + "traits": { + "smithy.api#documentation": "

The error code explaining why the account failed to enable Amazon Inspector.

", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The error message received when the account failed to enable Amazon Inspector.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that described the state of Amazon Inspector scans for an account.

" + } + }, + "com.amazonaws.inspector2#Status": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLING", + "name": "ENABLING" + }, + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "DISABLING", + "name": "DISABLING" + }, + { + "value": "DISABLED", + "name": "DISABLED" + }, + { + "value": "SUSPENDING", + "name": "SUSPENDING" + }, + { + "value": "SUSPENDED", + "name": "SUSPENDED" + } + ] + } + }, + "com.amazonaws.inspector2#StatusCounts": { + "type": "structure", + "members": { + "failed": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of checks that failed.

" + } + }, + "skipped": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of checks that were skipped.

" + } + }, + "passed": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of checks that passed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status counts.

" + } + }, + "com.amazonaws.inspector2#Step": { + "type": "structure", + "members": { + "componentId": { + "target": "com.amazonaws.inspector2#Component", + "traits": { + "smithy.api#documentation": "

The component ID.

", + "smithy.api#required": {} + } + }, + "componentType": { + "target": "com.amazonaws.inspector2#ComponentType", + "traits": { + "smithy.api#documentation": "

The component type.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the step associated with a finding.

" + } + }, + "com.amazonaws.inspector2#StepList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Step" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + } + } + }, + "com.amazonaws.inspector2#StopCisMessageProgress": { + "type": "structure", + "members": { + "totalChecks": { + "target": "com.amazonaws.inspector2#CheckCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The progress' total checks.

" + } + }, + "successfulChecks": { + "target": "com.amazonaws.inspector2#CheckCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The progress' successful checks.

" + } + }, + "failedChecks": { + "target": "com.amazonaws.inspector2#CheckCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The progress' failed checks.

" + } + }, + "notEvaluatedChecks": { + "target": "com.amazonaws.inspector2#CheckCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The progress' not evaluated checks.

" + } + }, + "unknownChecks": { + "target": "com.amazonaws.inspector2#CheckCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The progress' unknown checks.

" + } + }, + "notApplicableChecks": { + "target": "com.amazonaws.inspector2#CheckCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The progress' not applicable checks.

" + } + }, + "informationalChecks": { + "target": "com.amazonaws.inspector2#CheckCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The progress' informational checks.

" + } + }, + "errorChecks": { + "target": "com.amazonaws.inspector2#CheckCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The progress' error checks.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The stop CIS message progress.

" + } + }, + "com.amazonaws.inspector2#StopCisSession": { + "type": "operation", "input": { - "findingArns": [ - "arn:aws:inspector2:eu-west-1:123456789012:finding/78b88cc9aa1d78b6e14fde90d774dde7", - "arn:aws:inspector2:eu-west-1:111111111111:finding/78b88cc9aa1d78b6e14fde90d874dde7" - ] + "target": "com.amazonaws.inspector2#StopCisSessionRequest" }, "output": { - "findingDetails": [ - { - "findingArn": "arn:aws:inspector2:eu-west-1:123456789012:finding/78b88cc9aa1d78b6e14fde90d774dde7", - "cisaData": { - "dateAdded": 1688580990, - "dateDue": 1688580999, - "action": "For all affected software assets for which updates exist, the only acceptable remediation actions are: 1) Apply updates; OR 2) remove affected assets from agency networks." - }, - "riskScore": 66, - "evidences": [ - { - "evidenceRule": "Historically Linked to Penetration Testing Tools", - "evidenceDetail": "2 sightings on 1 source", - "severity": "Low" - } - ], - "ttps": ["TA0001", "TA0002"], - "tools": ["Metasploit"], - "exploitObserved": { - "lastSeen": 1688580990, - "firstSeen": 1688580800 - }, - "referenceUrls": ["https://nvd.nist.gov/vuln/detail/CVE-2019-20367"], - "cwes": ["cwe-1234"], - "epssScore": 0.85 - } - ], - "errors": [ - { - "findingArn": "arn:aws:inspector2:eu-west-1:111111111111:finding/78b88cc9aa1d78b6e14fde90d874dde7", - "errorCode": "ACCESS_DENIED", - "errorMessage": "You don't have permission to access this finding" - } - ] - } - } - ], - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/findings/details/batch/get" - } - } - }, - "com.amazonaws.inspector2#BatchGetFindingDetailsRequest": { - "type": "structure", - "members": { - "findingArns": { - "target": "com.amazonaws.inspector2#FindingArnList", - "traits": { - "smithy.api#documentation": "

A list of finding ARNs.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#BatchGetFindingDetailsResponse": { - "type": "structure", - "members": { - "findingDetails": { - "target": "com.amazonaws.inspector2#FindingDetails", - "traits": { - "smithy.api#documentation": "

A finding's vulnerability details.

" - } - }, - "errors": { - "target": "com.amazonaws.inspector2#FindingDetailsErrorList", - "traits": { - "smithy.api#documentation": "

Error information for findings that details could not be returned for.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#BatchGetFreeTrialInfo": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#BatchGetFreeTrialInfoRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#BatchGetFreeTrialInfoResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets free trial status for multiple Amazon Web Services accounts.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/freetrialinfo/batchget" - } - } - }, - "com.amazonaws.inspector2#BatchGetFreeTrialInfoRequest": { - "type": "structure", - "members": { - "accountIds": { - "target": "com.amazonaws.inspector2#MeteringAccountIdList", - "traits": { - "smithy.api#documentation": "

The account IDs to get free trial status for.

", - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.inspector2#BatchGetFreeTrialInfoResponse": { - "type": "structure", - "members": { - "accounts": { - "target": "com.amazonaws.inspector2#FreeTrialAccountInfoList", - "traits": { - "smithy.api#documentation": "

An array of objects that provide Amazon Inspector free trial details for each of the requested accounts.\n

", - "smithy.api#required": {} - } - }, - "failedAccounts": { - "target": "com.amazonaws.inspector2#FreeTrialInfoErrorList", - "traits": { - "smithy.api#documentation": "

An array of objects detailing any accounts that free trial data could not be returned for.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.inspector2#BatchGetMemberEc2DeepInspectionStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#BatchGetMemberEc2DeepInspectionStatusRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#BatchGetMemberEc2DeepInspectionStatusResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves Amazon Inspector deep inspection activation status of multiple member accounts within your organization. You must be the delegated administrator of an organization in Amazon Inspector to use this API.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/ec2deepinspectionstatus/member/batch/get" - } - } - }, - "com.amazonaws.inspector2#BatchGetMemberEc2DeepInspectionStatusRequest": { - "type": "structure", - "members": { - "accountIds": { - "target": "com.amazonaws.inspector2#AccountIdSet", - "traits": { - "smithy.api#documentation": "

The unique identifiers for the Amazon Web Services accounts to retrieve Amazon Inspector deep inspection activation status for.\n \n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#BatchGetMemberEc2DeepInspectionStatusResponse": { - "type": "structure", - "members": { - "accountIds": { - "target": "com.amazonaws.inspector2#MemberAccountEc2DeepInspectionStatusStateList", - "traits": { - "smithy.api#documentation": "

An array of objects that provide details on the activation status of Amazon Inspector deep inspection for each of the requested accounts.\n \n

" - } - }, - "failedAccountIds": { - "target": "com.amazonaws.inspector2#FailedMemberAccountEc2DeepInspectionStatusStateList", - "traits": { - "smithy.api#documentation": "

An array of objects that provide details on any accounts that failed to activate Amazon Inspector deep inspection and why.\n \n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#BatchUpdateMemberEc2DeepInspectionStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#BatchUpdateMemberEc2DeepInspectionStatusRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#BatchUpdateMemberEc2DeepInspectionStatusResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Activates or deactivates Amazon Inspector deep inspection for the provided member accounts in your organization. You must be the delegated administrator of an organization in Amazon Inspector to use this API.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/ec2deepinspectionstatus/member/batch/update" - } - } - }, - "com.amazonaws.inspector2#BatchUpdateMemberEc2DeepInspectionStatusRequest": { - "type": "structure", - "members": { - "accountIds": { - "target": "com.amazonaws.inspector2#MemberAccountEc2DeepInspectionStatusList", - "traits": { - "smithy.api#documentation": "

The unique identifiers for the Amazon Web Services accounts to change Amazon Inspector deep inspection status for.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#BatchUpdateMemberEc2DeepInspectionStatusResponse": { - "type": "structure", - "members": { - "accountIds": { - "target": "com.amazonaws.inspector2#MemberAccountEc2DeepInspectionStatusStateList", - "traits": { - "smithy.api#documentation": "

An array of objects that provide details for each of the accounts that Amazon Inspector deep inspection status was successfully changed for. \n

" - } - }, - "failedAccountIds": { - "target": "com.amazonaws.inspector2#FailedMemberAccountEc2DeepInspectionStatusStateList", - "traits": { - "smithy.api#documentation": "

An array of objects that provide details for each of the accounts that Amazon Inspector deep inspection status could not be successfully changed for. \n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#BenchmarkProfile": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 128 - } - } - }, - "com.amazonaws.inspector2#BenchmarkVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 8 - } - } - }, - "com.amazonaws.inspector2#CancelFindingsReport": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#CancelFindingsReportRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#CancelFindingsReportResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Cancels the given findings report.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/reporting/cancel" - } - } - }, - "com.amazonaws.inspector2#CancelFindingsReportRequest": { - "type": "structure", - "members": { - "reportId": { - "target": "com.amazonaws.inspector2#ReportId", - "traits": { - "smithy.api#documentation": "

The ID of the report to be canceled.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.inspector2#CancelFindingsReportResponse": { - "type": "structure", - "members": { - "reportId": { - "target": "com.amazonaws.inspector2#ReportId", - "traits": { - "smithy.api#documentation": "

The ID of the canceled report.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.inspector2#CancelSbomExport": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#CancelSbomExportRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#CancelSbomExportResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Cancels a software bill of materials (SBOM) report.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/sbomexport/cancel" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.inspector2#CancelSbomExportRequest": { - "type": "structure", - "members": { - "reportId": { - "target": "com.amazonaws.inspector2#ReportId", - "traits": { - "smithy.api#documentation": "

The report ID of the SBOM export to cancel.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#CancelSbomExportResponse": { - "type": "structure", - "members": { - "reportId": { - "target": "com.amazonaws.inspector2#ReportId", - "traits": { - "smithy.api#documentation": "

The report ID of the canceled SBOM export.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#CheckCount": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 65536 - } - } - }, - "com.amazonaws.inspector2#CheckIdFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisStringFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#CisAccountIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#AccountId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10000 - }, - "smithy.api#uniqueItems": {} - } - }, - "com.amazonaws.inspector2#CisCheckAggregation": { - "type": "structure", - "members": { - "scanArn": { - "target": "com.amazonaws.inspector2#CisScanArn", - "traits": { - "smithy.api#documentation": "

The scan ARN for the CIS check scan ARN.

", - "smithy.api#required": {} - } - }, - "checkId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The check ID for the CIS check.

" - } - }, - "title": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The CIS check title.

" - } - }, - "checkDescription": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The description for the CIS check.

" - } - }, - "level": { - "target": "com.amazonaws.inspector2#CisSecurityLevel", - "traits": { - "smithy.api#documentation": "

The CIS check level.

" - } - }, - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The account ID for the CIS check.

" - } - }, - "statusCounts": { - "target": "com.amazonaws.inspector2#StatusCounts", - "traits": { - "smithy.api#documentation": "

The CIS check status counts.

" - } - }, - "platform": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The CIS check platform.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A CIS check.

" - } - }, - "com.amazonaws.inspector2#CisCheckAggregationList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisCheckAggregation" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.inspector2#CisDateFilter": { - "type": "structure", - "members": { - "earliestScanStartTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The CIS date filter's earliest scan start time.

" - } - }, - "latestScanStartTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The CIS date filter's latest scan start time.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The CIS date filter.

" - } - }, - "com.amazonaws.inspector2#CisFindingArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws(-gov|-cn)?:inspector2:[-.a-z0-9]{0,20}:\\d{12}:owner/\\d{12}/cis-finding/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" - } - }, - "com.amazonaws.inspector2#CisFindingArnFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisStringFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#CisFindingStatus": { - "type": "enum", - "members": { - "PASSED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PASSED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "SKIPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SKIPPED" - } - } - } - }, - "com.amazonaws.inspector2#CisFindingStatusComparison": { - "type": "enum", - "members": { - "EQUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EQUALS" - } - } - } - }, - "com.amazonaws.inspector2#CisFindingStatusFilter": { - "type": "structure", - "members": { - "comparison": { - "target": "com.amazonaws.inspector2#CisFindingStatusComparison", - "traits": { - "smithy.api#documentation": "

The comparison value of the CIS finding status filter.

", - "smithy.api#required": {} - } - }, - "value": { - "target": "com.amazonaws.inspector2#CisFindingStatus", - "traits": { - "smithy.api#documentation": "

The value of the CIS finding status filter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The CIS finding status filter.

" - } - }, - "com.amazonaws.inspector2#CisFindingStatusFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisFindingStatusFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - }, - "smithy.api#uniqueItems": {} - } - }, - "com.amazonaws.inspector2#CisNumberFilter": { - "type": "structure", - "members": { - "upperInclusive": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The CIS number filter's upper inclusive.

" - } - }, - "lowerInclusive": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The CIS number filter's lower inclusive.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The CIS number filter.

" - } - }, - "com.amazonaws.inspector2#CisNumberFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisNumberFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - }, - "smithy.api#uniqueItems": {} - } - }, - "com.amazonaws.inspector2#CisOwnerId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^\\d{12}|o-[a-z0-9]{10,32}$" - } - }, - "com.amazonaws.inspector2#CisReportFormat": { - "type": "enum", - "members": { - "PDF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PDF" - } - }, - "CSV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CSV" - } - } - } - }, - "com.amazonaws.inspector2#CisReportStatus": { - "type": "enum", - "members": { - "SUCCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCEEDED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - } - } - }, - "com.amazonaws.inspector2#CisResultStatus": { - "type": "enum", - "members": { - "PASSED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PASSED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "SKIPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SKIPPED" - } - } - } - }, - "com.amazonaws.inspector2#CisResultStatusComparison": { - "type": "enum", - "members": { - "EQUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EQUALS" - } - } - } - }, - "com.amazonaws.inspector2#CisResultStatusFilter": { - "type": "structure", - "members": { - "comparison": { - "target": "com.amazonaws.inspector2#CisResultStatusComparison", - "traits": { - "smithy.api#documentation": "

The comparison value of the CIS result status filter.

", - "smithy.api#required": {} - } - }, - "value": { - "target": "com.amazonaws.inspector2#CisResultStatus", - "traits": { - "smithy.api#documentation": "

The value of the CIS result status filter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The CIS result status filter.

" - } - }, - "com.amazonaws.inspector2#CisResultStatusFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisResultStatusFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#CisRuleDetails": { - "type": "blob", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1000 - } - } - }, - "com.amazonaws.inspector2#CisRuleStatus": { - "type": "enum", - "members": { - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "PASSED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PASSED" - } - }, - "NOT_EVALUATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_EVALUATED" - } - }, - "INFORMATIONAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INFORMATIONAL" - } - }, - "UNKNOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNKNOWN" - } - }, - "NOT_APPLICABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_APPLICABLE" - } - }, - "ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ERROR" - } - } - } - }, - "com.amazonaws.inspector2#CisScan": { - "type": "structure", - "members": { - "scanArn": { - "target": "com.amazonaws.inspector2#CisScanArn", - "traits": { - "smithy.api#documentation": "

The CIS scan's ARN.

", - "smithy.api#required": {} - } - }, - "scanConfigurationArn": { - "target": "com.amazonaws.inspector2#CisScanConfigurationArn", - "traits": { - "smithy.api#documentation": "

The CIS scan's configuration ARN.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.inspector2#CisScanStatus", - "traits": { - "smithy.api#documentation": "

The CIS scan's status.

" - } - }, - "scanName": { - "target": "com.amazonaws.inspector2#CisScanName", - "traits": { - "smithy.api#documentation": "

The the name of the scan configuration that's associated with this scan.

" - } - }, - "scanDate": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The CIS scan's date.

" - } - }, - "failedChecks": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The CIS scan's failed checks.

" - } - }, - "totalChecks": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The CIS scan's total checks.

" - } - }, - "targets": { - "target": "com.amazonaws.inspector2#CisTargets", - "traits": { - "smithy.api#documentation": "

The CIS scan's targets.

" - } - }, - "scheduledBy": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The account or organization that schedules the CIS scan.

" - } - }, - "securityLevel": { - "target": "com.amazonaws.inspector2#CisSecurityLevel", - "traits": { - "smithy.api#documentation": "

\n The security level for the CIS scan. \n Security level refers to the Benchmark levels that CIS assigns to a profile.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The CIS scan.

" - } - }, - "com.amazonaws.inspector2#CisScanArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws(-us-gov|-cn)?:inspector2:[-.a-z0-9]{0,20}:\\d{12}:owner/(\\d{12}|o-[a-z0-9]{10,32})/cis-scan/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" - } - }, - "com.amazonaws.inspector2#CisScanArnFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisStringFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#CisScanConfiguration": { - "type": "structure", - "members": { - "scanConfigurationArn": { - "target": "com.amazonaws.inspector2#CisScanConfigurationArn", - "traits": { - "smithy.api#documentation": "

The CIS scan configuration's scan configuration ARN.

", - "smithy.api#required": {} - } - }, - "ownerId": { - "target": "com.amazonaws.inspector2#CisOwnerId", - "traits": { - "smithy.api#documentation": "

The CIS scan configuration's owner ID.

" - } - }, - "scanName": { - "target": "com.amazonaws.inspector2#CisScanName", - "traits": { - "smithy.api#documentation": "

The name of the CIS scan configuration.

" - } - }, - "securityLevel": { - "target": "com.amazonaws.inspector2#CisSecurityLevel", - "traits": { - "smithy.api#documentation": "

The CIS scan configuration's security level.

" - } - }, - "schedule": { - "target": "com.amazonaws.inspector2#Schedule", - "traits": { - "smithy.api#documentation": "

The CIS scan configuration's schedule.

" - } - }, - "targets": { - "target": "com.amazonaws.inspector2#CisTargets", - "traits": { - "smithy.api#documentation": "

The CIS scan configuration's targets.

" - } - }, - "tags": { - "target": "com.amazonaws.inspector2#CisTagMap", - "traits": { - "smithy.api#documentation": "

The CIS scan configuration's tags.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The CIS scan configuration.

" - } - }, - "com.amazonaws.inspector2#CisScanConfigurationArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws(-us-gov|-cn)?:inspector2:[a-z]{2}(-gov)?-[a-z]+-[0-9]{1}:[0-9]{12}:owner/(o-[a-z0-9]+|[0-9]{12})/cis-configuration/[0-9a-fA-F-]+$" - } - }, - "com.amazonaws.inspector2#CisScanConfigurationArnFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisStringFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#CisScanConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisScanConfiguration" - }, - "traits": { - "smithy.api#length": { - "max": 100 - } - } - }, - "com.amazonaws.inspector2#CisScanConfigurationsSortBy": { - "type": "enum", - "members": { - "SCAN_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCAN_NAME" - } - }, - "SCAN_CONFIGURATION_ARN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCAN_CONFIGURATION_ARN" - } - } - } - }, - "com.amazonaws.inspector2#CisScanDateFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisDateFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.inspector2#CisScanList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisScan" - }, - "traits": { - "smithy.api#length": { - "max": 50 - } - } - }, - "com.amazonaws.inspector2#CisScanName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.inspector2#CisScanNameFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisStringFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#CisScanResultDetails": { - "type": "structure", - "members": { - "scanArn": { - "target": "com.amazonaws.inspector2#CisScanArn", - "traits": { - "smithy.api#documentation": "

The CIS scan result details' scan ARN.

", - "smithy.api#required": {} - } - }, - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The CIS scan result details' account ID.

" - } - }, - "targetResourceId": { - "target": "com.amazonaws.inspector2#ResourceId", - "traits": { - "smithy.api#documentation": "

The CIS scan result details' target resource ID.

" - } - }, - "platform": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The CIS scan result details' platform.

" - } - }, - "status": { - "target": "com.amazonaws.inspector2#CisFindingStatus", - "traits": { - "smithy.api#documentation": "

The CIS scan result details' status.

" - } - }, - "statusReason": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The CIS scan result details' status reason.

" - } - }, - "checkId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The CIS scan result details' check ID.

" - } - }, - "title": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The CIS scan result details' title.

" - } - }, - "checkDescription": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The account ID that's associated with the CIS scan result details.

" - } - }, - "remediation": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The CIS scan result details' remediation.

" - } - }, - "level": { - "target": "com.amazonaws.inspector2#CisSecurityLevel", - "traits": { - "smithy.api#documentation": "

The CIS scan result details' level.

" - } - }, - "findingArn": { - "target": "com.amazonaws.inspector2#CisFindingArn", - "traits": { - "smithy.api#documentation": "

The CIS scan result details' finding ARN.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The CIS scan result details.

" - } - }, - "com.amazonaws.inspector2#CisScanResultDetailsFilterCriteria": { - "type": "structure", - "members": { - "findingStatusFilters": { - "target": "com.amazonaws.inspector2#CisFindingStatusFilterList", - "traits": { - "smithy.api#documentation": "

The criteria's finding status filters.

" - } - }, - "checkIdFilters": { - "target": "com.amazonaws.inspector2#CheckIdFilterList", - "traits": { - "smithy.api#documentation": "

The criteria's check ID filters.

" - } - }, - "titleFilters": { - "target": "com.amazonaws.inspector2#TitleFilterList", - "traits": { - "smithy.api#documentation": "

The criteria's title filters.

" - } - }, - "securityLevelFilters": { - "target": "com.amazonaws.inspector2#CisSecurityLevelFilterList", - "traits": { - "smithy.api#documentation": "

\n The criteria's security level filters. . \n Security level refers to the Benchmark levels that CIS assigns to a profile.\n

" - } - }, - "findingArnFilters": { - "target": "com.amazonaws.inspector2#CisFindingArnFilterList", - "traits": { - "smithy.api#documentation": "

The criteria's finding ARN filters.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The CIS scan result details filter criteria.

" - } - }, - "com.amazonaws.inspector2#CisScanResultDetailsList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisScanResultDetails" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.inspector2#CisScanResultDetailsSortBy": { - "type": "enum", - "members": { - "CHECK_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CHECK_ID" - } - }, - "STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STATUS" - } - } - } - }, - "com.amazonaws.inspector2#CisScanResultsAggregatedByChecksFilterCriteria": { - "type": "structure", - "members": { - "accountIdFilters": { - "target": "com.amazonaws.inspector2#OneAccountIdFilterList", - "traits": { - "smithy.api#documentation": "

The criteria's account ID filters.

" - } - }, - "checkIdFilters": { - "target": "com.amazonaws.inspector2#CheckIdFilterList", - "traits": { - "smithy.api#documentation": "

The criteria's check ID filters.

" - } - }, - "titleFilters": { - "target": "com.amazonaws.inspector2#TitleFilterList", - "traits": { - "smithy.api#documentation": "

The criteria's title filters.

" - } - }, - "platformFilters": { - "target": "com.amazonaws.inspector2#PlatformFilterList", - "traits": { - "smithy.api#documentation": "

The criteria's platform filters.

" - } - }, - "failedResourcesFilters": { - "target": "com.amazonaws.inspector2#CisNumberFilterList", - "traits": { - "smithy.api#documentation": "

The criteria's failed resources filters.

" - } - }, - "securityLevelFilters": { - "target": "com.amazonaws.inspector2#CisSecurityLevelFilterList", - "traits": { - "smithy.api#documentation": "

The criteria's security level filters.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The scan results aggregated by checks filter criteria.

" - } - }, - "com.amazonaws.inspector2#CisScanResultsAggregatedByChecksSortBy": { - "type": "enum", - "members": { - "CHECK_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CHECK_ID" - } - }, - "TITLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TITLE" - } - }, - "PLATFORM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PLATFORM" - } - }, - "FAILED_COUNTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_COUNTS" - } - }, - "SECURITY_LEVEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SECURITY_LEVEL" - } - } - } - }, - "com.amazonaws.inspector2#CisScanResultsAggregatedByTargetResourceFilterCriteria": { - "type": "structure", - "members": { - "accountIdFilters": { - "target": "com.amazonaws.inspector2#AccountIdFilterList", - "traits": { - "smithy.api#documentation": "

The criteria's account ID filters.

" - } - }, - "statusFilters": { - "target": "com.amazonaws.inspector2#CisResultStatusFilterList", - "traits": { - "smithy.api#documentation": "

The criteria's status filter.

" - } - }, - "checkIdFilters": { - "target": "com.amazonaws.inspector2#CheckIdFilterList", - "traits": { - "smithy.api#documentation": "

The criteria's check ID filters.

" - } - }, - "targetResourceIdFilters": { - "target": "com.amazonaws.inspector2#ResourceIdFilterList", - "traits": { - "smithy.api#documentation": "

The criteria's target resource ID filters.

" - } - }, - "targetResourceTagFilters": { - "target": "com.amazonaws.inspector2#ResourceTagFilterList", - "traits": { - "smithy.api#documentation": "

The criteria's target resource tag filters.

" - } - }, - "platformFilters": { - "target": "com.amazonaws.inspector2#PlatformFilterList", - "traits": { - "smithy.api#documentation": "

The criteria's platform filters.

" - } - }, - "targetStatusFilters": { - "target": "com.amazonaws.inspector2#TargetStatusFilterList", - "traits": { - "smithy.api#documentation": "

The criteria's target status filters.

" - } - }, - "targetStatusReasonFilters": { - "target": "com.amazonaws.inspector2#TargetStatusReasonFilterList", - "traits": { - "smithy.api#documentation": "

The criteria's target status reason filters.

" - } - }, - "failedChecksFilters": { - "target": "com.amazonaws.inspector2#CisNumberFilterList", - "traits": { - "smithy.api#documentation": "

The criteria's failed checks filters.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The scan results aggregated by target resource filter criteria.

" - } - }, - "com.amazonaws.inspector2#CisScanResultsAggregatedByTargetResourceSortBy": { - "type": "enum", - "members": { - "RESOURCE_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESOURCE_ID" - } - }, - "FAILED_COUNTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_COUNTS" - } - }, - "ACCOUNT_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCOUNT_ID" - } - }, - "PLATFORM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PLATFORM" - } - }, - "TARGET_STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TARGET_STATUS" - } - }, - "TARGET_STATUS_REASON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TARGET_STATUS_REASON" - } - } - } - }, - "com.amazonaws.inspector2#CisScanResultsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.inspector2#CisScanStatus": { - "type": "enum", - "members": { - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLED" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - } - } - }, - "com.amazonaws.inspector2#CisScanStatusComparison": { - "type": "enum", - "members": { - "EQUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EQUALS" - } - } - } - }, - "com.amazonaws.inspector2#CisScanStatusFilter": { - "type": "structure", - "members": { - "comparison": { - "target": "com.amazonaws.inspector2#CisScanStatusComparison", - "traits": { - "smithy.api#documentation": "

The filter comparison value.

", - "smithy.api#required": {} - } - }, - "value": { - "target": "com.amazonaws.inspector2#CisScanStatus", - "traits": { - "smithy.api#documentation": "

The filter value.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The CIS scan status filter.

" - } - }, - "com.amazonaws.inspector2#CisScanStatusFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisScanStatusFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - }, - "smithy.api#uniqueItems": {} - } - }, - "com.amazonaws.inspector2#CisScheduledByFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisStringFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#CisSecurityLevel": { - "type": "enum", - "members": { - "LEVEL_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LEVEL_1" - } - }, - "LEVEL_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LEVEL_2" - } - } - } - }, - "com.amazonaws.inspector2#CisSecurityLevelComparison": { - "type": "enum", - "members": { - "EQUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EQUALS" - } - } - } - }, - "com.amazonaws.inspector2#CisSecurityLevelFilter": { - "type": "structure", - "members": { - "comparison": { - "target": "com.amazonaws.inspector2#CisSecurityLevelComparison", - "traits": { - "smithy.api#documentation": "

The CIS security filter comparison value.

", - "smithy.api#required": {} - } - }, - "value": { - "target": "com.amazonaws.inspector2#CisSecurityLevel", - "traits": { - "smithy.api#documentation": "

The CIS security filter value.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

\n The CIS security level filter. \n Security level refers to the Benchmark levels that CIS assigns to a profile.\n

" - } - }, - "com.amazonaws.inspector2#CisSecurityLevelFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisSecurityLevelFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#CisSessionMessage": { - "type": "structure", - "members": { - "ruleId": { - "target": "com.amazonaws.inspector2#RuleId", - "traits": { - "smithy.api#documentation": "

The rule ID for the CIS session message.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.inspector2#CisRuleStatus", - "traits": { - "smithy.api#documentation": "

The status of the CIS session message.

", - "smithy.api#required": {} - } - }, - "cisRuleDetails": { - "target": "com.amazonaws.inspector2#CisRuleDetails", - "traits": { - "smithy.api#documentation": "

The CIS rule details for the CIS session message.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The CIS session message.

" - } - }, - "com.amazonaws.inspector2#CisSessionMessages": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisSessionMessage" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 150 - } - } - }, - "com.amazonaws.inspector2#CisSortOrder": { - "type": "enum", - "members": { - "ASC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASC" - } - }, - "DESC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DESC" - } - } - } - }, - "com.amazonaws.inspector2#CisStringComparison": { - "type": "enum", - "members": { - "EQUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EQUALS" - } - }, - "PREFIX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PREFIX" - } - }, - "NOT_EQUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_EQUALS" - } - } - } - }, - "com.amazonaws.inspector2#CisStringFilter": { - "type": "structure", - "members": { - "comparison": { - "target": "com.amazonaws.inspector2#CisStringComparison", - "traits": { - "smithy.api#documentation": "

The comparison value of the CIS string filter.

", - "smithy.api#required": {} - } - }, - "value": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The value of the CIS string filter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The CIS string filter.

" - } - }, - "com.amazonaws.inspector2#CisTagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.inspector2#MapKey" - }, - "value": { - "target": "com.amazonaws.inspector2#MapValue" - } - }, - "com.amazonaws.inspector2#CisTargetResourceAggregation": { - "type": "structure", - "members": { - "scanArn": { - "target": "com.amazonaws.inspector2#CisScanArn", - "traits": { - "smithy.api#documentation": "

The scan ARN for the CIS target resource.

", - "smithy.api#required": {} - } - }, - "targetResourceId": { - "target": "com.amazonaws.inspector2#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the target resource.

" - } - }, - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The account ID for the CIS target resource.

" - } - }, - "targetResourceTags": { - "target": "com.amazonaws.inspector2#TargetResourceTags", - "traits": { - "smithy.api#documentation": "

The tag for the target resource.

" - } - }, - "statusCounts": { - "target": "com.amazonaws.inspector2#StatusCounts", - "traits": { - "smithy.api#documentation": "

The target resource status counts.

" - } - }, - "platform": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The platform for the CIS target resource.

" - } - }, - "targetStatus": { - "target": "com.amazonaws.inspector2#CisTargetStatus", - "traits": { - "smithy.api#documentation": "

The status of the target resource.

" - } - }, - "targetStatusReason": { - "target": "com.amazonaws.inspector2#CisTargetStatusReason", - "traits": { - "smithy.api#documentation": "

The reason for the target resource.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The CIS target resource aggregation.

" - } - }, - "com.amazonaws.inspector2#CisTargetResourceAggregationList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisTargetResourceAggregation" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.inspector2#CisTargetStatus": { - "type": "enum", - "members": { - "TIMED_OUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TIMED_OUT" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLED" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - } - } - }, - "com.amazonaws.inspector2#CisTargetStatusComparison": { - "type": "enum", - "members": { - "EQUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EQUALS" - } - } - } - }, - "com.amazonaws.inspector2#CisTargetStatusFilter": { - "type": "structure", - "members": { - "comparison": { - "target": "com.amazonaws.inspector2#CisTargetStatusComparison", - "traits": { - "smithy.api#documentation": "

The comparison value of the CIS target status filter.

", - "smithy.api#required": {} - } - }, - "value": { - "target": "com.amazonaws.inspector2#CisTargetStatus", - "traits": { - "smithy.api#documentation": "

The value of the CIS target status filter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The CIS target status filter.

" - } - }, - "com.amazonaws.inspector2#CisTargetStatusReason": { - "type": "enum", - "members": { - "SCAN_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCAN_IN_PROGRESS" - } - }, - "UNSUPPORTED_OS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNSUPPORTED_OS" - } - }, - "SSM_UNMANAGED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SSM_UNMANAGED" - } - } - } - }, - "com.amazonaws.inspector2#CisTargetStatusReasonFilter": { - "type": "structure", - "members": { - "comparison": { - "target": "com.amazonaws.inspector2#CisTargetStatusComparison", - "traits": { - "smithy.api#documentation": "

The comparison value of the CIS target status reason filter.

", - "smithy.api#required": {} - } - }, - "value": { - "target": "com.amazonaws.inspector2#CisTargetStatusReason", - "traits": { - "smithy.api#documentation": "

The value of the CIS target status reason filter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The CIS target status reason filter.

" - } - }, - "com.amazonaws.inspector2#CisTargets": { - "type": "structure", - "members": { - "accountIds": { - "target": "com.amazonaws.inspector2#CisAccountIdList", - "traits": { - "smithy.api#documentation": "

The CIS target account ids.

" - } - }, - "targetResourceTags": { - "target": "com.amazonaws.inspector2#TargetResourceTags", - "traits": { - "smithy.api#documentation": "

The CIS target resource tags.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The CIS targets.

" - } - }, - "com.amazonaws.inspector2#CisaAction": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0 - } - } - }, - "com.amazonaws.inspector2#CisaData": { - "type": "structure", - "members": { - "dateAdded": { - "target": "com.amazonaws.inspector2#CisaDateAdded", - "traits": { - "smithy.api#documentation": "

The date and time CISA added this vulnerability to their catalogue.

" - } - }, - "dateDue": { - "target": "com.amazonaws.inspector2#CisaDateDue", - "traits": { - "smithy.api#documentation": "

The date and time CISA expects a fix to have been provided vulnerability.

" - } - }, - "action": { - "target": "com.amazonaws.inspector2#CisaAction", - "traits": { - "smithy.api#documentation": "

The remediation action recommended by CISA for this vulnerability.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Cybersecurity and Infrastructure Security Agency (CISA) details for a specific vulnerability.

" - } - }, - "com.amazonaws.inspector2#CisaDateAdded": { - "type": "timestamp" - }, - "com.amazonaws.inspector2#CisaDateDue": { - "type": "timestamp" - }, - "com.amazonaws.inspector2#ClientToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.inspector2#CodeFilePath": { - "type": "structure", - "members": { - "fileName": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the file the code vulnerability was found in.

", - "smithy.api#required": {} - } - }, - "filePath": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The file path to the code that a vulnerability was found in.

", - "smithy.api#required": {} - } - }, - "startLine": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The line number of the first line of code that a vulnerability was found in.

", - "smithy.api#required": {} - } - }, - "endLine": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The line number of the last line of code that a vulnerability was found in.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information on where a code vulnerability is located in your Lambda function.

" - } - }, - "com.amazonaws.inspector2#CodeLine": { - "type": "structure", - "members": { - "content": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The content of a line of code

", - "smithy.api#length": { - "min": 0, - "max": 240 - }, - "smithy.api#required": {} - } - }, - "lineNumber": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The line number that a section of code is located at.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information on the lines of code associated with a code snippet.

" - } - }, - "com.amazonaws.inspector2#CodeLineList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CodeLine" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.inspector2#CodeSnippetError": { - "type": "structure", - "members": { - "findingArn": { - "target": "com.amazonaws.inspector2#FindingArn", - "traits": { - "smithy.api#documentation": "

The ARN of the finding that a code snippet couldn't be retrieved for.

", - "smithy.api#required": {} - } - }, - "errorCode": { - "target": "com.amazonaws.inspector2#CodeSnippetErrorCode", - "traits": { - "smithy.api#documentation": "

The error code for the error that prevented a code snippet from being retrieved.

", - "smithy.api#required": {} - } - }, - "errorMessage": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The error message received when Amazon Inspector failed to retrieve a code snippet.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information about any errors encountered while trying to retrieve a code snippet.

" - } - }, - "com.amazonaws.inspector2#CodeSnippetErrorCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "INTERNAL_ERROR", - "name": "INTERNAL_ERROR" - }, - { - "value": "ACCESS_DENIED", - "name": "ACCESS_DENIED" - }, - { - "value": "CODE_SNIPPET_NOT_FOUND", - "name": "CODE_SNIPPET_NOT_FOUND" - }, - { - "value": "INVALID_INPUT", - "name": "INVALID_INPUT" - } - ] - } - }, - "com.amazonaws.inspector2#CodeSnippetErrorList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CodeSnippetError" - } - }, - "com.amazonaws.inspector2#CodeSnippetResult": { - "type": "structure", - "members": { - "findingArn": { - "target": "com.amazonaws.inspector2#FindingArn", - "traits": { - "smithy.api#documentation": "

The ARN of a finding that the code snippet is associated with.

" - } - }, - "startLine": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The line number of the first line of a code snippet.

" - } - }, - "endLine": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The line number of the last line of a code snippet.

" - } - }, - "codeSnippet": { - "target": "com.amazonaws.inspector2#CodeLineList", - "traits": { - "smithy.api#documentation": "

Contains information on the retrieved code snippet.

" - } - }, - "suggestedFixes": { - "target": "com.amazonaws.inspector2#SuggestedFixes", - "traits": { - "smithy.api#documentation": "

Details of a suggested code fix.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information on a code snippet retrieved by Amazon Inspector from a code vulnerability finding.

" - } - }, - "com.amazonaws.inspector2#CodeSnippetResultList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CodeSnippetResult" - } - }, - "com.amazonaws.inspector2#CodeVulnerabilityDetails": { - "type": "structure", - "members": { - "filePath": { - "target": "com.amazonaws.inspector2#CodeFilePath", - "traits": { - "smithy.api#documentation": "

Contains information on where the code vulnerability is located in your code.

", - "smithy.api#required": {} - } - }, - "detectorTags": { - "target": "com.amazonaws.inspector2#DetectorTagList", - "traits": { - "smithy.api#documentation": "

The detector tag associated with the vulnerability. Detector tags group related vulnerabilities by common themes or tactics. For a list of available tags by programming language, see Java tags, or Python tags.

" - } - }, - "referenceUrls": { - "target": "com.amazonaws.inspector2#ReferenceUrls", - "traits": { - "smithy.api#documentation": "

A URL containing supporting documentation about the code vulnerability detected.

" - } - }, - "ruleId": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The identifier for a rule that was used to detect the code vulnerability.

" - } - }, - "sourceLambdaLayerArn": { - "target": "com.amazonaws.inspector2#LambdaLayerArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lambda layer that the code vulnerability was detected in.

" - } - }, - "detectorId": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon CodeGuru detector associated with the finding. For more information on detectors see Amazon CodeGuru\n Detector Library.

", - "smithy.api#required": {} - } - }, - "detectorName": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the detector used to identify the code vulnerability. For more information on detectors see CodeGuru Detector Library.

", - "smithy.api#required": {} - } - }, - "cwes": { - "target": "com.amazonaws.inspector2#CweList", - "traits": { - "smithy.api#documentation": "

The Common Weakness Enumeration (CWE) item associated with the detected vulnerability.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information on the code vulnerability identified in your Lambda function.

" - } - }, - "com.amazonaws.inspector2#Component": { - "type": "string" - }, - "com.amazonaws.inspector2#ComponentType": { - "type": "string" - }, - "com.amazonaws.inspector2#ComputePlatform": { - "type": "structure", - "members": { - "vendor": { - "target": "com.amazonaws.inspector2#Vendor", - "traits": { - "smithy.api#documentation": "

The compute platform vendor.

" - } - }, - "product": { - "target": "com.amazonaws.inspector2#Product", - "traits": { - "smithy.api#documentation": "

The compute platform product.

" - } - }, - "version": { - "target": "com.amazonaws.inspector2#PlatformVersion", - "traits": { - "smithy.api#documentation": "

The compute platform version.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A compute platform.

" - } - }, - "com.amazonaws.inspector2#ConflictException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - }, - "resourceId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The ID of the conflicting resource.

", - "smithy.api#required": {} - } - }, - "resourceType": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The type of the conflicting resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A conflict occurred.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.inspector2#Counts": { - "type": "structure", - "members": { - "count": { - "target": "com.amazonaws.inspector2#AggCounts", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of resources.

" - } - }, - "groupKey": { - "target": "com.amazonaws.inspector2#GroupKey", - "traits": { - "smithy.api#documentation": "

The key associated with this group

" - } - } - }, - "traits": { - "smithy.api#documentation": "

a structure that contains information on the count of resources within a group.

" - } - }, - "com.amazonaws.inspector2#CountsList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#Counts" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.inspector2#CoverageDateFilter": { - "type": "structure", - "members": { - "startInclusive": { - "target": "com.amazonaws.inspector2#DateTimeTimestamp", - "traits": { - "smithy.api#documentation": "

A timestamp representing the start of the time period to filter results by.

" - } - }, - "endInclusive": { - "target": "com.amazonaws.inspector2#DateTimeTimestamp", - "traits": { - "smithy.api#documentation": "

A timestamp representing the end of the time period to filter results by.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details of a coverage date filter.

" - } - }, - "com.amazonaws.inspector2#CoverageDateFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CoverageDateFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#CoverageFilterCriteria": { - "type": "structure", - "members": { - "scanStatusCode": { - "target": "com.amazonaws.inspector2#CoverageStringFilterList", - "traits": { - "smithy.api#documentation": "

The scan status code to filter on. Valid values are: ValidationException, InternalServerException, ResourceNotFoundException, BadRequestException, and ThrottlingException.

" - } - }, - "scanStatusReason": { - "target": "com.amazonaws.inspector2#CoverageStringFilterList", - "traits": { - "smithy.api#documentation": "

The scan status reason to filter on.

" - } - }, - "accountId": { - "target": "com.amazonaws.inspector2#CoverageStringFilterList", - "traits": { - "smithy.api#documentation": "

An array of Amazon Web Services account IDs to return coverage statistics for.

" - } - }, - "resourceId": { - "target": "com.amazonaws.inspector2#CoverageStringFilterList", - "traits": { - "smithy.api#documentation": "

An array of Amazon Web Services resource IDs to return coverage statistics for.

" - } - }, - "resourceType": { - "target": "com.amazonaws.inspector2#CoverageStringFilterList", - "traits": { - "smithy.api#documentation": "

An array of Amazon Web Services resource types to return coverage statistics for. The values can be AWS_EC2_INSTANCE, AWS_LAMBDA_FUNCTION, AWS_ECR_CONTAINER_IMAGE, AWS_ECR_REPOSITORY or AWS_ACCOUNT.

" - } - }, - "scanType": { - "target": "com.amazonaws.inspector2#CoverageStringFilterList", - "traits": { - "smithy.api#documentation": "

An array of Amazon Inspector scan types to return coverage statistics for.

" - } - }, - "ecrRepositoryName": { - "target": "com.amazonaws.inspector2#CoverageStringFilterList", - "traits": { - "smithy.api#documentation": "

The Amazon ECR repository name to filter on.

" - } - }, - "ecrImageTags": { - "target": "com.amazonaws.inspector2#CoverageStringFilterList", - "traits": { - "smithy.api#documentation": "

The Amazon ECR image tags to filter on.

" - } - }, - "ec2InstanceTags": { - "target": "com.amazonaws.inspector2#CoverageMapFilterList", - "traits": { - "smithy.api#documentation": "

The Amazon EC2 instance tags to filter on.

" - } - }, - "lambdaFunctionName": { - "target": "com.amazonaws.inspector2#CoverageStringFilterList", - "traits": { - "smithy.api#documentation": "

Returns coverage statistics for Amazon Web Services Lambda functions filtered by function names.

" - } - }, - "lambdaFunctionTags": { - "target": "com.amazonaws.inspector2#CoverageMapFilterList", - "traits": { - "smithy.api#documentation": "

Returns coverage statistics for Amazon Web Services Lambda functions filtered by tag.

" - } - }, - "lambdaFunctionRuntime": { - "target": "com.amazonaws.inspector2#CoverageStringFilterList", - "traits": { - "smithy.api#documentation": "

Returns coverage statistics for Amazon Web Services Lambda functions filtered by runtime.

" - } - }, - "lastScannedAt": { - "target": "com.amazonaws.inspector2#CoverageDateFilterList", - "traits": { - "smithy.api#documentation": "

Filters Amazon Web Services resources based on whether Amazon Inspector has checked them for vulnerabilities within the specified time range.

" - } - }, - "scanMode": { - "target": "com.amazonaws.inspector2#CoverageStringFilterList", - "traits": { - "smithy.api#documentation": "

The filter to search for Amazon EC2 instance coverage by scan mode. Valid values are EC2_SSM_AGENT_BASED and EC2_HYBRID.

" - } - }, - "imagePulledAt": { - "target": "com.amazonaws.inspector2#CoverageDateFilterList", - "traits": { - "smithy.api#documentation": "

The date an image was last pulled at.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that identifies filter criteria for GetCoverageStatistics.

" - } - }, - "com.amazonaws.inspector2#CoverageMapComparison": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EQUALS", - "name": "EQUALS" - } - ] - } - }, - "com.amazonaws.inspector2#CoverageMapFilter": { - "type": "structure", - "members": { - "comparison": { - "target": "com.amazonaws.inspector2#CoverageMapComparison", - "traits": { - "smithy.api#documentation": "

The operator to compare coverage on.

", - "smithy.api#required": {} - } - }, - "key": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The tag key associated with the coverage map filter.

", - "smithy.api#required": {} - } - }, - "value": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The tag value associated with the coverage map filter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details of a coverage map filter.

" - } - }, - "com.amazonaws.inspector2#CoverageMapFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CoverageMapFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#CoverageResourceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AWS_EC2_INSTANCE", - "name": "AWS_EC2_INSTANCE" - }, - { - "value": "AWS_ECR_CONTAINER_IMAGE", - "name": "AWS_ECR_CONTAINER_IMAGE" - }, - { - "value": "AWS_ECR_REPOSITORY", - "name": "AWS_ECR_REPOSITORY" - }, - { - "value": "AWS_LAMBDA_FUNCTION", - "name": "AWS_LAMBDA_FUNCTION" - } - ] - } - }, - "com.amazonaws.inspector2#CoverageStringComparison": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EQUALS", - "name": "EQUALS" - }, - { - "value": "NOT_EQUALS", - "name": "NOT_EQUALS" - } - ] - } - }, - "com.amazonaws.inspector2#CoverageStringFilter": { - "type": "structure", - "members": { - "comparison": { - "target": "com.amazonaws.inspector2#CoverageStringComparison", - "traits": { - "smithy.api#documentation": "

The operator to compare strings on.

", - "smithy.api#required": {} - } - }, - "value": { - "target": "com.amazonaws.inspector2#CoverageStringInput", - "traits": { - "smithy.api#documentation": "

The value to compare strings on.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details of a coverage string filter.

" - } - }, - "com.amazonaws.inspector2#CoverageStringFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CoverageStringFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#CoverageStringInput": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.inspector2#CoveredResource": { - "type": "structure", - "members": { - "resourceType": { - "target": "com.amazonaws.inspector2#CoverageResourceType", - "traits": { - "smithy.api#documentation": "

The type of the covered resource.

", - "smithy.api#required": {} - } - }, - "resourceId": { - "target": "com.amazonaws.inspector2#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the covered resource.

", - "smithy.api#required": {} - } - }, - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the covered resource.

", - "smithy.api#required": {} - } - }, - "scanType": { - "target": "com.amazonaws.inspector2#ScanType", - "traits": { - "smithy.api#documentation": "

The Amazon Inspector scan type covering the resource.

", - "smithy.api#required": {} - } - }, - "scanStatus": { - "target": "com.amazonaws.inspector2#ScanStatus", - "traits": { - "smithy.api#documentation": "

The status of the scan covering the resource.

" - } - }, - "resourceMetadata": { - "target": "com.amazonaws.inspector2#ResourceScanMetadata", - "traits": { - "smithy.api#documentation": "

An object that contains details about the metadata.

" - } - }, - "lastScannedAt": { - "target": "com.amazonaws.inspector2#DateTimeTimestamp", - "traits": { - "smithy.api#documentation": "

The date and time the resource was last checked for vulnerabilities.

" - } - }, - "scanMode": { - "target": "com.amazonaws.inspector2#ScanMode", - "traits": { - "smithy.api#documentation": "

The scan method that is applied to the instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains details about a resource covered by Amazon Inspector.

" - } - }, - "com.amazonaws.inspector2#CoveredResources": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CoveredResource" - } - }, - "com.amazonaws.inspector2#CreateCisScanConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#CreateCisScanConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#CreateCisScanConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a CIS scan configuration.

", - "smithy.api#examples": [ - { - "title": "Sample CreateCisScanConfiguration Call", - "input": { - "scanName": "sample", - "securityLevel": "LEVEL_1", - "schedule": { - "daily": { - "startTime": { - "timeOfDay": "12:34", - "timezone": "UTC" - } - } - }, - "targets": { - "accountIds": ["SELF"], - "targetResourceTags": { - "key": ["value"] + "target": "com.amazonaws.inspector2#StopCisSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#ConflictException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Stops a CIS session. \n This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. \n The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.\n

", + "smithy.api#examples": [ + { + "title": "Sample StopCisSession Call", + "input": { + "scanJobId": "624b746d-e080-44ae-8c1d-48e653365a38", + "sessionToken": "624b746d-e080-44ae-8c1d-48e653365a31", + "message": { + "status": "FAILED", + "reason": "Failure Reason", + "progress": { + "informationalChecks": 1, + "errorChecks": 1, + "successfulChecks": 5, + "notApplicableChecks": 0, + "totalChecks": 10, + "unknownChecks": 0, + "notEvaluatedChecks": 2, + "failedChecks": 0 + }, + "computePlatform": { + "vendor": "canonical", + "product": "ubuntu", + "version": "20.04" + }, + "benchmarkVersion": "2.0.0", + "benchmarkProfile": "xccdf_org.cisecurity.benchmarks_profile_Level_1" + } + }, + "output": {} + } + ], + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/cissession/stop" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.inspector2#StopCisSessionMessage": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.inspector2#StopCisSessionStatus", + "traits": { + "smithy.api#documentation": "

The status of the message.

", + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.inspector2#Reason", + "traits": { + "smithy.api#documentation": "

The reason for the message.

" + } + }, + "progress": { + "target": "com.amazonaws.inspector2#StopCisMessageProgress", + "traits": { + "smithy.api#documentation": "

The progress of the message.

", + "smithy.api#required": {} + } + }, + "computePlatform": { + "target": "com.amazonaws.inspector2#ComputePlatform", + "traits": { + "smithy.api#documentation": "

The message compute platform.

" + } + }, + "benchmarkVersion": { + "target": "com.amazonaws.inspector2#BenchmarkVersion", + "traits": { + "smithy.api#documentation": "

The message benchmark version.

" + } + }, + "benchmarkProfile": { + "target": "com.amazonaws.inspector2#BenchmarkProfile", + "traits": { + "smithy.api#documentation": "

The message benchmark profile.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The stop CIS session message.

" + } + }, + "com.amazonaws.inspector2#StopCisSessionRequest": { + "type": "structure", + "members": { + "scanJobId": { + "target": "com.amazonaws.inspector2#UUID", + "traits": { + "smithy.api#documentation": "

A unique identifier for the scan job.

", + "smithy.api#required": {} + } + }, + "sessionToken": { + "target": "com.amazonaws.inspector2#UUID", + "traits": { + "smithy.api#documentation": "

The unique token that identifies the CIS session.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "com.amazonaws.inspector2#StopCisSessionMessage", + "traits": { + "smithy.api#documentation": "

The stop CIS session message.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.inspector2#StopCisSessionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.inspector2#StopCisSessionStatus": { + "type": "enum", + "members": { + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "INTERRUPTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERRUPTED" + } + }, + "UNSUPPORTED_OS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSUPPORTED_OS" + } + } + } + }, + "com.amazonaws.inspector2#StringComparison": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EQUALS", + "name": "EQUALS" + }, + { + "value": "PREFIX", + "name": "PREFIX" + }, + { + "value": "NOT_EQUALS", + "name": "NOT_EQUALS" + } + ] + } + }, + "com.amazonaws.inspector2#StringFilter": { + "type": "structure", + "members": { + "comparison": { + "target": "com.amazonaws.inspector2#StringComparison", + "traits": { + "smithy.api#documentation": "

The operator to use when comparing values in the filter.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.inspector2#StringInput", + "traits": { + "smithy.api#documentation": "

The value to filter on.

", + "smithy.api#required": {} + } } - } }, - "output": { - "scanConfigurationArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-configuration/624b746d-e080-44ae-8c1d-48e653365a38" - } - } - ], - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/cis/scan-configuration/create" - } - } - }, - "com.amazonaws.inspector2#CreateCisScanConfigurationRequest": { - "type": "structure", - "members": { - "scanName": { - "target": "com.amazonaws.inspector2#CisScanName", - "traits": { - "smithy.api#documentation": "

The scan name for the CIS scan configuration.

", - "smithy.api#required": {} - } - }, - "securityLevel": { - "target": "com.amazonaws.inspector2#CisSecurityLevel", - "traits": { - "smithy.api#documentation": "

\n The security level for the CIS scan configuration. \n Security level refers to the Benchmark levels that CIS assigns to a profile.\n

", - "smithy.api#required": {} - } - }, - "schedule": { - "target": "com.amazonaws.inspector2#Schedule", - "traits": { - "smithy.api#documentation": "

The schedule for the CIS scan configuration.

", - "smithy.api#required": {} - } - }, - "targets": { - "target": "com.amazonaws.inspector2#CreateCisTargets", - "traits": { - "smithy.api#documentation": "

The targets for the CIS scan configuration.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.inspector2#CisTagMap", - "traits": { - "smithy.api#documentation": "

The tags for the CIS scan configuration.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#CreateCisScanConfigurationResponse": { - "type": "structure", - "members": { - "scanConfigurationArn": { - "target": "com.amazonaws.inspector2#CisScanConfigurationArn", - "traits": { - "smithy.api#documentation": "

The scan configuration ARN for the CIS scan configuration.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#CreateCisTargets": { - "type": "structure", - "members": { - "accountIds": { - "target": "com.amazonaws.inspector2#TargetAccountList", - "traits": { - "smithy.api#documentation": "

The CIS target account ids.

", - "smithy.api#required": {} - } - }, - "targetResourceTags": { - "target": "com.amazonaws.inspector2#TargetResourceTags", - "traits": { - "smithy.api#documentation": "

The CIS target resource tags.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Creates CIS targets.

" - } - }, - "com.amazonaws.inspector2#CreateFilter": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#CreateFilterRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#CreateFilterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#BadRequestException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a filter resource using specified filter criteria. When the filter action is set to SUPPRESS this action creates a suppression rule.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/filters/create" - } - } - }, - "com.amazonaws.inspector2#CreateFilterRequest": { - "type": "structure", - "members": { - "action": { - "target": "com.amazonaws.inspector2#FilterAction", - "traits": { - "smithy.api#documentation": "

Defines the action that is to be applied to the findings that match the filter.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.inspector2#FilterDescription", - "traits": { - "smithy.api#documentation": "

A description of the filter.

" - } - }, - "filterCriteria": { - "target": "com.amazonaws.inspector2#FilterCriteria", - "traits": { - "smithy.api#documentation": "

Defines the criteria to be used in the filter for querying findings.

", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.inspector2#FilterName", - "traits": { - "smithy.api#documentation": "

The name of the filter. Minimum length of 3. Maximum length of 64. Valid characters\n include alphanumeric characters, dot (.), underscore (_), and dash (-). Spaces are not\n allowed.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.inspector2#TagMap", - "traits": { - "smithy.api#documentation": "

A list of tags for the filter.

" - } - }, - "reason": { - "target": "com.amazonaws.inspector2#FilterReason", - "traits": { - "smithy.api#documentation": "

The reason for creating the filter.

" - } - } - } - }, - "com.amazonaws.inspector2#CreateFilterResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.inspector2#FilterArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the successfully created filter.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.inspector2#CreateFindingsReport": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#CreateFindingsReportRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#CreateFindingsReportResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a finding report. By default only ACTIVE findings are returned in the report. To see SUPRESSED or CLOSED findings you must specify a value for the findingStatus filter criteria.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/reporting/create" - } - } - }, - "com.amazonaws.inspector2#CreateFindingsReportRequest": { - "type": "structure", - "members": { - "filterCriteria": { - "target": "com.amazonaws.inspector2#FilterCriteria", - "traits": { - "smithy.api#documentation": "

The filter criteria to apply to the results of the finding report.

" - } - }, - "reportFormat": { - "target": "com.amazonaws.inspector2#ReportFormat", - "traits": { - "smithy.api#documentation": "

The format to generate the report in.

", - "smithy.api#required": {} - } - }, - "s3Destination": { - "target": "com.amazonaws.inspector2#Destination", - "traits": { - "smithy.api#documentation": "

The Amazon S3 export destination for the report.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.inspector2#CreateFindingsReportResponse": { - "type": "structure", - "members": { - "reportId": { - "target": "com.amazonaws.inspector2#ReportId", - "traits": { - "smithy.api#documentation": "

The ID of the report.

" - } - } - } - }, - "com.amazonaws.inspector2#CreateSbomExport": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#CreateSbomExportRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#CreateSbomExportResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a software bill of materials (SBOM) report.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/sbomexport/create" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.inspector2#CreateSbomExportRequest": { - "type": "structure", - "members": { - "resourceFilterCriteria": { - "target": "com.amazonaws.inspector2#ResourceFilterCriteria", - "traits": { - "smithy.api#documentation": "

The resource filter criteria for the software bill of materials (SBOM) report.

" - } - }, - "reportFormat": { - "target": "com.amazonaws.inspector2#SbomReportFormat", - "traits": { - "smithy.api#documentation": "

The output format for the software bill of materials (SBOM) report.

", - "smithy.api#required": {} - } - }, - "s3Destination": { - "target": "com.amazonaws.inspector2#Destination", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#CreateSbomExportResponse": { - "type": "structure", - "members": { - "reportId": { - "target": "com.amazonaws.inspector2#ReportId", - "traits": { - "smithy.api#documentation": "

The report ID for the software bill of materials (SBOM) report.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#Currency": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "USD", - "value": "USD" - } - ] - } - }, - "com.amazonaws.inspector2#Cvss2": { - "type": "structure", - "members": { - "baseScore": { - "target": "com.amazonaws.inspector2#Cvss2BaseScore", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The CVSS v2 base score for the vulnerability.

" - } - }, - "scoringVector": { - "target": "com.amazonaws.inspector2#Cvss2ScoringVector", - "traits": { - "smithy.api#documentation": "

The scoring vector associated with the CVSS v2 score.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Common Vulnerability Scoring System (CVSS) version 2 details for the vulnerability.

" - } - }, - "com.amazonaws.inspector2#Cvss2BaseScore": { - "type": "double", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.inspector2#Cvss2ScoringVector": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0 - } - } - }, - "com.amazonaws.inspector2#Cvss3": { - "type": "structure", - "members": { - "baseScore": { - "target": "com.amazonaws.inspector2#Cvss3BaseScore", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The CVSS v3 base score for the vulnerability.

" - } - }, - "scoringVector": { - "target": "com.amazonaws.inspector2#Cvss3ScoringVector", - "traits": { - "smithy.api#documentation": "

The scoring vector associated with the CVSS v3 score.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Common Vulnerability Scoring System (CVSS) version 3 details for the vulnerability.

" - } - }, - "com.amazonaws.inspector2#Cvss3BaseScore": { - "type": "double", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.inspector2#Cvss3ScoringVector": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0 - } - } - }, - "com.amazonaws.inspector2#CvssScore": { - "type": "structure", - "members": { - "baseScore": { - "target": "smithy.api#Double", - "traits": { - "smithy.api#documentation": "

The base CVSS score used for the finding.

", - "smithy.api#required": {} - } - }, - "scoringVector": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The vector string of the CVSS score.

", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The version of CVSS used for the score.

", - "smithy.api#required": {} - } - }, - "source": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The source of the CVSS score.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The CVSS score for a finding.

" - } - }, - "com.amazonaws.inspector2#CvssScoreAdjustment": { - "type": "structure", - "members": { - "metric": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The metric used to adjust the CVSS score.

", - "smithy.api#required": {} - } - }, - "reason": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The reason the CVSS score has been adjustment.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Details on adjustments Amazon Inspector made to the CVSS score for a finding.

" - } - }, - "com.amazonaws.inspector2#CvssScoreAdjustmentList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CvssScoreAdjustment" - } - }, - "com.amazonaws.inspector2#CvssScoreDetails": { - "type": "structure", - "members": { - "scoreSource": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The source for the CVSS score.

", - "smithy.api#required": {} - } - }, - "cvssSource": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The source of the CVSS data.

" - } - }, - "version": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The CVSS version used in scoring.

", - "smithy.api#required": {} - } - }, - "score": { - "target": "smithy.api#Double", - "traits": { - "smithy.api#documentation": "

The CVSS score.

", - "smithy.api#required": {} - } - }, - "scoringVector": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The vector for the CVSS score.

", - "smithy.api#required": {} - } - }, - "adjustments": { - "target": "com.amazonaws.inspector2#CvssScoreAdjustmentList", - "traits": { - "smithy.api#documentation": "

An object that contains details about adjustment Amazon Inspector made to the CVSS score.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the CVSS score.

" - } - }, - "com.amazonaws.inspector2#CvssScoreList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CvssScore" - } - }, - "com.amazonaws.inspector2#Cwe": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0 - } - } - }, - "com.amazonaws.inspector2#CweList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#NonEmptyString" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#Cwes": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#Cwe" - }, - "traits": { - "smithy.api#length": { - "min": 0 - } - } - }, - "com.amazonaws.inspector2#DailySchedule": { - "type": "structure", - "members": { - "startTime": { - "target": "com.amazonaws.inspector2#Time", - "traits": { - "smithy.api#documentation": "

The schedule start time.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A daily schedule.

" - } - }, - "com.amazonaws.inspector2#DateFilter": { - "type": "structure", - "members": { - "startInclusive": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

A timestamp representing the start of the time period filtered on.

" - } - }, - "endInclusive": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

A timestamp representing the end of the time period filtered on.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details on the time range used to filter findings.

" - } - }, - "com.amazonaws.inspector2#DateFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#DateFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#DateTimeTimestamp": { - "type": "timestamp" - }, - "com.amazonaws.inspector2#Day": { - "type": "enum", - "members": { - "SUN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUN" - } - }, - "MON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MON" - } - }, - "TUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TUE" - } - }, - "WED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WED" - } - }, - "THU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THU" - } - }, - "FRI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FRI" - } - }, - "SAT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SAT" - } - } - } - }, - "com.amazonaws.inspector2#DaysList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#Day" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 7 - }, - "smithy.api#uniqueItems": {} - } - }, - "com.amazonaws.inspector2#DelegatedAdmin": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the Amazon Inspector delegated administrator for your organization.

" - } - }, - "relationshipStatus": { - "target": "com.amazonaws.inspector2#RelationshipStatus", - "traits": { - "smithy.api#documentation": "

The status of the Amazon Inspector delegated administrator.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details of the Amazon Inspector delegated administrator for your organization.

" - } - }, - "com.amazonaws.inspector2#DelegatedAdminAccount": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the Amazon Inspector delegated administrator for your organization.

" - } - }, - "status": { - "target": "com.amazonaws.inspector2#DelegatedAdminStatus", - "traits": { - "smithy.api#documentation": "

The status of the Amazon Inspector delegated administrator.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details of the Amazon Inspector delegated administrator for your organization.

" - } - }, - "com.amazonaws.inspector2#DelegatedAdminAccountList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#DelegatedAdminAccount" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.inspector2#DelegatedAdminStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ENABLED", - "name": "ENABLED" - }, - { - "value": "DISABLE_IN_PROGRESS", - "name": "DISABLE_IN_PROGRESS" - } - ] - } - }, - "com.amazonaws.inspector2#DeleteCisScanConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#DeleteCisScanConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#DeleteCisScanConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a CIS scan configuration.

", - "smithy.api#examples": [ - { - "title": "Sample DeleteCisScanConfiguration Call", + "traits": { + "smithy.api#documentation": "

An object that describes the details of a string filter.

" + } + }, + "com.amazonaws.inspector2#StringFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#StringFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#StringInput": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#NonEmptyString" + } + }, + "com.amazonaws.inspector2#SubnetId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^subnet-([a-z0-9]{8}|[a-z0-9]{17}|\\*)$" + } + }, + "com.amazonaws.inspector2#SubnetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#SubnetId" + }, + "traits": { + "smithy.api#length": { + "max": 16 + } + } + }, + "com.amazonaws.inspector2#SuggestedFix": { + "type": "structure", + "members": { + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The fix's description.

", + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The fix's code.

", + "smithy.api#length": { + "min": 1, + "max": 2500 + } + } + } + }, + "traits": { + "smithy.api#documentation": "

A suggested fix for a vulnerability in your Lambda function code.

" + } + }, + "com.amazonaws.inspector2#SuggestedFixes": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#SuggestedFix" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.inspector2#TagComparison": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + } + } + }, + "com.amazonaws.inspector2#TagFilter": { + "type": "structure", + "members": { + "comparison": { + "target": "com.amazonaws.inspector2#TagComparison", + "traits": { + "smithy.api#documentation": "

The tag filter comparison value.

", + "smithy.api#required": {} + } + }, + "key": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The tag filter key.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The tag filter value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The tag filter.

" + } + }, + "com.amazonaws.inspector2#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + } + }, + "com.amazonaws.inspector2#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.inspector2#TagList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.inspector2#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.inspector2#MapKey" + }, + "value": { + "target": "com.amazonaws.inspector2#MapValue" + } + }, + "com.amazonaws.inspector2#TagResource": { + "type": "operation", "input": { - "scanConfigurationArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-configuration/624b746d-e080-44ae-8c1d-48e653365a38" + "target": "com.amazonaws.inspector2#TagResourceRequest" }, "output": { - "scanConfigurationArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-configuration/624b746d-e080-44ae-8c1d-48e653365a38" - } - } - ], - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/cis/scan-configuration/delete" - } - } - }, - "com.amazonaws.inspector2#DeleteCisScanConfigurationRequest": { - "type": "structure", - "members": { - "scanConfigurationArn": { - "target": "com.amazonaws.inspector2#CisScanConfigurationArn", - "traits": { - "smithy.api#documentation": "

The ARN of the CIS scan configuration.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#DeleteCisScanConfigurationResponse": { - "type": "structure", - "members": { - "scanConfigurationArn": { - "target": "com.amazonaws.inspector2#CisScanConfigurationArn", - "traits": { - "smithy.api#documentation": "

The ARN of the CIS scan configuration.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#DeleteFilter": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#DeleteFilterRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#DeleteFilterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a filter resource.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/filters/delete" - } - } - }, - "com.amazonaws.inspector2#DeleteFilterRequest": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.inspector2#FilterArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the filter to be deleted.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.inspector2#DeleteFilterResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.inspector2#FilterArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the filter that has been deleted.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.inspector2#DescribeOrganizationConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#DescribeOrganizationConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#DescribeOrganizationConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describe Amazon Inspector configuration settings for an Amazon Web Services organization.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/organizationconfiguration/describe" - } - } - }, - "com.amazonaws.inspector2#DescribeOrganizationConfigurationRequest": { - "type": "structure", - "members": {} - }, - "com.amazonaws.inspector2#DescribeOrganizationConfigurationResponse": { - "type": "structure", - "members": { - "autoEnable": { - "target": "com.amazonaws.inspector2#AutoEnable", - "traits": { - "smithy.api#documentation": "

The scan types are automatically enabled for new members of your organization.

" - } - }, - "maxAccountLimitReached": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Represents whether your organization has reached the maximum Amazon Web Services account limit for Amazon Inspector.

" - } - } - } - }, - "com.amazonaws.inspector2#Destination": { - "type": "structure", - "members": { - "bucketName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket to export findings to.

", - "smithy.api#required": {} - } - }, - "keyPrefix": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The prefix that the findings will be written under.

" - } - }, - "kmsKeyArn": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The ARN of the KMS key used to encrypt data when exporting findings.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details of the Amazon S3 bucket and KMS key used to export findings.

" - } - }, - "com.amazonaws.inspector2#DetectionPlatforms": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#NonEmptyString" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.inspector2#DetectorTagList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#NonEmptyString" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#Disable": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#DisableRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#DisableResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Disables Amazon Inspector scans for one or more Amazon Web Services accounts. Disabling all scan types in an account\n disables the Amazon Inspector service.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/disable" - } - } - }, - "com.amazonaws.inspector2#DisableDelegatedAdminAccount": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#DisableDelegatedAdminAccountRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#DisableDelegatedAdminAccountResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#ConflictException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Disables the Amazon Inspector delegated administrator for your organization.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/delegatedadminaccounts/disable" - } - } - }, - "com.amazonaws.inspector2#DisableDelegatedAdminAccountRequest": { - "type": "structure", - "members": { - "delegatedAdminAccountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the current Amazon Inspector delegated administrator.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.inspector2#DisableDelegatedAdminAccountResponse": { - "type": "structure", - "members": { - "delegatedAdminAccountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the successfully disabled delegated administrator.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.inspector2#DisableRequest": { - "type": "structure", - "members": { - "accountIds": { - "target": "com.amazonaws.inspector2#AccountIdSet", - "traits": { - "smithy.api#documentation": "

An array of account IDs you want to disable Amazon Inspector scans for.

" - } - }, - "resourceTypes": { - "target": "com.amazonaws.inspector2#DisableResourceTypeList", - "traits": { - "smithy.api#documentation": "

The resource scan types you want to disable.

" - } - } - } - }, - "com.amazonaws.inspector2#DisableResourceTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#ResourceScanType" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 3 - } - } - }, - "com.amazonaws.inspector2#DisableResponse": { - "type": "structure", - "members": { - "accounts": { - "target": "com.amazonaws.inspector2#AccountList", - "traits": { - "smithy.api#documentation": "

Information on the accounts that have had Amazon Inspector scans successfully disabled. Details are\n provided for each account.

", - "smithy.api#required": {} - } - }, - "failedAccounts": { - "target": "com.amazonaws.inspector2#FailedAccountList", - "traits": { - "smithy.api#documentation": "

Information on any accounts for which Amazon Inspector scans could not be disabled. Details are\n provided for each account.

" - } - } - } - }, - "com.amazonaws.inspector2#DisassociateMember": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#DisassociateMemberRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#DisassociateMemberResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Disassociates a member account from an Amazon Inspector delegated administrator.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/members/disassociate" - } - } - }, - "com.amazonaws.inspector2#DisassociateMemberRequest": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the member account to disassociate.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.inspector2#DisassociateMemberResponse": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the successfully disassociated member.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.inspector2#Ec2Configuration": { - "type": "structure", - "members": { - "scanMode": { - "target": "com.amazonaws.inspector2#Ec2ScanMode", - "traits": { - "smithy.api#documentation": "

The scan method that is applied to the instance.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Enables agent-based scanning, which scans instances that are not managed by SSM.

" - } - }, - "com.amazonaws.inspector2#Ec2ConfigurationState": { - "type": "structure", - "members": { - "scanModeState": { - "target": "com.amazonaws.inspector2#Ec2ScanModeState", - "traits": { - "smithy.api#documentation": "

An object that contains details about the state of the Amazon EC2 scan mode.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the state of the EC2 scan configuration for your environment.

" - } - }, - "com.amazonaws.inspector2#Ec2DeepInspectionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACTIVATED", - "name": "ACTIVATED" - }, - { - "value": "DEACTIVATED", - "name": "DEACTIVATED" - }, - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "FAILED", - "name": "FAILED" - } - ] - } - }, - "com.amazonaws.inspector2#Ec2InstanceAggregation": { - "type": "structure", - "members": { - "amis": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The AMI IDs associated with the Amazon EC2 instances to aggregate findings for.

" - } - }, - "operatingSystems": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The operating system types to aggregate findings for. Valid values must be uppercase and\n underscore separated, examples are ORACLE_LINUX_7 and\n ALPINE_LINUX_3_8.

" - } - }, - "instanceIds": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The Amazon EC2 instance IDs to aggregate findings for.

" - } - }, - "instanceTags": { - "target": "com.amazonaws.inspector2#MapFilterList", - "traits": { - "smithy.api#documentation": "

The Amazon EC2 instance tags to aggregate findings for.

" - } - }, - "sortOrder": { - "target": "com.amazonaws.inspector2#SortOrder", - "traits": { - "smithy.api#documentation": "

The order to sort results by.

" - } - }, - "sortBy": { - "target": "com.amazonaws.inspector2#Ec2InstanceSortBy", - "traits": { - "smithy.api#documentation": "

The value to sort results by.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The details that define an aggregation based on Amazon EC2 instances.

" - } - }, - "com.amazonaws.inspector2#Ec2InstanceAggregationResponse": { - "type": "structure", - "members": { - "instanceId": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon EC2 instance ID.

", - "smithy.api#required": {} - } - }, - "ami": { - "target": "com.amazonaws.inspector2#AmiId", - "traits": { - "smithy.api#documentation": "

The Amazon Machine Image (AMI) of the Amazon EC2 instance.

" - } - }, - "operatingSystem": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The operating system of the Amazon EC2 instance.

" - } - }, - "instanceTags": { - "target": "com.amazonaws.inspector2#TagMap", - "traits": { - "smithy.api#documentation": "

The tags attached to the instance.

" - } - }, - "accountId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account for the Amazon EC2 instance.

" - } - }, - "severityCounts": { - "target": "com.amazonaws.inspector2#SeverityCounts", - "traits": { - "smithy.api#documentation": "

An object that contains the count of matched findings per severity.

" - } - }, - "networkFindings": { - "target": "smithy.api#Long", - "traits": { - "smithy.api#documentation": "

The number of network findings for the Amazon EC2 instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A response that contains the results of a finding aggregation by Amazon EC2 instance.

" - } - }, - "com.amazonaws.inspector2#Ec2InstanceSortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NETWORK_FINDINGS", - "name": "NETWORK_FINDINGS" - }, - { - "value": "CRITICAL", - "name": "CRITICAL" - }, - { - "value": "HIGH", - "name": "HIGH" - }, - { - "value": "ALL", - "name": "ALL" - } - ] - } - }, - "com.amazonaws.inspector2#Ec2Metadata": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.inspector2#TagMap", - "traits": { - "smithy.api#documentation": "

The tags attached to the instance.

" - } - }, - "amiId": { - "target": "com.amazonaws.inspector2#AmiId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Machine Image (AMI) used to launch the instance.

" - } - }, - "platform": { - "target": "com.amazonaws.inspector2#Ec2Platform", - "traits": { - "smithy.api#documentation": "

The platform of the instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Meta data details of an Amazon EC2 instance.

" - } - }, - "com.amazonaws.inspector2#Ec2Platform": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "WINDOWS", - "name": "WINDOWS" - }, - { - "value": "LINUX", - "name": "LINUX" - }, - { - "value": "UNKNOWN", - "name": "UNKNOWN" - }, - { - "value": "MACOS", - "name": "MACOS" - } - ] - } - }, - "com.amazonaws.inspector2#Ec2ScanMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EC2_SSM_AGENT_BASED", - "name": "EC2_SSM_AGENT_BASED" - }, - { - "value": "EC2_HYBRID", - "name": "EC2_HYBRID" - } - ] - } - }, - "com.amazonaws.inspector2#Ec2ScanModeState": { - "type": "structure", - "members": { - "scanMode": { - "target": "com.amazonaws.inspector2#Ec2ScanMode", - "traits": { - "smithy.api#documentation": "

The scan method that is applied to the instance.

" - } - }, - "scanModeStatus": { - "target": "com.amazonaws.inspector2#Ec2ScanModeStatus", - "traits": { - "smithy.api#documentation": "

The status of the Amazon EC2 scan mode setting.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The state of your Amazon EC2 scan mode configuration.

" - } - }, - "com.amazonaws.inspector2#Ec2ScanModeStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SUCCESS", - "name": "SUCCESS" - }, - { - "value": "PENDING", - "name": "PENDING" - } - ] - } - }, - "com.amazonaws.inspector2#EcrConfiguration": { - "type": "structure", - "members": { - "rescanDuration": { - "target": "com.amazonaws.inspector2#EcrRescanDuration", - "traits": { - "smithy.api#documentation": "

The rescan duration configured for image push date.

", - "smithy.api#required": {} - } - }, - "pullDateRescanDuration": { - "target": "com.amazonaws.inspector2#EcrPullDateRescanDuration", - "traits": { - "smithy.api#documentation": "

The rescan duration configured for image pull date.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the ECR automated re-scan duration setting for your environment.

" - } - }, - "com.amazonaws.inspector2#EcrConfigurationState": { - "type": "structure", - "members": { - "rescanDurationState": { - "target": "com.amazonaws.inspector2#EcrRescanDurationState", - "traits": { - "smithy.api#documentation": "

An object that contains details about the state of the ECR re-scan settings.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the state of the ECR scans for your environment.

" - } - }, - "com.amazonaws.inspector2#EcrContainerImageMetadata": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.inspector2#TagList", - "traits": { - "smithy.api#documentation": "

Tags associated with the Amazon ECR image metadata.

" - } - }, - "imagePulledAt": { - "target": "com.amazonaws.inspector2#DateTimeTimestamp", - "traits": { - "smithy.api#documentation": "

The date an image was last pulled at.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information on the Amazon ECR image metadata associated with a finding.

" - } - }, - "com.amazonaws.inspector2#EcrPullDateRescanDuration": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "DAYS_14", - "name": "DAYS_14" - }, - { - "value": "DAYS_30", - "name": "DAYS_30" - }, - { - "value": "DAYS_60", - "name": "DAYS_60" - }, - { - "value": "DAYS_90", - "name": "DAYS_90" - }, - { - "value": "DAYS_180", - "name": "DAYS_180" - } - ] - } - }, - "com.amazonaws.inspector2#EcrRepositoryMetadata": { - "type": "structure", - "members": { - "name": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The name of the Amazon ECR repository.

" - } - }, - "scanFrequency": { - "target": "com.amazonaws.inspector2#EcrScanFrequency", - "traits": { - "smithy.api#documentation": "

The frequency of scans.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information on the Amazon ECR repository metadata associated with a finding.

" - } - }, - "com.amazonaws.inspector2#EcrRescanDuration": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LIFETIME", - "name": "LIFETIME" - }, - { - "value": "DAYS_30", - "name": "DAYS_30" - }, - { - "value": "DAYS_180", - "name": "DAYS_180" - }, - { - "value": "DAYS_14", - "name": "DAYS_14" - }, - { - "value": "DAYS_60", - "name": "DAYS_60" - }, - { - "value": "DAYS_90", - "name": "DAYS_90" - } - ] - } - }, - "com.amazonaws.inspector2#EcrRescanDurationState": { - "type": "structure", - "members": { - "rescanDuration": { - "target": "com.amazonaws.inspector2#EcrRescanDuration", - "traits": { - "smithy.api#documentation": "

The rescan duration configured for image push date.\n \n

" - } - }, - "status": { - "target": "com.amazonaws.inspector2#EcrRescanDurationStatus", - "traits": { - "smithy.api#documentation": "

The status of changes to the ECR automated re-scan duration.

" - } - }, - "updatedAt": { - "target": "com.amazonaws.inspector2#DateTimeTimestamp", - "traits": { - "smithy.api#documentation": "

A timestamp representing when the last time the ECR scan duration setting was changed.

" - } - }, - "pullDateRescanDuration": { - "target": "com.amazonaws.inspector2#EcrPullDateRescanDuration", - "traits": { - "smithy.api#documentation": "

The rescan duration configured for image pull date.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the state of your ECR re-scan duration settings. The ECR re-scan duration defines how long an ECR image will be actively scanned by Amazon Inspector. When the number of days since an image was last pushed exceeds the duration configured for image pull date, and the duration configured for image pull date, the monitoring state of that image becomes inactive and all associated findings are scheduled for closure.

" - } - }, - "com.amazonaws.inspector2#EcrRescanDurationStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SUCCESS", - "name": "SUCCESS" - }, - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "FAILED", - "name": "FAILED" - } - ] - } - }, - "com.amazonaws.inspector2#EcrScanFrequency": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "MANUAL", - "name": "MANUAL" - }, - { - "value": "SCAN_ON_PUSH", - "name": "SCAN_ON_PUSH" - }, - { - "value": "CONTINUOUS_SCAN", - "name": "CONTINUOUS_SCAN" - } - ] - } - }, - "com.amazonaws.inspector2#Enable": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#EnableRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#EnableResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Enables Amazon Inspector scans for one or more Amazon Web Services accounts.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/enable" - } - } - }, - "com.amazonaws.inspector2#EnableDelegatedAdminAccount": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#EnableDelegatedAdminAccountRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#EnableDelegatedAdminAccountResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#ConflictException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Enables the Amazon Inspector delegated administrator for your Organizations organization.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/delegatedadminaccounts/enable" - } - } - }, - "com.amazonaws.inspector2#EnableDelegatedAdminAccountRequest": { - "type": "structure", - "members": { - "delegatedAdminAccountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the Amazon Inspector delegated administrator.

", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.inspector2#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token for the request.

", - "smithy.api#idempotencyToken": {} - } - } - } - }, - "com.amazonaws.inspector2#EnableDelegatedAdminAccountResponse": { - "type": "structure", - "members": { - "delegatedAdminAccountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the successfully Amazon Inspector delegated administrator.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.inspector2#EnableRequest": { - "type": "structure", - "members": { - "accountIds": { - "target": "com.amazonaws.inspector2#AccountIdSet", - "traits": { - "smithy.api#documentation": "

A list of account IDs you want to enable Amazon Inspector scans for.

" - } - }, - "resourceTypes": { - "target": "com.amazonaws.inspector2#EnableResourceTypeList", - "traits": { - "smithy.api#documentation": "

The resource scan types you want to enable.

", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.inspector2#ClientToken", - "traits": { - "smithy.api#documentation": "

The idempotency token for the request.

", - "smithy.api#idempotencyToken": {} - } - } - } - }, - "com.amazonaws.inspector2#EnableResourceTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#ResourceScanType" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 3 - } - } - }, - "com.amazonaws.inspector2#EnableResponse": { - "type": "structure", - "members": { - "accounts": { - "target": "com.amazonaws.inspector2#AccountList", - "traits": { - "smithy.api#documentation": "

Information on the accounts that have had Amazon Inspector scans successfully enabled. Details are\n provided for each account.

", - "smithy.api#required": {} - } - }, - "failedAccounts": { - "target": "com.amazonaws.inspector2#FailedAccountList", - "traits": { - "smithy.api#documentation": "

Information on any accounts for which Amazon Inspector scans could not be enabled. Details are\n provided for each account.

" - } - } - } - }, - "com.amazonaws.inspector2#Epss": { - "type": "structure", - "members": { - "score": { - "target": "com.amazonaws.inspector2#EpssScore", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The Exploit Prediction Scoring System (EPSS) score.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the Exploit Prediction Scoring System (EPSS) score.

" - } - }, - "com.amazonaws.inspector2#EpssDetails": { - "type": "structure", - "members": { - "score": { - "target": "com.amazonaws.inspector2#EpssScoreValue", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The EPSS score.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the Exploit Prediction Scoring System (EPSS) score for a finding.

" - } - }, - "com.amazonaws.inspector2#EpssScore": { - "type": "double", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.inspector2#EpssScoreValue": { - "type": "double", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0.0, - "max": 1.0 - } - } - }, - "com.amazonaws.inspector2#ErrorCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ALREADY_ENABLED", - "name": "ALREADY_ENABLED" - }, - { - "value": "ENABLE_IN_PROGRESS", - "name": "ENABLE_IN_PROGRESS" - }, - { - "value": "DISABLE_IN_PROGRESS", - "name": "DISABLE_IN_PROGRESS" - }, - { - "value": "SUSPEND_IN_PROGRESS", - "name": "SUSPEND_IN_PROGRESS" - }, - { - "value": "RESOURCE_NOT_FOUND", - "name": "RESOURCE_NOT_FOUND" - }, - { - "value": "ACCESS_DENIED", - "name": "ACCESS_DENIED" - }, - { - "value": "INTERNAL_ERROR", - "name": "INTERNAL_ERROR" - }, - { - "value": "SSM_UNAVAILABLE", - "name": "SSM_UNAVAILABLE" - }, - { - "value": "SSM_THROTTLED", - "name": "SSM_THROTTLED" - }, - { - "value": "EVENTBRIDGE_UNAVAILABLE", - "name": "EVENTBRIDGE_UNAVAILABLE" - }, - { - "value": "EVENTBRIDGE_THROTTLED", - "name": "EVENTBRIDGE_THROTTLED" - }, - { - "value": "RESOURCE_SCAN_NOT_DISABLED", - "name": "RESOURCE_SCAN_NOT_DISABLED" - }, - { - "value": "DISASSOCIATE_ALL_MEMBERS", - "name": "DISASSOCIATE_ALL_MEMBERS" - }, - { - "value": "ACCOUNT_IS_ISOLATED", - "name": "ACCOUNT_IS_ISOLATED" - } - ] - } - }, - "com.amazonaws.inspector2#ErrorMessage": { - "type": "string" - }, - "com.amazonaws.inspector2#Evidence": { - "type": "structure", - "members": { - "evidenceRule": { - "target": "com.amazonaws.inspector2#EvidenceRule", - "traits": { - "smithy.api#documentation": "

The evidence rule.

" - } - }, - "evidenceDetail": { - "target": "com.amazonaws.inspector2#EvidenceDetail", - "traits": { - "smithy.api#documentation": "

The evidence details.

" - } - }, - "severity": { - "target": "com.amazonaws.inspector2#EvidenceSeverity", - "traits": { - "smithy.api#documentation": "

The evidence severity.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details of the evidence for a vulnerability identified in a finding.

" - } - }, - "com.amazonaws.inspector2#EvidenceDetail": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0 - } - } - }, - "com.amazonaws.inspector2#EvidenceList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#Evidence" - } - }, - "com.amazonaws.inspector2#EvidenceRule": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0 - } - } - }, - "com.amazonaws.inspector2#EvidenceSeverity": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0 - } - } - }, - "com.amazonaws.inspector2#ExecutionRoleArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" - } - }, - "com.amazonaws.inspector2#ExploitAvailable": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "YES", - "name": "YES" - }, - { - "value": "NO", - "name": "NO" - } - ] - } - }, - "com.amazonaws.inspector2#ExploitObserved": { - "type": "structure", - "members": { - "lastSeen": { - "target": "com.amazonaws.inspector2#LastSeen", - "traits": { - "smithy.api#documentation": "

The date an time when the exploit was last seen.

" - } - }, - "firstSeen": { - "target": "com.amazonaws.inspector2#FirstSeen", - "traits": { - "smithy.api#documentation": "

The date an time when the exploit was first seen.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information on when this exploit was observed.

" - } - }, - "com.amazonaws.inspector2#ExploitabilityDetails": { - "type": "structure", - "members": { - "lastKnownExploitAt": { - "target": "com.amazonaws.inspector2#DateTimeTimestamp", - "traits": { - "smithy.api#documentation": "

The date and time of the last exploit associated with a finding discovered in your environment.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The details of an exploit available for a finding discovered in your environment.

" - } - }, - "com.amazonaws.inspector2#ExternalReportStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SUCCEEDED", - "name": "SUCCEEDED" - }, - { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" - }, - { - "value": "CANCELLED", - "name": "CANCELLED" - }, - { - "value": "FAILED", - "name": "FAILED" - } - ] - } - }, - "com.amazonaws.inspector2#FailedAccount": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.inspector2#Status", - "traits": { - "smithy.api#documentation": "

The status of Amazon Inspector for the account.

" - } - }, - "resourceStatus": { - "target": "com.amazonaws.inspector2#ResourceStatus", - "traits": { - "smithy.api#documentation": "

An object detailing which resources Amazon Inspector is enabled to scan for the account.

" - } - }, - "errorCode": { - "target": "com.amazonaws.inspector2#ErrorCode", - "traits": { - "smithy.api#documentation": "

The error code explaining why the account failed to enable Amazon Inspector.

", - "smithy.api#required": {} - } - }, - "errorMessage": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The error message received when the account failed to enable Amazon Inspector.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object with details on why an account failed to enable Amazon Inspector.

" - } - }, - "com.amazonaws.inspector2#FailedAccountList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#FailedAccount" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.inspector2#FailedMemberAccountEc2DeepInspectionStatusState": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the Amazon Web Services account of the organization member that failed to activate Amazon Inspector deep inspection.

", - "smithy.api#required": {} - } - }, - "ec2ScanStatus": { - "target": "com.amazonaws.inspector2#Status", - "traits": { - "smithy.api#documentation": "

The status of EC2 scanning in the account that failed to activate Amazon Inspector deep inspection.

" - } - }, - "errorMessage": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The error message explaining why the account failed to activate Amazon Inspector deep inspection.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains details about a member account in your organization that failed to activate Amazon Inspector deep inspection.

" - } - }, - "com.amazonaws.inspector2#FailedMemberAccountEc2DeepInspectionStatusStateList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#FailedMemberAccountEc2DeepInspectionStatusState" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.inspector2#FilePath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.inspector2#Filter": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.inspector2#FilterArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) associated with this filter.

", - "smithy.api#required": {} - } - }, - "ownerId": { - "target": "com.amazonaws.inspector2#OwnerId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the account that created the filter.

", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.inspector2#FilterName", - "traits": { - "smithy.api#documentation": "

The name of the filter.

", - "smithy.api#required": {} - } - }, - "criteria": { - "target": "com.amazonaws.inspector2#FilterCriteria", - "traits": { - "smithy.api#documentation": "

Details on the filter criteria associated with this filter.

", - "smithy.api#required": {} - } - }, - "action": { - "target": "com.amazonaws.inspector2#FilterAction", - "traits": { - "smithy.api#documentation": "

The action that is to be applied to the findings that match the filter.

", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.inspector2#DateTimeTimestamp", - "traits": { - "smithy.api#documentation": "

The date and time this filter was created at.

", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.inspector2#DateTimeTimestamp", - "traits": { - "smithy.api#documentation": "

The date and time the filter was last updated at.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.inspector2#FilterDescription", - "traits": { - "smithy.api#documentation": "

A description of the filter.

" - } - }, - "reason": { - "target": "com.amazonaws.inspector2#FilterReason", - "traits": { - "smithy.api#documentation": "

The reason for the filter.

" - } - }, - "tags": { - "target": "com.amazonaws.inspector2#TagMap", - "traits": { - "smithy.api#documentation": "

The tags attached to the filter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about a filter.

" - } - }, - "com.amazonaws.inspector2#FilterAction": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NONE", - "name": "NONE" - }, - { - "value": "SUPPRESS", - "name": "SUPPRESS" - } - ] - } - }, - "com.amazonaws.inspector2#FilterArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.inspector2#FilterArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#FilterArn" - } - }, - "com.amazonaws.inspector2#FilterCriteria": { - "type": "structure", - "members": { - "findingArn": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Details on the finding ARNs used to filter findings.

" - } - }, - "awsAccountId": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Details of the Amazon Web Services account IDs used to filter findings.

" - } - }, - "findingType": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Details on the finding types used to filter findings.

" - } - }, - "severity": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Details on the severity used to filter findings.

" - } - }, - "firstObservedAt": { - "target": "com.amazonaws.inspector2#DateFilterList", - "traits": { - "smithy.api#documentation": "

Details on the date and time a finding was first seen used to filter findings.

" - } - }, - "lastObservedAt": { - "target": "com.amazonaws.inspector2#DateFilterList", - "traits": { - "smithy.api#documentation": "

Details on the date and time a finding was last seen used to filter findings.

" - } - }, - "updatedAt": { - "target": "com.amazonaws.inspector2#DateFilterList", - "traits": { - "smithy.api#documentation": "

Details on the date and time a finding was last updated at used to filter findings.

" - } - }, - "findingStatus": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Details on the finding status types used to filter findings.

" - } - }, - "title": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Details on the finding title used to filter findings.

" - } - }, - "inspectorScore": { - "target": "com.amazonaws.inspector2#NumberFilterList", - "traits": { - "smithy.api#documentation": "

The Amazon Inspector score to filter on.

" - } - }, - "resourceType": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Details on the resource types used to filter findings.

" - } - }, - "resourceId": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Details on the resource IDs used to filter findings.

" - } - }, - "resourceTags": { - "target": "com.amazonaws.inspector2#MapFilterList", - "traits": { - "smithy.api#documentation": "

Details on the resource tags used to filter findings.

" - } - }, - "ec2InstanceImageId": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Details of the Amazon EC2 instance image IDs used to filter findings.

" - } - }, - "ec2InstanceVpcId": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Details of the Amazon EC2 instance VPC IDs used to filter findings.

" - } - }, - "ec2InstanceSubnetId": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Details of the Amazon EC2 instance subnet IDs used to filter findings.

" - } - }, - "ecrImagePushedAt": { - "target": "com.amazonaws.inspector2#DateFilterList", - "traits": { - "smithy.api#documentation": "

Details on the Amazon ECR image push date and time used to filter findings.

" - } - }, - "ecrImageArchitecture": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Details of the Amazon ECR image architecture types used to filter findings.

" - } - }, - "ecrImageRegistry": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Details on the Amazon ECR registry used to filter findings.

" - } - }, - "ecrImageRepositoryName": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Details on the name of the Amazon ECR repository used to filter findings.

" - } - }, - "ecrImageTags": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The tags attached to the Amazon ECR container image.

" - } - }, - "ecrImageHash": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Details of the Amazon ECR image hashes used to filter findings.

" - } - }, - "portRange": { - "target": "com.amazonaws.inspector2#PortRangeFilterList", - "traits": { - "smithy.api#documentation": "

Details on the port ranges used to filter findings.

" - } - }, - "networkProtocol": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Details on network protocol used to filter findings.

" - } - }, - "componentId": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Details of the component IDs used to filter findings.

" - } - }, - "componentType": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Details of the component types used to filter findings.

" - } - }, - "vulnerabilityId": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Details on the vulnerability ID used to filter findings.

" - } - }, - "vulnerabilitySource": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Details on the vulnerability type used to filter findings.

" - } - }, - "vendorSeverity": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Details on the vendor severity used to filter findings.

" - } - }, - "vulnerablePackages": { - "target": "com.amazonaws.inspector2#PackageFilterList", - "traits": { - "smithy.api#documentation": "

Details on the vulnerable packages used to filter findings.

" - } - }, - "relatedVulnerabilities": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Details on the related vulnerabilities used to filter findings.

" - } - }, - "fixAvailable": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Details on whether a fix is available through a version update. This value can be YES, NO, or PARTIAL. A PARTIAL fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.

" - } - }, - "lambdaFunctionName": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Filters the list of Amazon Web Services Lambda functions by the name of the function.

" - } - }, - "lambdaFunctionLayers": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Filters the list of Amazon Web Services Lambda functions by the function's \n layers. A Lambda function can have up to five layers.

" - } - }, - "lambdaFunctionRuntime": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Filters the list of Amazon Web Services Lambda functions by the runtime environment for the Lambda function.

" - } - }, - "lambdaFunctionLastModifiedAt": { - "target": "com.amazonaws.inspector2#DateFilterList", - "traits": { - "smithy.api#documentation": "

Filters the list of Amazon Web Services Lambda functions by the date and time that a user last updated the configuration, in ISO 8601 format\n

" - } - }, - "lambdaFunctionExecutionRoleArn": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Filters the list of Amazon Web Services Lambda functions by execution role.

" - } - }, - "exploitAvailable": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Filters the list of Amazon Web Services Lambda findings by the availability of exploits.

" - } - }, - "codeVulnerabilityDetectorName": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The name of the detector used to identify a code vulnerability in a Lambda function used to filter findings.

" - } - }, - "codeVulnerabilityDetectorTags": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The detector type tag associated with the vulnerability used to filter findings. Detector tags group related vulnerabilities by common themes or tactics. For a list of available tags by programming language, see Java tags, or Python tags.

" - } - }, - "codeVulnerabilityFilePath": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The file path to the file in a Lambda function that contains a code vulnerability used to filter findings.

" - } - }, - "epssScore": { - "target": "com.amazonaws.inspector2#NumberFilterList", - "traits": { - "smithy.api#documentation": "

The EPSS score used to filter findings.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details on the criteria used to define the filter.

" - } - }, - "com.amazonaws.inspector2#FilterDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.inspector2#FilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#Filter" - } - }, - "com.amazonaws.inspector2#FilterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.inspector2#FilterReason": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.inspector2#Finding": { - "type": "structure", - "members": { - "findingArn": { - "target": "com.amazonaws.inspector2#FindingArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the finding.

", - "smithy.api#required": {} - } - }, - "awsAccountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID associated with the finding.

", - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.inspector2#FindingType", - "traits": { - "smithy.api#documentation": "

The type of the finding. The type value determines the valid values for resource in your request. For more information, see Finding types in the Amazon Inspector user guide.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.inspector2#FindingDescription", - "traits": { - "smithy.api#documentation": "

The description of the finding.

", - "smithy.api#required": {} - } - }, - "title": { - "target": "com.amazonaws.inspector2#FindingTitle", - "traits": { - "smithy.api#documentation": "

The title of the finding.

" - } - }, - "remediation": { - "target": "com.amazonaws.inspector2#Remediation", - "traits": { - "smithy.api#documentation": "

An object that contains the details about how to remediate a finding.

", - "smithy.api#required": {} - } - }, - "severity": { - "target": "com.amazonaws.inspector2#Severity", - "traits": { - "smithy.api#documentation": "

The severity of the finding. UNTRIAGED applies to PACKAGE_VULNERABILITY type findings that the vendor has not assigned a severity yet. For more information, see Severity levels for findings in the Amazon Inspector user guide.

", - "smithy.api#required": {} - } - }, - "firstObservedAt": { - "target": "com.amazonaws.inspector2#DateTimeTimestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the finding was first observed.

", - "smithy.api#required": {} - } - }, - "lastObservedAt": { - "target": "com.amazonaws.inspector2#DateTimeTimestamp", - "traits": { - "smithy.api#documentation": "

\n The date and time the finding was last observed. \n This timestamp for this field remains unchanged until a finding is updated.\n

", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.inspector2#DateTimeTimestamp", - "traits": { - "smithy.api#documentation": "

The date and time the finding was last updated at.

" - } - }, - "status": { - "target": "com.amazonaws.inspector2#FindingStatus", - "traits": { - "smithy.api#documentation": "

The status of the finding.

", - "smithy.api#required": {} - } - }, - "resources": { - "target": "com.amazonaws.inspector2#ResourceList", - "traits": { - "smithy.api#documentation": "

Contains information on the resources involved in a finding. The resource value determines the valid values for type in your request. For more information, see Finding types in the Amazon Inspector user guide.

", - "smithy.api#required": {} - } - }, - "inspectorScore": { - "target": "smithy.api#Double", - "traits": { - "smithy.api#documentation": "

The Amazon Inspector score given to the finding.

" - } - }, - "inspectorScoreDetails": { - "target": "com.amazonaws.inspector2#InspectorScoreDetails", - "traits": { - "smithy.api#documentation": "

An object that contains details of the Amazon Inspector score.

" - } - }, - "networkReachabilityDetails": { - "target": "com.amazonaws.inspector2#NetworkReachabilityDetails", - "traits": { - "smithy.api#documentation": "

An object that contains the details of a network reachability finding.

" - } - }, - "packageVulnerabilityDetails": { - "target": "com.amazonaws.inspector2#PackageVulnerabilityDetails", - "traits": { - "smithy.api#documentation": "

An object that contains the details of a package vulnerability finding.

" - } - }, - "fixAvailable": { - "target": "com.amazonaws.inspector2#FixAvailable", - "traits": { - "smithy.api#documentation": "

Details on whether a fix is available through a version update. This value can be YES, NO, or PARTIAL. A PARTIAL fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.

" - } - }, - "exploitAvailable": { - "target": "com.amazonaws.inspector2#ExploitAvailable", - "traits": { - "smithy.api#documentation": "

If a finding discovered in your environment has an exploit available.

" - } - }, - "exploitabilityDetails": { - "target": "com.amazonaws.inspector2#ExploitabilityDetails", - "traits": { - "smithy.api#documentation": "

The details of an exploit available for a finding discovered in your environment.

" - } - }, - "codeVulnerabilityDetails": { - "target": "com.amazonaws.inspector2#CodeVulnerabilityDetails", - "traits": { - "smithy.api#documentation": "

Details about the code vulnerability identified in a Lambda function used to filter findings.

" - } - }, - "epss": { - "target": "com.amazonaws.inspector2#EpssDetails", - "traits": { - "smithy.api#documentation": "

The finding's EPSS score.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about an Amazon Inspector finding.

" - } - }, - "com.amazonaws.inspector2#FindingArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:inspector2:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:finding/[a-f0-9]{32}$" - } - }, - "com.amazonaws.inspector2#FindingArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#FindingArn" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#FindingArns": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#FindingArn" - } - }, - "com.amazonaws.inspector2#FindingDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.inspector2#FindingDetail": { - "type": "structure", - "members": { - "findingArn": { - "target": "com.amazonaws.inspector2#FindingArn", - "traits": { - "smithy.api#documentation": "

The finding ARN that the vulnerability details are associated with.

" - } - }, - "cisaData": { - "target": "com.amazonaws.inspector2#CisaData" - }, - "riskScore": { - "target": "com.amazonaws.inspector2#RiskScore", - "traits": { - "smithy.api#documentation": "

The risk score of the vulnerability.

" - } - }, - "evidences": { - "target": "com.amazonaws.inspector2#EvidenceList", - "traits": { - "smithy.api#documentation": "

Information on the evidence of the vulnerability.

" - } - }, - "ttps": { - "target": "com.amazonaws.inspector2#Ttps", - "traits": { - "smithy.api#documentation": "

The MITRE adversary tactics, techniques, or procedures (TTPs) associated with the vulnerability.

" - } - }, - "tools": { - "target": "com.amazonaws.inspector2#Tools", - "traits": { - "smithy.api#documentation": "

The known malware tools or kits that can exploit the vulnerability.

" - } - }, - "exploitObserved": { - "target": "com.amazonaws.inspector2#ExploitObserved" - }, - "referenceUrls": { - "target": "com.amazonaws.inspector2#VulnerabilityReferenceUrls", - "traits": { - "smithy.api#documentation": "

The reference URLs for the vulnerability data.

" - } - }, - "cwes": { - "target": "com.amazonaws.inspector2#Cwes", - "traits": { - "smithy.api#documentation": "

The Common Weakness Enumerations (CWEs) associated with the vulnerability.

" - } - }, - "epssScore": { - "target": "smithy.api#Double", - "traits": { - "smithy.api#documentation": "

The Exploit Prediction Scoring System (EPSS) score of the vulnerability.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details of the vulnerability identified in a finding.

" - } - }, - "com.amazonaws.inspector2#FindingDetails": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#FindingDetail" - }, - "traits": { - "smithy.api#length": { - "min": 0 - } - } - }, - "com.amazonaws.inspector2#FindingDetailsError": { - "type": "structure", - "members": { - "findingArn": { - "target": "com.amazonaws.inspector2#FindingArn", - "traits": { - "smithy.api#documentation": "

The finding ARN that returned an error.

", - "smithy.api#required": {} - } - }, - "errorCode": { - "target": "com.amazonaws.inspector2#FindingDetailsErrorCode", - "traits": { - "smithy.api#documentation": "

The error code.

", - "smithy.api#required": {} - } - }, - "errorMessage": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The error message.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about an error encountered when trying to return vulnerability data for a finding.

" - } - }, - "com.amazonaws.inspector2#FindingDetailsErrorCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "INTERNAL_ERROR", - "name": "INTERNAL_ERROR" - }, - { - "value": "ACCESS_DENIED", - "name": "ACCESS_DENIED" - }, - { - "value": "FINDING_DETAILS_NOT_FOUND", - "name": "FINDING_DETAILS_NOT_FOUND" - }, - { - "value": "INVALID_INPUT", - "name": "INVALID_INPUT" - } - ] - } - }, - "com.amazonaws.inspector2#FindingDetailsErrorList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#FindingDetailsError" - } - }, - "com.amazonaws.inspector2#FindingList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#Finding" - }, - "traits": { - "smithy.api#length": { - "max": 25 - } - } - }, - "com.amazonaws.inspector2#FindingStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "SUPPRESSED", - "name": "SUPPRESSED" - }, - { - "value": "CLOSED", - "name": "CLOSED" - } - ] - } - }, - "com.amazonaws.inspector2#FindingTitle": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.inspector2#FindingType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NETWORK_REACHABILITY", - "name": "NETWORK_REACHABILITY" - }, - { - "value": "PACKAGE_VULNERABILITY", - "name": "PACKAGE_VULNERABILITY" - }, - { - "value": "CODE_VULNERABILITY", - "name": "CODE_VULNERABILITY" - } - ] - } - }, - "com.amazonaws.inspector2#FindingTypeAggregation": { - "type": "structure", - "members": { - "findingType": { - "target": "com.amazonaws.inspector2#AggregationFindingType", - "traits": { - "smithy.api#documentation": "

The finding type to aggregate.

" - } - }, - "resourceType": { - "target": "com.amazonaws.inspector2#AggregationResourceType", - "traits": { - "smithy.api#documentation": "

The resource type to aggregate.

" - } - }, - "sortOrder": { - "target": "com.amazonaws.inspector2#SortOrder", - "traits": { - "smithy.api#documentation": "

The order to sort results by.

" - } - }, - "sortBy": { - "target": "com.amazonaws.inspector2#FindingTypeSortBy", - "traits": { - "smithy.api#documentation": "

The value to sort results by.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The details that define an aggregation based on finding type.

" - } - }, - "com.amazonaws.inspector2#FindingTypeAggregationResponse": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account associated with the findings.

" - } - }, - "severityCounts": { - "target": "com.amazonaws.inspector2#SeverityCounts", - "traits": { - "smithy.api#documentation": "

The value to sort results by.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A response that contains the results of a finding type aggregation.

" - } - }, - "com.amazonaws.inspector2#FindingTypeSortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CRITICAL", - "name": "CRITICAL" - }, - { - "value": "HIGH", - "name": "HIGH" - }, - { - "value": "ALL", - "name": "ALL" - } - ] - } - }, - "com.amazonaws.inspector2#FirstSeen": { - "type": "timestamp" - }, - "com.amazonaws.inspector2#FixAvailable": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "YES", - "name": "YES" - }, - { - "value": "NO", - "name": "NO" - }, - { - "value": "PARTIAL", - "name": "PARTIAL" - } - ] - } - }, - "com.amazonaws.inspector2#FreeTrialAccountInfo": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.inspector2#MeteringAccountId", - "traits": { - "smithy.api#documentation": "

The account associated with the Amazon Inspector free trial information.

", - "smithy.api#required": {} - } - }, - "freeTrialInfo": { - "target": "com.amazonaws.inspector2#FreeTrialInfoList", - "traits": { - "smithy.api#documentation": "

Contains information about the Amazon Inspector free trial for an account.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the Amazon Inspector free trial for an account.

" - } - }, - "com.amazonaws.inspector2#FreeTrialAccountInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#FreeTrialAccountInfo" - } - }, - "com.amazonaws.inspector2#FreeTrialInfo": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.inspector2#FreeTrialType", - "traits": { - "smithy.api#documentation": "

The type of scan covered by the Amazon Inspector free trail.

", - "smithy.api#required": {} - } - }, - "start": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the Amazon Inspector free trail started for a given account.

", - "smithy.api#required": {} - } - }, - "end": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the Amazon Inspector free trail ends for a given account.

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.inspector2#FreeTrialStatus", - "traits": { - "smithy.api#documentation": "

The order to sort results by.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains information about the Amazon Inspector free trial for an account.

" - } - }, - "com.amazonaws.inspector2#FreeTrialInfoError": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.inspector2#MeteringAccountId", - "traits": { - "smithy.api#documentation": "

The account associated with the Amazon Inspector free trial information.

", - "smithy.api#required": {} - } - }, - "code": { - "target": "com.amazonaws.inspector2#FreeTrialInfoErrorCode", - "traits": { - "smithy.api#documentation": "

The error code.

", - "smithy.api#required": {} - } - }, - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The error message returned.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an error received while accessing free trail data for an account.

" - } - }, - "com.amazonaws.inspector2#FreeTrialInfoErrorCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "ACCESS_DENIED", - "value": "ACCESS_DENIED" - }, - { - "name": "INTERNAL_ERROR", - "value": "INTERNAL_ERROR" - } - ] - } - }, - "com.amazonaws.inspector2#FreeTrialInfoErrorList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#FreeTrialInfoError" - } - }, - "com.amazonaws.inspector2#FreeTrialInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#FreeTrialInfo" - } - }, - "com.amazonaws.inspector2#FreeTrialStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "ACTIVE", - "value": "ACTIVE" - }, - { - "name": "INACTIVE", - "value": "INACTIVE" - } - ] - } - }, - "com.amazonaws.inspector2#FreeTrialType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "EC2", - "value": "EC2" - }, - { - "name": "ECR", - "value": "ECR" - }, - { - "name": "LAMBDA", - "value": "LAMBDA" - }, - { - "name": "LAMBDA_CODE", - "value": "LAMBDA_CODE" - } - ] - } - }, - "com.amazonaws.inspector2#FunctionName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" - } - }, - "com.amazonaws.inspector2#GetCisScanReport": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#GetCisScanReportRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#GetCisScanReportResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves a CIS scan report.

", - "smithy.api#examples": [ - { - "title": "Sample GetCisScanReport Call", - "input": { - "scanArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38", - "reportFormat": "PDF" + "target": "com.amazonaws.inspector2#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#BadRequestException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds tags to a resource.

", + "smithy.api#http": { + "uri": "/tags/{resourceArn}", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.inspector2#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.inspector2#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to apply a tag to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.inspector2#TagMap", + "traits": { + "smithy.api#documentation": "

The tags to be added to a resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.inspector2#TagValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#TargetResourceTagsValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.inspector2#Target": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.inspector2#TargetAccount": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\d{12}|ALL_ACCOUNTS|SELF$" + } + }, + "com.amazonaws.inspector2#TargetAccountList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#TargetAccount" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.inspector2#TargetResourceTags": { + "type": "map", + "key": { + "target": "com.amazonaws.inspector2#TargetResourceTagsKey" + }, + "value": { + "target": "com.amazonaws.inspector2#TagValueList" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.inspector2#TargetResourceTagsKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=\\-@]*$" + } + }, + "com.amazonaws.inspector2#TargetResourceTagsValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.inspector2#TargetStatusFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisTargetStatusFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#TargetStatusReasonFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisTargetStatusReasonFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#Targets": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Target" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.inspector2#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "retryAfterSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of seconds to wait before retrying the request.

", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "

The limit on the number of requests per second was exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.inspector2#Time": { + "type": "structure", + "members": { + "timeOfDay": { + "target": "com.amazonaws.inspector2#TimeOfDay", + "traits": { + "smithy.api#documentation": "

The time of day in 24-hour format (00:00).

", + "smithy.api#required": {} + } + }, + "timezone": { + "target": "com.amazonaws.inspector2#Timezone", + "traits": { + "smithy.api#documentation": "

The timezone.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The time.

" + } + }, + "com.amazonaws.inspector2#TimeOfDay": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$" + } + }, + "com.amazonaws.inspector2#Timezone": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.inspector2#TitleAggregation": { + "type": "structure", + "members": { + "titles": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The finding titles to aggregate on.

" + } + }, + "vulnerabilityIds": { + "target": "com.amazonaws.inspector2#StringFilterList", + "traits": { + "smithy.api#documentation": "

The vulnerability IDs of the findings.

" + } + }, + "resourceType": { + "target": "com.amazonaws.inspector2#AggregationResourceType", + "traits": { + "smithy.api#documentation": "

The resource type to aggregate on.

" + } + }, + "sortOrder": { + "target": "com.amazonaws.inspector2#SortOrder", + "traits": { + "smithy.api#documentation": "

The order to sort results by.

" + } + }, + "sortBy": { + "target": "com.amazonaws.inspector2#TitleSortBy", + "traits": { + "smithy.api#documentation": "

The value to sort results by.

" + } + }, + "findingType": { + "target": "com.amazonaws.inspector2#AggregationFindingType", + "traits": { + "smithy.api#documentation": "

The type of finding to aggregate on.

" + } + } }, - "output": { - "url": "www.s3.amazon.com/abcdef", - "status": "SUCCEEDED" - } - } - ], - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/cis/scan/report/get" - } - } - }, - "com.amazonaws.inspector2#GetCisScanReportRequest": { - "type": "structure", - "members": { - "scanArn": { - "target": "com.amazonaws.inspector2#CisScanArn", - "traits": { - "smithy.api#documentation": "

The scan ARN.

", - "smithy.api#required": {} - } - }, - "targetAccounts": { - "target": "com.amazonaws.inspector2#ReportTargetAccounts", - "traits": { - "smithy.api#documentation": "

The target accounts.

" - } - }, - "reportFormat": { - "target": "com.amazonaws.inspector2#CisReportFormat", - "traits": { - "smithy.api#default": "PDF", - "smithy.api#documentation": "

\n The format of the report. \n Valid values are PDF and CSV. \n If no value is specified, the report format defaults to PDF.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#GetCisScanReportResponse": { - "type": "structure", - "members": { - "url": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

\n The URL where a PDF or CSV of the CIS scan report can be downloaded.\n

" - } - }, - "status": { - "target": "com.amazonaws.inspector2#CisReportStatus", - "traits": { - "smithy.api#documentation": "

The status.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#GetCisScanResultDetails": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#GetCisScanResultDetailsRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#GetCisScanResultDetailsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves CIS scan result details.

", - "smithy.api#examples": [ - { - "title": "Sample GetCisScanResultDetails Call", - "input": { - "scanArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38", - "targetResourceId": "i-12341234", - "accountId": "123412341234" + "traits": { + "smithy.api#documentation": "

The details that define an aggregation based on finding title.

" + } + }, + "com.amazonaws.inspector2#TitleAggregationResponse": { + "type": "structure", + "members": { + "title": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The title that the findings were aggregated on.

", + "smithy.api#required": {} + } + }, + "vulnerabilityId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The vulnerability ID of the finding.

" + } + }, + "accountId": { + "target": "com.amazonaws.inspector2#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account associated with the findings.

" + } + }, + "severityCounts": { + "target": "com.amazonaws.inspector2#SeverityCounts", + "traits": { + "smithy.api#documentation": "

An object that represent the count of matched findings per severity.

" + } + } }, - "output": { - "scanResultDetails": [ - { - "scanArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38", - "accountId": "123412341234", - "targetResourceId": "i-12341234", - "platform": "AMAZON_LINUX_2", - "status": "PASSED", - "checkId": "1.1.1.1", - "title": "title1", - "checkDescription": "description", - "remediation": "fix", - "level": "LEVEL_1" - } - ] - } - } - ], - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/cis/scan-result/details/get" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "scanResultDetails", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.inspector2#GetCisScanResultDetailsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.inspector2#GetCisScanResultDetailsRequest": { - "type": "structure", - "members": { - "scanArn": { - "target": "com.amazonaws.inspector2#CisScanArn", - "traits": { - "smithy.api#documentation": "

The scan ARN.

", - "smithy.api#required": {} - } - }, - "targetResourceId": { - "target": "com.amazonaws.inspector2#ResourceId", - "traits": { - "smithy.api#documentation": "

The target resource ID.

", - "smithy.api#required": {} - } - }, - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The account ID.

", - "smithy.api#required": {} - } - }, - "filterCriteria": { - "target": "com.amazonaws.inspector2#CisScanResultDetailsFilterCriteria", - "traits": { - "smithy.api#documentation": "

The filter criteria.

" - } - }, - "sortBy": { - "target": "com.amazonaws.inspector2#CisScanResultDetailsSortBy", - "traits": { - "smithy.api#default": "CHECK_ID", - "smithy.api#documentation": "

The sort by order.

" - } - }, - "sortOrder": { - "target": "com.amazonaws.inspector2#CisSortOrder", - "traits": { - "smithy.api#documentation": "

The sort order.

" - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token from a previous request that's used to retrieve the next page of results.

" - } - }, - "maxResults": { - "target": "com.amazonaws.inspector2#GetCisScanResultDetailsMaxResults", - "traits": { - "smithy.api#default": 300, - "smithy.api#documentation": "

The maximum number of CIS scan result details to be returned in a single page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#GetCisScanResultDetailsResponse": { - "type": "structure", - "members": { - "scanResultDetails": { - "target": "com.amazonaws.inspector2#CisScanResultDetailsList", - "traits": { - "smithy.api#documentation": "

The scan result details.

" - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token from a previous request that's used to retrieve the next page of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#GetConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#GetConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#GetConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves setting configurations for Inspector scans.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/configuration/get" - } - } - }, - "com.amazonaws.inspector2#GetConfigurationRequest": { - "type": "structure", - "members": {} - }, - "com.amazonaws.inspector2#GetConfigurationResponse": { - "type": "structure", - "members": { - "ecrConfiguration": { - "target": "com.amazonaws.inspector2#EcrConfigurationState", - "traits": { - "smithy.api#documentation": "

Specifies how the ECR automated re-scan duration is currently configured for your environment.

" - } - }, - "ec2Configuration": { - "target": "com.amazonaws.inspector2#Ec2ConfigurationState", - "traits": { - "smithy.api#documentation": "

Specifies how the Amazon EC2 automated scan mode is currently configured for your environment.

" - } - } - } - }, - "com.amazonaws.inspector2#GetDelegatedAdminAccount": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#GetDelegatedAdminAccountRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#GetDelegatedAdminAccountResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves information about the Amazon Inspector delegated administrator for your\n organization.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/delegatedadminaccounts/get" - } - } - }, - "com.amazonaws.inspector2#GetDelegatedAdminAccountRequest": { - "type": "structure", - "members": {} - }, - "com.amazonaws.inspector2#GetDelegatedAdminAccountResponse": { - "type": "structure", - "members": { - "delegatedAdmin": { - "target": "com.amazonaws.inspector2#DelegatedAdmin", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the Amazon Inspector delegated administrator.

" - } - } - } - }, - "com.amazonaws.inspector2#GetEc2DeepInspectionConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#GetEc2DeepInspectionConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#GetEc2DeepInspectionConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves the activation status of Amazon Inspector deep inspection and custom paths associated with your account. \n

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/ec2deepinspectionconfiguration/get" - } - } - }, - "com.amazonaws.inspector2#GetEc2DeepInspectionConfigurationRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#GetEc2DeepInspectionConfigurationResponse": { - "type": "structure", - "members": { - "packagePaths": { - "target": "com.amazonaws.inspector2#PathList", - "traits": { - "smithy.api#documentation": "

The Amazon Inspector deep inspection custom paths for your account.

" - } - }, - "orgPackagePaths": { - "target": "com.amazonaws.inspector2#PathList", - "traits": { - "smithy.api#documentation": "

The Amazon Inspector deep inspection custom paths for your organization.

" - } - }, - "status": { - "target": "com.amazonaws.inspector2#Ec2DeepInspectionStatus", - "traits": { - "smithy.api#documentation": "

The activation status of Amazon Inspector deep inspection in your account.

" - } - }, - "errorMessage": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

An error message explaining why Amazon Inspector deep inspection configurations could not be retrieved for your account.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#GetEncryptionKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#GetEncryptionKeyRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#GetEncryptionKeyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets an encryption key.

", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/encryptionkey/get" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.inspector2#GetEncryptionKeyRequest": { - "type": "structure", - "members": { - "scanType": { - "target": "com.amazonaws.inspector2#ScanType", - "traits": { - "smithy.api#documentation": "

The scan type the key encrypts.

", - "smithy.api#httpQuery": "scanType", - "smithy.api#required": {} - } - }, - "resourceType": { - "target": "com.amazonaws.inspector2#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type the key encrypts.

", - "smithy.api#httpQuery": "resourceType", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#GetEncryptionKeyResponse": { - "type": "structure", - "members": { - "kmsKeyId": { - "target": "com.amazonaws.inspector2#KmsKeyArn", - "traits": { - "smithy.api#documentation": "

A kms key ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#GetFindingsReportStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#GetFindingsReportStatusRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#GetFindingsReportStatusResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the status of a findings report.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/reporting/status/get" - } - } - }, - "com.amazonaws.inspector2#GetFindingsReportStatusRequest": { - "type": "structure", - "members": { - "reportId": { - "target": "com.amazonaws.inspector2#ReportId", - "traits": { - "smithy.api#documentation": "

The ID of the report to retrieve the status of.

" - } - } - } - }, - "com.amazonaws.inspector2#GetFindingsReportStatusResponse": { - "type": "structure", - "members": { - "reportId": { - "target": "com.amazonaws.inspector2#ReportId", - "traits": { - "smithy.api#documentation": "

The ID of the report.

" - } - }, - "status": { - "target": "com.amazonaws.inspector2#ExternalReportStatus", - "traits": { - "smithy.api#documentation": "

The status of the report.

" - } - }, - "errorCode": { - "target": "com.amazonaws.inspector2#ReportingErrorCode", - "traits": { - "smithy.api#documentation": "

The error code of the report.

" - } - }, - "errorMessage": { - "target": "com.amazonaws.inspector2#ErrorMessage", - "traits": { - "smithy.api#documentation": "

The error message of the report.

" - } - }, - "destination": { - "target": "com.amazonaws.inspector2#Destination", - "traits": { - "smithy.api#documentation": "

The destination of the report.

" - } - }, - "filterCriteria": { - "target": "com.amazonaws.inspector2#FilterCriteria", - "traits": { - "smithy.api#documentation": "

The filter criteria associated with the report.

" - } - } - } - }, - "com.amazonaws.inspector2#GetMember": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#GetMemberRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#GetMemberResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets member information for your organization.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/members/get" - } - } - }, - "com.amazonaws.inspector2#GetMemberRequest": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the member account to retrieve information on.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.inspector2#GetMemberResponse": { - "type": "structure", - "members": { - "member": { - "target": "com.amazonaws.inspector2#Member", - "traits": { - "smithy.api#documentation": "

Details of the retrieved member account.

" - } - } - } - }, - "com.amazonaws.inspector2#GetSbomExport": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#GetSbomExportRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#GetSbomExportResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets details of a software bill of materials (SBOM) report.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/sbomexport/get" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.inspector2#GetSbomExportRequest": { - "type": "structure", - "members": { - "reportId": { - "target": "com.amazonaws.inspector2#ReportId", - "traits": { - "smithy.api#documentation": "

The report ID of the SBOM export to get details for.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#GetSbomExportResponse": { - "type": "structure", - "members": { - "reportId": { - "target": "com.amazonaws.inspector2#ReportId", - "traits": { - "smithy.api#documentation": "

The report ID of the software bill of materials (SBOM) report.

" - } - }, - "format": { - "target": "com.amazonaws.inspector2#SbomReportFormat", - "traits": { - "smithy.api#documentation": "

The format of the software bill of materials (SBOM) report.

" - } - }, - "status": { - "target": "com.amazonaws.inspector2#ExternalReportStatus", - "traits": { - "smithy.api#documentation": "

The status of the software bill of materials (SBOM) report.

" - } - }, - "errorCode": { - "target": "com.amazonaws.inspector2#ReportingErrorCode", - "traits": { - "smithy.api#documentation": "

An error code.

" - } - }, - "errorMessage": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

An error message.

" - } - }, - "s3Destination": { - "target": "com.amazonaws.inspector2#Destination" - }, - "filterCriteria": { - "target": "com.amazonaws.inspector2#ResourceFilterCriteria", - "traits": { - "smithy.api#documentation": "

Contains details about the resource filter criteria used for the software bill of materials (SBOM) report.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#GroupKey": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SCAN_STATUS_CODE", - "name": "SCAN_STATUS_CODE" - }, - { - "value": "SCAN_STATUS_REASON", - "name": "SCAN_STATUS_REASON" - }, - { - "value": "ACCOUNT_ID", - "name": "ACCOUNT_ID" - }, - { - "value": "RESOURCE_TYPE", - "name": "RESOURCE_TYPE" - }, - { - "value": "ECR_REPOSITORY_NAME", - "name": "ECR_REPOSITORY_NAME" - } - ] - } - }, - "com.amazonaws.inspector2#ImageHash": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 71, - "max": 71 - }, - "smithy.api#pattern": "^sha256:[a-z0-9]{64}$" - } - }, - "com.amazonaws.inspector2#ImageLayerAggregation": { - "type": "structure", - "members": { - "repositories": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The repository associated with the container image hosting the layers.

" - } - }, - "resourceIds": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The ID of the container image layer.

" - } - }, - "layerHashes": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The hashes associated with the layers.

" - } - }, - "sortOrder": { - "target": "com.amazonaws.inspector2#SortOrder", - "traits": { - "smithy.api#documentation": "

The order to sort results by.

" - } - }, - "sortBy": { - "target": "com.amazonaws.inspector2#ImageLayerSortBy", - "traits": { - "smithy.api#documentation": "

The value to sort results by.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The details that define an aggregation based on container image layers.

" - } - }, - "com.amazonaws.inspector2#ImageLayerAggregationResponse": { - "type": "structure", - "members": { - "repository": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The repository the layer resides in.

", - "smithy.api#required": {} - } - }, - "resourceId": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The resource ID of the container image layer.

", - "smithy.api#required": {} - } - }, - "layerHash": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The layer hash.

", - "smithy.api#required": {} - } - }, - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the container image hosting the layer image.

", - "smithy.api#required": {} - } - }, - "severityCounts": { - "target": "com.amazonaws.inspector2#SeverityCounts", - "traits": { - "smithy.api#documentation": "

An object that represents the count of matched findings per severity.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A response that contains the results of a finding aggregation by image layer.

" - } - }, - "com.amazonaws.inspector2#ImageLayerSortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CRITICAL", - "name": "CRITICAL" - }, - { - "value": "HIGH", - "name": "HIGH" - }, - { - "value": "ALL", - "name": "ALL" - } - ] - } - }, - "com.amazonaws.inspector2#ImageTagList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#NonEmptyString" - } - }, - "com.amazonaws.inspector2#Inspector2": { - "type": "service", - "version": "2020-06-08", - "operations": [ - { - "target": "com.amazonaws.inspector2#AssociateMember" + "traits": { + "smithy.api#documentation": "

A response that contains details on the results of a finding aggregation by title.

" + } + }, + "com.amazonaws.inspector2#TitleFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CisStringFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.inspector2#TitleSortBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CRITICAL", + "name": "CRITICAL" + }, + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "ALL", + "name": "ALL" + } + ] + } + }, + "com.amazonaws.inspector2#Tool": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.inspector2#Tools": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Tool" + } }, - { - "target": "com.amazonaws.inspector2#BatchGetAccountStatus" + "com.amazonaws.inspector2#Ttp": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30 + } + } }, - { - "target": "com.amazonaws.inspector2#BatchGetCodeSnippet" + "com.amazonaws.inspector2#Ttps": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Ttp" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } }, - { - "target": "com.amazonaws.inspector2#BatchGetFindingDetails" + "com.amazonaws.inspector2#UUID": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } }, - { - "target": "com.amazonaws.inspector2#BatchGetFreeTrialInfo" + "com.amazonaws.inspector2#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes tags from a resource.

", + "smithy.api#http": { + "uri": "/tags/{resourceArn}", + "method": "DELETE" + } + } }, - { - "target": "com.amazonaws.inspector2#BatchGetMemberEc2DeepInspectionStatus" + "com.amazonaws.inspector2#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.inspector2#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the resource to remove tags from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.inspector2#TagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys to remove from the resource.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.inspector2#BatchUpdateMemberEc2DeepInspectionStatus" + "com.amazonaws.inspector2#UntagResourceResponse": { + "type": "structure", + "members": {} }, - { - "target": "com.amazonaws.inspector2#CancelFindingsReport" + "com.amazonaws.inspector2#UpdateCisScanConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#UpdateCisScanConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#UpdateCisScanConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a CIS scan configuration.

", + "smithy.api#examples": [ + { + "title": "Sample UpdateCisScanConfiguration Call", + "input": { + "scanConfigurationArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-configuration/624b746d-e080-44ae-8c1d-48e653365a38", + "scanName": "sample_new", + "securityLevel": "LEVEL_2", + "schedule": { + "daily": { + "startTime": { + "timeOfDay": "12:56", + "timezone": "UTC" + } + } + }, + "targets": { + "accountIds": [ + "SELF" + ], + "targetResourceTags": { + "key2": [ + "value2" + ] + } + } + }, + "output": { + "scanConfigurationArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-configuration/624b746d-e080-44ae-8c1d-48e653365a38" + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/cis/scan-configuration/update" + } + } }, - { - "target": "com.amazonaws.inspector2#CancelSbomExport" + "com.amazonaws.inspector2#UpdateCisScanConfigurationRequest": { + "type": "structure", + "members": { + "scanConfigurationArn": { + "target": "com.amazonaws.inspector2#CisScanConfigurationArn", + "traits": { + "smithy.api#documentation": "

The CIS scan configuration ARN.

", + "smithy.api#required": {} + } + }, + "scanName": { + "target": "com.amazonaws.inspector2#CisScanName", + "traits": { + "smithy.api#documentation": "

The scan name for the CIS scan configuration.

" + } + }, + "securityLevel": { + "target": "com.amazonaws.inspector2#CisSecurityLevel", + "traits": { + "smithy.api#documentation": "

\n The security level for the CIS scan configuration. \n Security level refers to the Benchmark levels that CIS assigns to a profile.\n

" + } + }, + "schedule": { + "target": "com.amazonaws.inspector2#Schedule", + "traits": { + "smithy.api#documentation": "

The schedule for the CIS scan configuration.

" + } + }, + "targets": { + "target": "com.amazonaws.inspector2#UpdateCisTargets", + "traits": { + "smithy.api#documentation": "

The targets for the CIS scan configuration.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.inspector2#CreateCisScanConfiguration" + "com.amazonaws.inspector2#UpdateCisScanConfigurationResponse": { + "type": "structure", + "members": { + "scanConfigurationArn": { + "target": "com.amazonaws.inspector2#CisScanConfigurationArn", + "traits": { + "smithy.api#documentation": "

The CIS scan configuration ARN.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.inspector2#CreateFilter" + "com.amazonaws.inspector2#UpdateCisTargets": { + "type": "structure", + "members": { + "accountIds": { + "target": "com.amazonaws.inspector2#TargetAccountList", + "traits": { + "smithy.api#documentation": "

The target account ids.

" + } + }, + "targetResourceTags": { + "target": "com.amazonaws.inspector2#TargetResourceTags", + "traits": { + "smithy.api#documentation": "

The target resource tags.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Updates CIS targets.

" + } }, - { - "target": "com.amazonaws.inspector2#CreateFindingsReport" + "com.amazonaws.inspector2#UpdateConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#UpdateConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#UpdateConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates setting configurations for your Amazon Inspector account. When you use this API as an Amazon Inspector delegated administrator this updates the setting for all accounts you manage. Member accounts in an organization cannot update this setting.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/configuration/update" + } + } }, - { - "target": "com.amazonaws.inspector2#CreateSbomExport" + "com.amazonaws.inspector2#UpdateConfigurationRequest": { + "type": "structure", + "members": { + "ecrConfiguration": { + "target": "com.amazonaws.inspector2#EcrConfiguration", + "traits": { + "smithy.api#documentation": "

Specifies how the ECR automated re-scan will be updated for your environment.

" + } + }, + "ec2Configuration": { + "target": "com.amazonaws.inspector2#Ec2Configuration", + "traits": { + "smithy.api#documentation": "

Specifies how the Amazon EC2 automated scan will be updated for your environment.

" + } + } + } }, - { - "target": "com.amazonaws.inspector2#DeleteCisScanConfiguration" + "com.amazonaws.inspector2#UpdateConfigurationResponse": { + "type": "structure", + "members": {} }, - { - "target": "com.amazonaws.inspector2#DeleteFilter" + "com.amazonaws.inspector2#UpdateEc2DeepInspectionConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#UpdateEc2DeepInspectionConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#UpdateEc2DeepInspectionConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Activates, deactivates Amazon Inspector deep inspection, or updates custom paths for your account.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/ec2deepinspectionconfiguration/update" + } + } }, - { - "target": "com.amazonaws.inspector2#DescribeOrganizationConfiguration" + "com.amazonaws.inspector2#UpdateEc2DeepInspectionConfigurationRequest": { + "type": "structure", + "members": { + "activateDeepInspection": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specify TRUE to activate Amazon Inspector deep inspection in your account, or FALSE to deactivate. Member accounts in an organization cannot deactivate deep inspection, instead the delegated administrator for the organization can deactivate a member account using BatchUpdateMemberEc2DeepInspectionStatus.

" + } + }, + "packagePaths": { + "target": "com.amazonaws.inspector2#PathList", + "traits": { + "smithy.api#documentation": "

The Amazon Inspector deep inspection custom paths you are adding for your account.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.inspector2#Disable" + "com.amazonaws.inspector2#UpdateEc2DeepInspectionConfigurationResponse": { + "type": "structure", + "members": { + "packagePaths": { + "target": "com.amazonaws.inspector2#PathList", + "traits": { + "smithy.api#documentation": "

The current Amazon Inspector deep inspection custom paths for your account.

" + } + }, + "orgPackagePaths": { + "target": "com.amazonaws.inspector2#PathList", + "traits": { + "smithy.api#documentation": "

The current Amazon Inspector deep inspection custom paths for the organization.

" + } + }, + "status": { + "target": "com.amazonaws.inspector2#Ec2DeepInspectionStatus", + "traits": { + "smithy.api#documentation": "

The status of Amazon Inspector deep inspection in your account.

" + } + }, + "errorMessage": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An error message explaining why new Amazon Inspector deep inspection custom paths could not be added.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.inspector2#DisableDelegatedAdminAccount" + "com.amazonaws.inspector2#UpdateEncryptionKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#UpdateEncryptionKeyRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#UpdateEncryptionKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an encryption key. A ResourceNotFoundException means that an Amazon Web Services owned key is being used for encryption.

", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/encryptionkey/update" + }, + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.inspector2#DisassociateMember" + "com.amazonaws.inspector2#UpdateEncryptionKeyRequest": { + "type": "structure", + "members": { + "kmsKeyId": { + "target": "com.amazonaws.inspector2#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

A KMS key ID for the encryption key.

", + "smithy.api#required": {} + } + }, + "scanType": { + "target": "com.amazonaws.inspector2#ScanType", + "traits": { + "smithy.api#documentation": "

The scan type for the encryption key.

", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "com.amazonaws.inspector2#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type for the encryption key.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.inspector2#Enable" + "com.amazonaws.inspector2#UpdateEncryptionKeyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.inspector2#EnableDelegatedAdminAccount" + "com.amazonaws.inspector2#UpdateFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#UpdateFilterRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#UpdateFilterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Specifies the action that is to be applied to the findings that match the filter.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/filters/update" + } + } }, - { - "target": "com.amazonaws.inspector2#GetCisScanReport" + "com.amazonaws.inspector2#UpdateFilterRequest": { + "type": "structure", + "members": { + "action": { + "target": "com.amazonaws.inspector2#FilterAction", + "traits": { + "smithy.api#documentation": "

Specifies the action that is to be applied to the findings that match the filter.

" + } + }, + "description": { + "target": "com.amazonaws.inspector2#FilterDescription", + "traits": { + "smithy.api#documentation": "

A description of the filter.

" + } + }, + "filterCriteria": { + "target": "com.amazonaws.inspector2#FilterCriteria", + "traits": { + "smithy.api#documentation": "

Defines the criteria to be update in the filter.

" + } + }, + "name": { + "target": "com.amazonaws.inspector2#FilterName", + "traits": { + "smithy.api#documentation": "

The name of the filter.

" + } + }, + "filterArn": { + "target": "com.amazonaws.inspector2#FilterArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the filter to update.

", + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.inspector2#FilterReason", + "traits": { + "smithy.api#documentation": "

The reason the filter was updated.

" + } + } + } }, - { - "target": "com.amazonaws.inspector2#GetCisScanResultDetails" + "com.amazonaws.inspector2#UpdateFilterResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.inspector2#FilterArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the successfully updated filter.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.inspector2#GetConfiguration" + "com.amazonaws.inspector2#UpdateOrgEc2DeepInspectionConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#UpdateOrgEc2DeepInspectionConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#UpdateOrgEc2DeepInspectionConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the Amazon Inspector deep inspection custom paths for your organization. You must be an Amazon Inspector delegated administrator to use this API.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/ec2deepinspectionconfiguration/org/update" + } + } }, - { - "target": "com.amazonaws.inspector2#GetDelegatedAdminAccount" + "com.amazonaws.inspector2#UpdateOrgEc2DeepInspectionConfigurationRequest": { + "type": "structure", + "members": { + "orgPackagePaths": { + "target": "com.amazonaws.inspector2#PathList", + "traits": { + "smithy.api#documentation": "

The Amazon Inspector deep inspection custom paths you are adding for your organization.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.inspector2#GetEc2DeepInspectionConfiguration" + "com.amazonaws.inspector2#UpdateOrgEc2DeepInspectionConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.inspector2#GetEncryptionKey" + "com.amazonaws.inspector2#UpdateOrganizationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#UpdateOrganizationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#UpdateOrganizationConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the configurations for your Amazon Inspector organization.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/organizationconfiguration/update" + } + } }, - { - "target": "com.amazonaws.inspector2#GetFindingsReportStatus" + "com.amazonaws.inspector2#UpdateOrganizationConfigurationRequest": { + "type": "structure", + "members": { + "autoEnable": { + "target": "com.amazonaws.inspector2#AutoEnable", + "traits": { + "smithy.api#documentation": "

Defines which scan types are enabled automatically for new members of your Amazon Inspector organization.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.inspector2#GetMember" + "com.amazonaws.inspector2#UpdateOrganizationConfigurationResponse": { + "type": "structure", + "members": { + "autoEnable": { + "target": "com.amazonaws.inspector2#AutoEnable", + "traits": { + "smithy.api#documentation": "

The updated status of scan types automatically enabled for new members of your Amazon Inspector organization.

", + "smithy.api#required": {} + } + } + } }, - { - "target": "com.amazonaws.inspector2#GetSbomExport" + "com.amazonaws.inspector2#Usage": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.inspector2#UsageType", + "traits": { + "smithy.api#documentation": "

The type scan.

" + } + }, + "total": { + "target": "com.amazonaws.inspector2#UsageValue", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total of usage.

" + } + }, + "estimatedMonthlyCost": { + "target": "com.amazonaws.inspector2#MonthlyCostEstimate", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The estimated monthly cost of Amazon Inspector.

" + } + }, + "currency": { + "target": "com.amazonaws.inspector2#Currency", + "traits": { + "smithy.api#documentation": "

The currency type used when calculating usage data.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains usage information about the cost of Amazon Inspector operation.

" + } }, - { - "target": "com.amazonaws.inspector2#ListAccountPermissions" + "com.amazonaws.inspector2#UsageAccountId": { + "type": "string", + "traits": { + "smithy.api#pattern": "[0-9]{12}" + } }, - { - "target": "com.amazonaws.inspector2#ListCisScanConfigurations" + "com.amazonaws.inspector2#UsageAccountIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#UsageAccountId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 7000 + } + } }, - { - "target": "com.amazonaws.inspector2#ListCisScanResultsAggregatedByChecks" + "com.amazonaws.inspector2#UsageList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Usage" + } }, - { - "target": "com.amazonaws.inspector2#ListCisScanResultsAggregatedByTargetResource" + "com.amazonaws.inspector2#UsageTotal": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.inspector2#MeteringAccountId", + "traits": { + "smithy.api#documentation": "

The account ID of the account that usage data was retrieved for.

" + } + }, + "usage": { + "target": "com.amazonaws.inspector2#UsageList", + "traits": { + "smithy.api#documentation": "

An object representing the total usage for an account.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The total of usage for an account ID.

" + } }, - { - "target": "com.amazonaws.inspector2#ListCisScans" + "com.amazonaws.inspector2#UsageTotalList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#UsageTotal" + } }, - { - "target": "com.amazonaws.inspector2#ListCoverage" + "com.amazonaws.inspector2#UsageType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "EC2_INSTANCE_HOURS", + "value": "EC2_INSTANCE_HOURS" + }, + { + "name": "ECR_INITIAL_SCAN", + "value": "ECR_INITIAL_SCAN" + }, + { + "name": "ECR_RESCAN", + "value": "ECR_RESCAN" + }, + { + "name": "LAMBDA_FUNCTION_HOURS", + "value": "LAMBDA_FUNCTION_HOURS" + }, + { + "name": "LAMBDA_FUNCTION_CODE_HOURS", + "value": "LAMBDA_FUNCTION_CODE_HOURS" + } + ] + } }, - { - "target": "com.amazonaws.inspector2#ListCoverageStatistics" + "com.amazonaws.inspector2#UsageValue": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } }, - { - "target": "com.amazonaws.inspector2#ListDelegatedAdminAccounts" + "com.amazonaws.inspector2#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.inspector2#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "

The reason for the validation failure.

", + "smithy.api#required": {} + } + }, + "fields": { + "target": "com.amazonaws.inspector2#ValidationExceptionFields", + "traits": { + "smithy.api#documentation": "

The fields that failed validation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request has failed validation due to missing required fields or having invalid\n inputs.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.inspector2#ListFilters" + "com.amazonaws.inspector2#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the validation exception.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The validation exception message.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that describes a validation exception.

" + } }, - { - "target": "com.amazonaws.inspector2#ListFindingAggregations" + "com.amazonaws.inspector2#ValidationExceptionFields": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#ValidationExceptionField" + } }, - { - "target": "com.amazonaws.inspector2#ListFindings" + "com.amazonaws.inspector2#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CANNOT_PARSE", + "name": "CANNOT_PARSE" + }, + { + "value": "FIELD_VALIDATION_FAILED", + "name": "FIELD_VALIDATION_FAILED" + }, + { + "value": "OTHER", + "name": "OTHER" + } + ] + } }, - { - "target": "com.amazonaws.inspector2#ListMembers" + "com.amazonaws.inspector2#Vendor": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 16 + } + } }, - { - "target": "com.amazonaws.inspector2#ListTagsForResource" + "com.amazonaws.inspector2#VendorCreatedAt": { + "type": "timestamp" }, - { - "target": "com.amazonaws.inspector2#ListUsageTotals" + "com.amazonaws.inspector2#VendorSeverity": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } }, - { - "target": "com.amazonaws.inspector2#ResetEncryptionKey" + "com.amazonaws.inspector2#VendorUpdatedAt": { + "type": "timestamp" }, - { - "target": "com.amazonaws.inspector2#SearchVulnerabilities" + "com.amazonaws.inspector2#Version": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\$LATEST|[0-9]+$" + } }, - { - "target": "com.amazonaws.inspector2#SendCisSessionHealth" + "com.amazonaws.inspector2#VpcId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^vpc-([a-z0-9]{8}|[a-z0-9]{17}|\\*)$" + } }, - { - "target": "com.amazonaws.inspector2#SendCisSessionTelemetry" + "com.amazonaws.inspector2#VulnId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^CVE-[12][0-9]{3}-[0-9]{1,10}$" + } }, - { - "target": "com.amazonaws.inspector2#StartCisSession" + "com.amazonaws.inspector2#VulnIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#VulnId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } }, - { - "target": "com.amazonaws.inspector2#StopCisSession" + "com.amazonaws.inspector2#Vulnerabilities": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#Vulnerability" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } }, - { - "target": "com.amazonaws.inspector2#TagResource" + "com.amazonaws.inspector2#Vulnerability": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.inspector2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID for the specific vulnerability.

", + "smithy.api#required": {} + } + }, + "cwes": { + "target": "com.amazonaws.inspector2#Cwes", + "traits": { + "smithy.api#documentation": "

The Common Weakness Enumeration (CWE) associated with the vulnerability.

" + } + }, + "cisaData": { + "target": "com.amazonaws.inspector2#CisaData", + "traits": { + "smithy.api#documentation": "

An object that contains the Cybersecurity and Infrastructure Security Agency (CISA) details for the vulnerability.

" + } + }, + "source": { + "target": "com.amazonaws.inspector2#VulnerabilitySource", + "traits": { + "smithy.api#documentation": "

The source of the vulnerability information. Possible results are RHEL, AMAZON_CVE, DEBIAN or NVD.

" + } + }, + "description": { + "target": "com.amazonaws.inspector2#VulnerabilityDescription", + "traits": { + "smithy.api#documentation": "

A description of the vulnerability.

" + } + }, + "atigData": { + "target": "com.amazonaws.inspector2#AtigData", + "traits": { + "smithy.api#documentation": "

An object that contains information about the Amazon Web Services Threat Intel Group (ATIG) details for the vulnerability.

" + } + }, + "vendorSeverity": { + "target": "com.amazonaws.inspector2#VendorSeverity", + "traits": { + "smithy.api#documentation": "

The severity assigned by the vendor.

" + } + }, + "cvss3": { + "target": "com.amazonaws.inspector2#Cvss3", + "traits": { + "smithy.api#documentation": "

An object that contains the Common Vulnerability Scoring System (CVSS) Version 3 details for the vulnerability.

" + } + }, + "relatedVulnerabilities": { + "target": "com.amazonaws.inspector2#RelatedVulnerabilities", + "traits": { + "smithy.api#documentation": "

A list of related vulnerabilities.

" + } + }, + "cvss2": { + "target": "com.amazonaws.inspector2#Cvss2", + "traits": { + "smithy.api#documentation": "

An object that contains the Common Vulnerability Scoring System (CVSS) Version 2 details for the vulnerability.

" + } + }, + "vendorCreatedAt": { + "target": "com.amazonaws.inspector2#VendorCreatedAt", + "traits": { + "smithy.api#documentation": "

The date and time when the vendor created this vulnerability.

" + } + }, + "vendorUpdatedAt": { + "target": "com.amazonaws.inspector2#VendorUpdatedAt", + "traits": { + "smithy.api#documentation": "

The date and time when the vendor last updated this vulnerability.

" + } + }, + "sourceUrl": { + "target": "com.amazonaws.inspector2#VulnerabilitySourceUrl", + "traits": { + "smithy.api#documentation": "

A link to the official source material for this vulnerability.

" + } + }, + "referenceUrls": { + "target": "com.amazonaws.inspector2#VulnerabilityReferenceUrls", + "traits": { + "smithy.api#documentation": "

Links to various resources with more information on this vulnerability.

" + } + }, + "exploitObserved": { + "target": "com.amazonaws.inspector2#ExploitObserved", + "traits": { + "smithy.api#documentation": "

An object that contains details on when the exploit was observed.

" + } + }, + "detectionPlatforms": { + "target": "com.amazonaws.inspector2#DetectionPlatforms", + "traits": { + "smithy.api#documentation": "

Platforms that the vulnerability can be detected on.

" + } + }, + "epss": { + "target": "com.amazonaws.inspector2#Epss", + "traits": { + "smithy.api#documentation": "

An object that contains the Exploit Prediction Scoring System (EPSS) score for a vulnerability.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about a specific vulnerability Amazon Inspector can detect.

" + } }, - { - "target": "com.amazonaws.inspector2#UntagResource" + "com.amazonaws.inspector2#VulnerabilityDescription": { + "type": "string" }, - { - "target": "com.amazonaws.inspector2#UpdateCisScanConfiguration" + "com.amazonaws.inspector2#VulnerabilityId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } }, - { - "target": "com.amazonaws.inspector2#UpdateConfiguration" + "com.amazonaws.inspector2#VulnerabilityIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#VulnerabilityId" + } }, - { - "target": "com.amazonaws.inspector2#UpdateEc2DeepInspectionConfiguration" + "com.amazonaws.inspector2#VulnerabilityReferenceUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0 + } + } }, - { - "target": "com.amazonaws.inspector2#UpdateEncryptionKey" + "com.amazonaws.inspector2#VulnerabilityReferenceUrls": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#VulnerabilityReferenceUrl" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } }, - { - "target": "com.amazonaws.inspector2#UpdateFilter" + "com.amazonaws.inspector2#VulnerabilitySource": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NVD", + "name": "NVD" + } + ] + } }, - { - "target": "com.amazonaws.inspector2#UpdateOrganizationConfiguration" + "com.amazonaws.inspector2#VulnerabilitySourceUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0 + } + } }, - { - "target": "com.amazonaws.inspector2#UpdateOrgEc2DeepInspectionConfiguration" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "Inspector2", - "arnNamespace": "inspector2", - "cloudTrailEventSource": "inspector2.amazon.aws", - "cloudFormationName": "Inspector2" - }, - "aws.auth#sigv4": { - "name": "inspector2" - }, - "aws.protocols#restJson1": {}, - "smithy.api#cors": { - "additionalAllowedHeaders": ["*"] - }, - "smithy.api#documentation": "

Amazon Inspector is a vulnerability discovery service that automates continuous scanning for\n security vulnerabilities within your Amazon EC2, Amazon ECR, and Amazon Web Services Lambda environments.

", - "smithy.api#title": "Inspector2", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] + "com.amazonaws.inspector2#VulnerablePackage": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.inspector2#PackageName", + "traits": { + "smithy.api#documentation": "

The name of the vulnerable package.

", + "smithy.api#required": {} } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "version": { + "target": "com.amazonaws.inspector2#PackageVersion", + "traits": { + "smithy.api#documentation": "

The version of the vulnerable package.

", + "smithy.api#required": {} } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" + "sourceLayerHash": { + "target": "com.amazonaws.inspector2#SourceLayerHash", + "traits": { + "smithy.api#documentation": "

The source layer hash of the vulnerable package.

" } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" + }, + "epoch": { + "target": "com.amazonaws.inspector2#PackageEpoch", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The epoch of the vulnerable package.

" } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://inspector2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://inspector2-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://inspector2.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://inspector2.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://inspector2.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://inspector2.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://inspector2.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://inspector2.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://inspector2.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://inspector2.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://inspector2.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://inspector2.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://inspector2.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://inspector2.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://inspector2.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://inspector2.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://inspector2.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://inspector2.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://inspector2.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://inspector2.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://inspector2.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://inspector2.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://inspector2.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://inspector2-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://inspector2-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://inspector2.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://inspector2-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://inspector2-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://inspector2.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://inspector2.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://inspector2-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://inspector2-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://inspector2.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://inspector2.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://inspector2-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://inspector2.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://inspector2-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://inspector2.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.inspector2#InspectorScoreDetails": { - "type": "structure", - "members": { - "adjustedCvss": { - "target": "com.amazonaws.inspector2#CvssScoreDetails", - "traits": { - "smithy.api#documentation": "

An object that contains details about the CVSS score given to a finding.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the Amazon Inspector score given to a finding.

" - } - }, - "com.amazonaws.inspector2#InternalServerException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - }, - "retryAfterSeconds": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The number of seconds to wait before retrying the request.

", - "smithy.api#httpHeader": "Retry-After" - } - } - }, - "traits": { - "smithy.api#documentation": "

The request has failed due to an internal failure of the Amazon Inspector service.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500, - "smithy.api#retryable": {} - } - }, - "com.amazonaws.inspector2#IpV4Address": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 7, - "max": 15 - }, - "smithy.api#pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$" - } - }, - "com.amazonaws.inspector2#IpV4AddressList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#IpV4Address" - } - }, - "com.amazonaws.inspector2#IpV6Address": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 47 - } - } - }, - "com.amazonaws.inspector2#IpV6AddressList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#IpV6Address" - } - }, - "com.amazonaws.inspector2#KmsKeyArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws(-(us-gov|cn))?:kms:([a-z0-9][-.a-z0-9]{0,62})?:[0-9]{12}?:key/(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|(mrk-[0-9a-zA-Z]{32}))$" - } - }, - "com.amazonaws.inspector2#LambdaFunctionAggregation": { - "type": "structure", - "members": { - "resourceIds": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The resource IDs to include in the aggregation results.

" - } - }, - "functionNames": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Lambda function names to include in the aggregation results.

" - } - }, - "runtimes": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

Returns findings aggregated by Amazon Web Services Lambda function runtime environments.

" - } - }, - "functionTags": { - "target": "com.amazonaws.inspector2#MapFilterList", - "traits": { - "smithy.api#documentation": "

The tags to include in the aggregation results.

" - } - }, - "sortOrder": { - "target": "com.amazonaws.inspector2#SortOrder", - "traits": { - "smithy.api#documentation": "

The order to use for sorting the results.

" - } - }, - "sortBy": { - "target": "com.amazonaws.inspector2#LambdaFunctionSortBy", - "traits": { - "smithy.api#documentation": "

The finding severity to use for sorting the results.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The details that define a findings aggregation based on Amazon Web Services Lambda functions.

" - } - }, - "com.amazonaws.inspector2#LambdaFunctionAggregationResponse": { - "type": "structure", - "members": { - "resourceId": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The resource IDs included in the aggregation results.

", - "smithy.api#required": {} - } - }, - "functionName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Lambda function names included in the aggregation results.

" - } - }, - "runtime": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The runtimes included in the aggregation results.

" - } - }, - "lambdaTags": { - "target": "com.amazonaws.inspector2#TagMap", - "traits": { - "smithy.api#documentation": "

The tags included in the aggregation results.

" - } - }, - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the Amazon Web Services Lambda function.\n

" - } - }, - "severityCounts": { - "target": "com.amazonaws.inspector2#SeverityCounts" - }, - "lastModifiedAt": { - "target": "com.amazonaws.inspector2#DateTimeTimestamp", - "traits": { - "smithy.api#documentation": "

The date that the Amazon Web Services Lambda function included in the aggregation results was last changed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A response that contains the results of an Amazon Web Services Lambda function finding aggregation.

" - } - }, - "com.amazonaws.inspector2#LambdaFunctionMetadata": { - "type": "structure", - "members": { - "functionTags": { - "target": "com.amazonaws.inspector2#TagMap", - "traits": { - "smithy.api#documentation": "

The resource tags on an Amazon Web Services Lambda function.

" - } - }, - "layers": { - "target": "com.amazonaws.inspector2#LambdaLayerList", - "traits": { - "smithy.api#documentation": "

The layers for an Amazon Web Services Lambda function. A Lambda function can have up to five layers.

" - } - }, - "functionName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The name of a function.

" - } - }, - "runtime": { - "target": "com.amazonaws.inspector2#Runtime", - "traits": { - "smithy.api#documentation": "

An Amazon Web Services Lambda function's runtime.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Lambda function metadata.

" - } - }, - "com.amazonaws.inspector2#LambdaFunctionSortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CRITICAL", - "name": "CRITICAL" - }, - { - "value": "HIGH", - "name": "HIGH" - }, - { - "value": "ALL", - "name": "ALL" - } - ] - } - }, - "com.amazonaws.inspector2#LambdaLayerAggregation": { - "type": "structure", - "members": { - "functionNames": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The names of the Amazon Web Services Lambda functions associated with the layers.

" - } - }, - "resourceIds": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The resource IDs for the Amazon Web Services Lambda function layers.

" - } - }, - "layerArns": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Lambda function layer.\n

" - } - }, - "sortOrder": { - "target": "com.amazonaws.inspector2#SortOrder", - "traits": { - "smithy.api#documentation": "

The order to use for sorting the results.

" - } - }, - "sortBy": { - "target": "com.amazonaws.inspector2#LambdaLayerSortBy", - "traits": { - "smithy.api#documentation": "

The finding severity to use for sorting the results.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The details that define a findings aggregation based on an Amazon Web Services Lambda function's layers.

" - } - }, - "com.amazonaws.inspector2#LambdaLayerAggregationResponse": { - "type": "structure", - "members": { - "functionName": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The names of the Amazon Web Services Lambda functions associated with the layers.

", - "smithy.api#required": {} - } - }, - "resourceId": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Resource ID of the Amazon Web Services Lambda function layer.

", - "smithy.api#required": {} - } - }, - "layerArn": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Lambda function layer.

", - "smithy.api#required": {} - } - }, - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The account ID of the Amazon Web Services Lambda function layer.

", - "smithy.api#required": {} - } - }, - "severityCounts": { - "target": "com.amazonaws.inspector2#SeverityCounts" - } - }, - "traits": { - "smithy.api#documentation": "

A response that contains the results of an Amazon Web Services Lambda function layer finding aggregation.

" - } - }, - "com.amazonaws.inspector2#LambdaLayerArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\\d{12}:layer:[a-zA-Z0-9-_]+:[0-9]+$" - } - }, - "com.amazonaws.inspector2#LambdaLayerList": { - "type": "list", - "member": { - "target": "smithy.api#String" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.inspector2#LambdaLayerSortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CRITICAL", - "name": "CRITICAL" - }, - { - "value": "HIGH", - "name": "HIGH" - }, - { - "value": "ALL", - "name": "ALL" - } - ] - } - }, - "com.amazonaws.inspector2#LambdaVpcConfig": { - "type": "structure", - "members": { - "subnetIds": { - "target": "com.amazonaws.inspector2#SubnetIdList", - "traits": { - "smithy.api#documentation": "

A list of VPC subnet IDs.

" - } - }, - "securityGroupIds": { - "target": "com.amazonaws.inspector2#SecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

The VPC security groups and subnets that are attached to an Amazon Web Services Lambda function. For more information, see VPC Settings.

" - } - }, - "vpcId": { - "target": "com.amazonaws.inspector2#VpcId", - "traits": { - "smithy.api#documentation": "

The ID of the VPC.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The VPC security groups and subnets that are attached to an Amazon Web Services Lambda function. For more information, see VPC Settings.

" - } - }, - "com.amazonaws.inspector2#LastSeen": { - "type": "timestamp" - }, - "com.amazonaws.inspector2#LayerList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#LambdaLayerArn" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.inspector2#ListAccountPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#ListAccountPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#ListAccountPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the permissions an account has to configure Amazon Inspector.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/accountpermissions/list" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "permissions" - } - } - }, - "com.amazonaws.inspector2#ListAccountPermissionsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.inspector2#ListAccountPermissionsRequest": { - "type": "structure", - "members": { - "service": { - "target": "com.amazonaws.inspector2#Service", - "traits": { - "smithy.api#documentation": "

The service scan type to check permissions for.

" - } - }, - "maxResults": { - "target": "com.amazonaws.inspector2#ListAccountPermissionsMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

" - } - } - } - }, - "com.amazonaws.inspector2#ListAccountPermissionsResponse": { - "type": "structure", - "members": { - "permissions": { - "target": "com.amazonaws.inspector2#Permissions", - "traits": { - "smithy.api#documentation": "

Contains details on the permissions an account has to configure Amazon Inspector.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" - } - } - } - }, - "com.amazonaws.inspector2#ListCisScanConfigurations": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#ListCisScanConfigurationsRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#ListCisScanConfigurationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists CIS scan configurations.

", - "smithy.api#examples": [ - { - "title": "Sample ListCisScanConfigurations Call", - "input": {}, - "output": { - "scanConfigurations": [ - { - "scanConfigurationArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-configuration/624b746d-e080-44ae-8c1d-48e653365a38", - "ownerId": "123412341234", - "scanName": "sample", - "securityLevel": "LEVEL_1", - "schedule": { - "daily": { - "startTime": { - "timeOfDay": "12:34", - "timezone": "UTC" - } - } - }, - "targets": { - "accountIds": ["123412341234"], - "targetResourceTags": { - "key": ["value"] - } - } - } - ] - } - } - ], - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/cis/scan-configuration/list" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "scanConfigurations", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.inspector2#ListCisScanConfigurationsFilterCriteria": { - "type": "structure", - "members": { - "scanNameFilters": { - "target": "com.amazonaws.inspector2#CisScanNameFilterList", - "traits": { - "smithy.api#documentation": "

The list of scan name filters.

" - } - }, - "targetResourceTagFilters": { - "target": "com.amazonaws.inspector2#ResourceTagFilterList", - "traits": { - "smithy.api#documentation": "

The list of target resource tag filters.

" - } - }, - "scanConfigurationArnFilters": { - "target": "com.amazonaws.inspector2#CisScanConfigurationArnFilterList", - "traits": { - "smithy.api#documentation": "

The list of scan configuration ARN filters.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A list of CIS scan configurations filter criteria.

" - } - }, - "com.amazonaws.inspector2#ListCisScanConfigurationsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.inspector2#ListCisScanConfigurationsRequest": { - "type": "structure", - "members": { - "filterCriteria": { - "target": "com.amazonaws.inspector2#ListCisScanConfigurationsFilterCriteria", - "traits": { - "smithy.api#documentation": "

The CIS scan configuration filter criteria.

" - } - }, - "sortBy": { - "target": "com.amazonaws.inspector2#CisScanConfigurationsSortBy", - "traits": { - "smithy.api#default": "SCAN_NAME", - "smithy.api#documentation": "

The CIS scan configuration sort by order.

" - } - }, - "sortOrder": { - "target": "com.amazonaws.inspector2#CisSortOrder", - "traits": { - "smithy.api#documentation": "

The CIS scan configuration sort order order.

" - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token from a previous request that's used to retrieve the next page of results.

" - } - }, - "maxResults": { - "target": "com.amazonaws.inspector2#ListCisScanConfigurationsMaxResults", - "traits": { - "smithy.api#default": 100, - "smithy.api#documentation": "

The maximum number of CIS scan configurations to be returned in a single page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#ListCisScanConfigurationsResponse": { - "type": "structure", - "members": { - "scanConfigurations": { - "target": "com.amazonaws.inspector2#CisScanConfigurationList", - "traits": { - "smithy.api#documentation": "

The CIS scan configuration scan configurations.

" - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token from a previous request that's used to retrieve the next page of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#ListCisScanResultsAggregatedByChecks": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#ListCisScanResultsAggregatedByChecksRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#ListCisScanResultsAggregatedByChecksResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists scan results aggregated by checks.

", - "smithy.api#examples": [ - { - "title": "Sample ListCisScanResultsAggregatedByChecks Call", - "input": { - "scanArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38" - }, - "output": { - "checkAggregations": [ - { - "scanArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38", - "checkId": "1.1.1.1", - "title": "title1", - "checkDescription": "description", - "level": "LEVEL_1", - "accountId": "123412341234", - "statusCounts": { - "failed": 0, - "skipped": 1, - "passed": 2 - }, - "platform": "AMAZON_LINUX_2" - } - ] - } - } - ], - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/cis/scan-result/check/list" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "checkAggregations", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.inspector2#ListCisScanResultsAggregatedByChecksRequest": { - "type": "structure", - "members": { - "scanArn": { - "target": "com.amazonaws.inspector2#CisScanArn", - "traits": { - "smithy.api#documentation": "

The scan ARN.

", - "smithy.api#required": {} - } - }, - "filterCriteria": { - "target": "com.amazonaws.inspector2#CisScanResultsAggregatedByChecksFilterCriteria", - "traits": { - "smithy.api#documentation": "

The filter criteria.

" - } - }, - "sortBy": { - "target": "com.amazonaws.inspector2#CisScanResultsAggregatedByChecksSortBy", - "traits": { - "smithy.api#default": "FAILED_COUNTS", - "smithy.api#documentation": "

The sort by order.

" - } - }, - "sortOrder": { - "target": "com.amazonaws.inspector2#CisSortOrder", - "traits": { - "smithy.api#documentation": "

The sort order.

" - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token from a previous request that's used to retrieve the next page of results.

" - } - }, - "maxResults": { - "target": "com.amazonaws.inspector2#CisScanResultsMaxResults", - "traits": { - "smithy.api#default": 100, - "smithy.api#documentation": "

The maximum number of scan results aggregated by checks to be returned in a single page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#ListCisScanResultsAggregatedByChecksResponse": { - "type": "structure", - "members": { - "checkAggregations": { - "target": "com.amazonaws.inspector2#CisCheckAggregationList", - "traits": { - "smithy.api#documentation": "

The check aggregations.

" - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token from a previous request that's used to retrieve the next page of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#ListCisScanResultsAggregatedByTargetResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#ListCisScanResultsAggregatedByTargetResourceRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#ListCisScanResultsAggregatedByTargetResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists scan results aggregated by a target resource.

", - "smithy.api#examples": [ - { - "title": "Sample ListCisScanResultsAggregatedByTargetResource Call", - "input": { - "scanArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38" + }, + "release": { + "target": "com.amazonaws.inspector2#PackageRelease", + "traits": { + "smithy.api#documentation": "

The release of the vulnerable package.

" + } + }, + "arch": { + "target": "com.amazonaws.inspector2#PackageArchitecture", + "traits": { + "smithy.api#documentation": "

The architecture of the vulnerable package.

" + } + }, + "packageManager": { + "target": "com.amazonaws.inspector2#PackageManager", + "traits": { + "smithy.api#documentation": "

The package manager of the vulnerable package.

" + } + }, + "filePath": { + "target": "com.amazonaws.inspector2#FilePath", + "traits": { + "smithy.api#documentation": "

The file path of the vulnerable package.

" + } + }, + "fixedInVersion": { + "target": "com.amazonaws.inspector2#PackageVersion", + "traits": { + "smithy.api#documentation": "

The version of the package that contains the vulnerability fix.

" + } + }, + "remediation": { + "target": "com.amazonaws.inspector2#VulnerablePackageRemediation", + "traits": { + "smithy.api#documentation": "

The code to run in your environment to update packages with a fix available.

" + } + }, + "sourceLambdaLayerArn": { + "target": "com.amazonaws.inspector2#LambdaLayerArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the Amazon Web Services Lambda function affected by a finding.

" + } + } }, - "output": { - "targetResourceAggregations": [ - { - "scanArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38", - "targetResourceId": "i-12341234", - "accountId": "123412341234", - "targetResourceTags": { - "key": ["value"] - }, - "statusCounts": { - "failed": 0, - "skipped": 1, - "passed": 2 - }, - "platform": "AMAZON_LINUX_2", - "targetStatus": "COMPLETED" - } - ] - } - } - ], - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/cis/scan-result/resource/list" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "targetResourceAggregations", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.inspector2#ListCisScanResultsAggregatedByTargetResourceRequest": { - "type": "structure", - "members": { - "scanArn": { - "target": "com.amazonaws.inspector2#CisScanArn", - "traits": { - "smithy.api#documentation": "

The scan ARN.

", - "smithy.api#required": {} - } - }, - "filterCriteria": { - "target": "com.amazonaws.inspector2#CisScanResultsAggregatedByTargetResourceFilterCriteria", - "traits": { - "smithy.api#documentation": "

The filter criteria.

" - } - }, - "sortBy": { - "target": "com.amazonaws.inspector2#CisScanResultsAggregatedByTargetResourceSortBy", - "traits": { - "smithy.api#default": "FAILED_COUNTS", - "smithy.api#documentation": "

The sort by order.

" - } - }, - "sortOrder": { - "target": "com.amazonaws.inspector2#CisSortOrder", - "traits": { - "smithy.api#documentation": "

The sort order.

" - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token from a previous request that's used to retrieve the next page of results.

" - } - }, - "maxResults": { - "target": "com.amazonaws.inspector2#CisScanResultsMaxResults", - "traits": { - "smithy.api#default": 100, - "smithy.api#documentation": "

The maximum number of scan results aggregated by a target resource to be returned in a single page of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#ListCisScanResultsAggregatedByTargetResourceResponse": { - "type": "structure", - "members": { - "targetResourceAggregations": { - "target": "com.amazonaws.inspector2#CisTargetResourceAggregationList", - "traits": { - "smithy.api#documentation": "

The resource aggregations.

" - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token from a previous request that's used to retrieve the next page of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#ListCisScans": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#ListCisScansRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#ListCisScansResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a CIS scan list.

", - "smithy.api#examples": [ - { - "title": "Sample ListCisScans Call", - "input": {}, - "output": { - "scans": [ - { - "scanArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38", - "scanConfigurationArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-configuration/624b746d-e080-44ae-8c1d-48e653365a38", - "status": "COMPLETED", - "scanName": "sample", - "scanDate": "2023-04-12T23:20:50.52Z", - "failedChecks": 2, - "totalChecks": 150, - "targets": { - "accountIds": ["123412341234"], - "targetResourceTags": { - "key": ["value"] - } - }, - "scheduledBy": "Delegated Admin", - "securityLevel": "LEVEL_1" - } - ] - } - } - ], - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/cis/scan/list" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "scans", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.inspector2#ListCisScansDetailLevel": { - "type": "enum", - "members": { - "ORGANIZATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ORGANIZATION" - } - }, - "MEMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEMBER" - } - } - } - }, - "com.amazonaws.inspector2#ListCisScansFilterCriteria": { - "type": "structure", - "members": { - "scanNameFilters": { - "target": "com.amazonaws.inspector2#CisScanNameFilterList", - "traits": { - "smithy.api#documentation": "

The list of scan name filters.

" - } - }, - "targetResourceTagFilters": { - "target": "com.amazonaws.inspector2#ResourceTagFilterList", - "traits": { - "smithy.api#documentation": "

The list of target resource tag filters.

" - } - }, - "targetResourceIdFilters": { - "target": "com.amazonaws.inspector2#ResourceIdFilterList", - "traits": { - "smithy.api#documentation": "

The list of target resource ID filters.

" - } - }, - "scanStatusFilters": { - "target": "com.amazonaws.inspector2#CisScanStatusFilterList", - "traits": { - "smithy.api#documentation": "

The list of scan status filters.

" - } - }, - "scanAtFilters": { - "target": "com.amazonaws.inspector2#CisScanDateFilterList", - "traits": { - "smithy.api#documentation": "

The list of scan at filters.

" - } - }, - "scanConfigurationArnFilters": { - "target": "com.amazonaws.inspector2#CisScanConfigurationArnFilterList", - "traits": { - "smithy.api#documentation": "

The list of scan configuration ARN filters.

" - } - }, - "scanArnFilters": { - "target": "com.amazonaws.inspector2#CisScanArnFilterList", - "traits": { - "smithy.api#documentation": "

The list of scan ARN filters.

" - } - }, - "scheduledByFilters": { - "target": "com.amazonaws.inspector2#CisScheduledByFilterList", - "traits": { - "smithy.api#documentation": "

The list of scheduled by filters.

" - } - }, - "failedChecksFilters": { - "target": "com.amazonaws.inspector2#CisNumberFilterList", - "traits": { - "smithy.api#documentation": "

The list of failed checks filters.

" - } - }, - "targetAccountIdFilters": { - "target": "com.amazonaws.inspector2#AccountIdFilterList", - "traits": { - "smithy.api#documentation": "

The list of target account ID filters.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A list of CIS scans filter criteria.

" - } - }, - "com.amazonaws.inspector2#ListCisScansMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.inspector2#ListCisScansRequest": { - "type": "structure", - "members": { - "filterCriteria": { - "target": "com.amazonaws.inspector2#ListCisScansFilterCriteria", - "traits": { - "smithy.api#documentation": "

The CIS scan filter criteria.

" - } - }, - "detailLevel": { - "target": "com.amazonaws.inspector2#ListCisScansDetailLevel", - "traits": { - "smithy.api#documentation": "

The detail applied to the CIS scan.

" - } - }, - "sortBy": { - "target": "com.amazonaws.inspector2#ListCisScansSortBy", - "traits": { - "smithy.api#default": "SCAN_START_DATE", - "smithy.api#documentation": "

The CIS scans sort by order.

" - } - }, - "sortOrder": { - "target": "com.amazonaws.inspector2#CisSortOrder", - "traits": { - "smithy.api#documentation": "

The CIS scans sort order.

" - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token from a previous request that's used to retrieve the next page of results.

" - } - }, - "maxResults": { - "target": "com.amazonaws.inspector2#ListCisScansMaxResults", - "traits": { - "smithy.api#default": 100, - "smithy.api#documentation": "

The maximum number of results to be returned.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#ListCisScansResponse": { - "type": "structure", - "members": { - "scans": { - "target": "com.amazonaws.inspector2#CisScanList", - "traits": { - "smithy.api#documentation": "

The CIS scans.

" - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token from a previous request that's used to retrieve the next page of results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#ListCisScansSortBy": { - "type": "enum", - "members": { - "STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STATUS" - } - }, - "SCHEDULED_BY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCHEDULED_BY" - } - }, - "SCAN_START_DATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCAN_START_DATE" - } - }, - "FAILED_CHECKS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_CHECKS" - } - } - } - }, - "com.amazonaws.inspector2#ListCoverage": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#ListCoverageRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#ListCoverageResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists coverage details for you environment.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/coverage/list" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "coveredResources" - } - } - }, - "com.amazonaws.inspector2#ListCoverageMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.inspector2#ListCoverageRequest": { - "type": "structure", - "members": { - "maxResults": { - "target": "com.amazonaws.inspector2#ListCoverageMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

" - } - }, - "filterCriteria": { - "target": "com.amazonaws.inspector2#CoverageFilterCriteria", - "traits": { - "smithy.api#documentation": "

An object that contains details on the filters to apply to the coverage data for your\n environment.

" - } - } - } - }, - "com.amazonaws.inspector2#ListCoverageResponse": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" - } - }, - "coveredResources": { - "target": "com.amazonaws.inspector2#CoveredResources", - "traits": { - "smithy.api#documentation": "

An object that contains details on the covered resources in your environment.

" - } - } - } - }, - "com.amazonaws.inspector2#ListCoverageStatistics": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#ListCoverageStatisticsRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#ListCoverageStatisticsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists Amazon Inspector coverage statistics for your environment.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/coverage/statistics/list" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "countsByGroup" - } - } - }, - "com.amazonaws.inspector2#ListCoverageStatisticsRequest": { - "type": "structure", - "members": { - "filterCriteria": { - "target": "com.amazonaws.inspector2#CoverageFilterCriteria", - "traits": { - "smithy.api#documentation": "

An object that contains details on the filters to apply to the coverage data for your\n environment.

" - } - }, - "groupBy": { - "target": "com.amazonaws.inspector2#GroupKey", - "traits": { - "smithy.api#documentation": "

The value to group the results by.

" - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" - } - } - } - }, - "com.amazonaws.inspector2#ListCoverageStatisticsResponse": { - "type": "structure", - "members": { - "countsByGroup": { - "target": "com.amazonaws.inspector2#CountsList", - "traits": { - "smithy.api#documentation": "

An array with the number for each group.

" - } - }, - "totalCounts": { - "target": "smithy.api#Long", - "traits": { - "smithy.api#documentation": "

The total number for all groups.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" - } - } - } - }, - "com.amazonaws.inspector2#ListDelegatedAdminAccounts": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#ListDelegatedAdminAccountsRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#ListDelegatedAdminAccountsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists information about the Amazon Inspector delegated administrator of your\n organization.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/delegatedadminaccounts/list" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "delegatedAdminAccounts" - } - } - }, - "com.amazonaws.inspector2#ListDelegatedAdminAccountsRequest": { - "type": "structure", - "members": { - "maxResults": { - "target": "com.amazonaws.inspector2#ListDelegatedAdminMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

" - } - } - } - }, - "com.amazonaws.inspector2#ListDelegatedAdminAccountsResponse": { - "type": "structure", - "members": { - "delegatedAdminAccounts": { - "target": "com.amazonaws.inspector2#DelegatedAdminAccountList", - "traits": { - "smithy.api#documentation": "

Details of the Amazon Inspector delegated administrator of your organization.

" - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" - } - } - } - }, - "com.amazonaws.inspector2#ListDelegatedAdminMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.inspector2#ListFilterMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.inspector2#ListFilters": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#ListFiltersRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#ListFiltersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the filters associated with your account.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/filters/list" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "filters" - } - } - }, - "com.amazonaws.inspector2#ListFiltersRequest": { - "type": "structure", - "members": { - "arns": { - "target": "com.amazonaws.inspector2#FilterArnList", - "traits": { - "smithy.api#documentation": "

The Amazon resource number (ARN) of the filter.

" - } - }, - "action": { - "target": "com.amazonaws.inspector2#FilterAction", - "traits": { - "smithy.api#documentation": "

The action the filter applies to matched findings.

" - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

" - } - }, - "maxResults": { - "target": "com.amazonaws.inspector2#ListFilterMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" - } - } - } - }, - "com.amazonaws.inspector2#ListFiltersResponse": { - "type": "structure", - "members": { - "filters": { - "target": "com.amazonaws.inspector2#FilterList", - "traits": { - "smithy.api#documentation": "

Contains details on the filters associated with your account.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" - } - } - } - }, - "com.amazonaws.inspector2#ListFindingAggregations": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#ListFindingAggregationsRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#ListFindingAggregationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists aggregated finding data for your environment based on specific criteria.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/findings/aggregation/list" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "responses" - } - } - }, - "com.amazonaws.inspector2#ListFindingAggregationsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.inspector2#ListFindingAggregationsRequest": { - "type": "structure", - "members": { - "aggregationType": { - "target": "com.amazonaws.inspector2#AggregationType", - "traits": { - "smithy.api#documentation": "

The type of the aggregation request.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

" - } - }, - "maxResults": { - "target": "com.amazonaws.inspector2#ListFindingAggregationsMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" - } - }, - "accountIds": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account IDs to retrieve finding aggregation data for.

" - } - }, - "aggregationRequest": { - "target": "com.amazonaws.inspector2#AggregationRequest", - "traits": { - "smithy.api#documentation": "

Details of the aggregation request that is used to filter your aggregation results.

" - } - } - } - }, - "com.amazonaws.inspector2#ListFindingAggregationsResponse": { - "type": "structure", - "members": { - "aggregationType": { - "target": "com.amazonaws.inspector2#AggregationType", - "traits": { - "smithy.api#documentation": "

The type of aggregation to perform.

", - "smithy.api#required": {} - } - }, - "responses": { - "target": "com.amazonaws.inspector2#AggregationResponseList", - "traits": { - "smithy.api#documentation": "

Objects that contain the results of an aggregation operation.

" - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" - } - } - } - }, - "com.amazonaws.inspector2#ListFindings": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#ListFindingsRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#ListFindingsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists findings for your environment.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/findings/list" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "findings" - } - } - }, - "com.amazonaws.inspector2#ListFindingsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.inspector2#ListFindingsRequest": { - "type": "structure", - "members": { - "maxResults": { - "target": "com.amazonaws.inspector2#ListFindingsMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

" - } - }, - "filterCriteria": { - "target": "com.amazonaws.inspector2#FilterCriteria", - "traits": { - "smithy.api#documentation": "

Details on the filters to apply to your finding results.

" - } - }, - "sortCriteria": { - "target": "com.amazonaws.inspector2#SortCriteria", - "traits": { - "smithy.api#documentation": "

Details on the sort criteria to apply to your finding results.

" - } - } - } - }, - "com.amazonaws.inspector2#ListFindingsResponse": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" - } - }, - "findings": { - "target": "com.amazonaws.inspector2#FindingList", - "traits": { - "smithy.api#documentation": "

Contains details on the findings in your environment.

" - } - } - } - }, - "com.amazonaws.inspector2#ListMembers": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#ListMembersRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#ListMembersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

List members associated with the Amazon Inspector delegated administrator for your\n organization.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/members/list" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "members" - } - } - }, - "com.amazonaws.inspector2#ListMembersMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.inspector2#ListMembersRequest": { - "type": "structure", - "members": { - "onlyAssociated": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether to list only currently associated members if True or to\n list all members within the organization if False.

" - } - }, - "maxResults": { - "target": "com.amazonaws.inspector2#ListMembersMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

" - } - } - } - }, - "com.amazonaws.inspector2#ListMembersResponse": { - "type": "structure", - "members": { - "members": { - "target": "com.amazonaws.inspector2#MemberList", - "traits": { - "smithy.api#documentation": "

An object that contains details for each member account.

" - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination parameter to be used on the next list operation to retrieve more\n items.

" - } - } - } - }, - "com.amazonaws.inspector2#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all tags attached to a given resource.

", - "smithy.api#http": { - "uri": "/tags/{resourceArn}", - "method": "GET" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.inspector2#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.inspector2#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon resource number (ARN) of the resource to list tags of.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.inspector2#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.inspector2#TagMap", - "traits": { - "smithy.api#documentation": "

The tags associated with the resource.

" - } - } - } - }, - "com.amazonaws.inspector2#ListUsageTotals": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#ListUsageTotalsRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#ListUsageTotalsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the Amazon Inspector usage totals over the last 30 days.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/usage/list" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "totals" - } - } - }, - "com.amazonaws.inspector2#ListUsageTotalsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 500 - } - } - }, - "com.amazonaws.inspector2#ListUsageTotalsNextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.inspector2#ListUsageTotalsRequest": { - "type": "structure", - "members": { - "maxResults": { - "target": "com.amazonaws.inspector2#ListUsageTotalsMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#ListUsageTotalsNextToken", - "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

" - } - }, - "accountIds": { - "target": "com.amazonaws.inspector2#UsageAccountIdList", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account IDs to retrieve usage totals for.

" - } - } - } - }, - "com.amazonaws.inspector2#ListUsageTotalsResponse": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.inspector2#ListUsageTotalsNextToken", - "traits": { - "smithy.api#documentation": "

The pagination parameter to be used on the next list operation to retrieve more items.

" - } - }, - "totals": { - "target": "com.amazonaws.inspector2#UsageTotalList", - "traits": { - "smithy.api#documentation": "

An object with details on the total usage for the requested account.

" - } - } - } - }, - "com.amazonaws.inspector2#MapComparison": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EQUALS", - "name": "EQUALS" - } - ] - } - }, - "com.amazonaws.inspector2#MapFilter": { - "type": "structure", - "members": { - "comparison": { - "target": "com.amazonaws.inspector2#MapComparison", - "traits": { - "smithy.api#documentation": "

The operator to use when comparing values in the filter.

", - "smithy.api#required": {} - } - }, - "key": { - "target": "com.amazonaws.inspector2#MapKey", - "traits": { - "smithy.api#documentation": "

The tag key used in the filter.

", - "smithy.api#required": {} - } - }, - "value": { - "target": "com.amazonaws.inspector2#MapValue", - "traits": { - "smithy.api#documentation": "

The tag value used in the filter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that describes details of a map filter.

" - } - }, - "com.amazonaws.inspector2#MapFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#MapFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#MapKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.inspector2#MapValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 256 - } - } - }, - "com.amazonaws.inspector2#Member": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the member account.

" - } - }, - "relationshipStatus": { - "target": "com.amazonaws.inspector2#RelationshipStatus", - "traits": { - "smithy.api#documentation": "

The status of the member account.

" - } - }, - "delegatedAdminAccountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the Amazon Inspector delegated administrator for this member account.

" - } - }, - "updatedAt": { - "target": "com.amazonaws.inspector2#DateTimeTimestamp", - "traits": { - "smithy.api#documentation": "

A timestamp showing when the status of this member was last updated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details on a member account in your organization.

" - } - }, - "com.amazonaws.inspector2#MemberAccountEc2DeepInspectionStatus": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the Amazon Web Services account of the organization member.

", - "smithy.api#required": {} - } - }, - "activateDeepInspection": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Whether Amazon Inspector deep inspection is active in the account. If TRUE Amazon Inspector deep inspection is active, if FALSE it is not active.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains details about the status of Amazon Inspector deep inspection for a member account in your organization.

" - } - }, - "com.amazonaws.inspector2#MemberAccountEc2DeepInspectionStatusList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#MemberAccountEc2DeepInspectionStatus" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.inspector2#MemberAccountEc2DeepInspectionStatusState": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the Amazon Web Services account of the organization member

", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.inspector2#Ec2DeepInspectionStatus", - "traits": { - "smithy.api#documentation": "

The state of Amazon Inspector deep inspection in the member account.

" - } - }, - "errorMessage": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The error message explaining why the account failed to activate Amazon Inspector deep inspection.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains details about the state of Amazon Inspector deep inspection for a member account.

" - } - }, - "com.amazonaws.inspector2#MemberAccountEc2DeepInspectionStatusStateList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#MemberAccountEc2DeepInspectionStatusState" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.inspector2#MemberList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#Member" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.inspector2#MeteringAccountId": { - "type": "string", - "traits": { - "smithy.api#pattern": "[0-9]{12}" - } - }, - "com.amazonaws.inspector2#MeteringAccountIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#MeteringAccountId" - } - }, - "com.amazonaws.inspector2#MonthlyCostEstimate": { - "type": "double", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.inspector2#MonthlySchedule": { - "type": "structure", - "members": { - "startTime": { - "target": "com.amazonaws.inspector2#Time", - "traits": { - "smithy.api#documentation": "

The monthly schedule's start time.

", - "smithy.api#required": {} - } - }, - "day": { - "target": "com.amazonaws.inspector2#Day", - "traits": { - "smithy.api#documentation": "

The monthly schedule's day.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A monthly schedule.

" - } - }, - "com.amazonaws.inspector2#NetworkPath": { - "type": "structure", - "members": { - "steps": { - "target": "com.amazonaws.inspector2#StepList", - "traits": { - "smithy.api#documentation": "

The details on the steps in the network path.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information on the network path associated with a finding.

" - } - }, - "com.amazonaws.inspector2#NetworkProtocol": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TCP", - "name": "TCP" - }, - { - "value": "UDP", - "name": "UDP" - } - ] - } - }, - "com.amazonaws.inspector2#NetworkReachabilityDetails": { - "type": "structure", - "members": { - "openPortRange": { - "target": "com.amazonaws.inspector2#PortRange", - "traits": { - "smithy.api#documentation": "

An object that contains details about the open port range associated with a finding.

", - "smithy.api#required": {} - } - }, - "protocol": { - "target": "com.amazonaws.inspector2#NetworkProtocol", - "traits": { - "smithy.api#documentation": "

The protocol associated with a finding.

", - "smithy.api#required": {} - } - }, - "networkPath": { - "target": "com.amazonaws.inspector2#NetworkPath", - "traits": { - "smithy.api#documentation": "

An object that contains details about a network path associated with a finding.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the details of a network reachability finding.

" - } - }, - "com.amazonaws.inspector2#NextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 1000000 - } - } - }, - "com.amazonaws.inspector2#NonEmptyString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.inspector2#NonEmptyStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#NonEmptyString" - } - }, - "com.amazonaws.inspector2#NumberFilter": { - "type": "structure", - "members": { - "upperInclusive": { - "target": "smithy.api#Double", - "traits": { - "smithy.api#documentation": "

The highest number to be included in the filter.

" - } - }, - "lowerInclusive": { - "target": "smithy.api#Double", - "traits": { - "smithy.api#documentation": "

The lowest number to be included in the filter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that describes the details of a number filter.

" - } - }, - "com.amazonaws.inspector2#NumberFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#NumberFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#OneAccountIdFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisStringFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.inspector2#OneTimeSchedule": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

A one time schedule.

" - } - }, - "com.amazonaws.inspector2#Operation": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ENABLE_SCANNING", - "name": "ENABLE_SCANNING" - }, - { - "value": "DISABLE_SCANNING", - "name": "DISABLE_SCANNING" - }, - { - "value": "ENABLE_REPOSITORY", - "name": "ENABLE_REPOSITORY" - }, - { - "value": "DISABLE_REPOSITORY", - "name": "DISABLE_REPOSITORY" - } - ] - } - }, - "com.amazonaws.inspector2#OwnerId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 12, - "max": 34 - }, - "smithy.api#pattern": "(^\\d{12}$)|(^o-[a-z0-9]{10,32}$)" - } - }, - "com.amazonaws.inspector2#PackageAggregation": { - "type": "structure", - "members": { - "packageNames": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The names of packages to aggregate findings on.

" - } - }, - "sortOrder": { - "target": "com.amazonaws.inspector2#SortOrder", - "traits": { - "smithy.api#documentation": "

The order to sort results by.

" - } - }, - "sortBy": { - "target": "com.amazonaws.inspector2#PackageSortBy", - "traits": { - "smithy.api#documentation": "

The value to sort results by.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The details that define an aggregation based on operating system package type.

" - } - }, - "com.amazonaws.inspector2#PackageAggregationResponse": { - "type": "structure", - "members": { - "packageName": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the operating system package.

", - "smithy.api#required": {} - } - }, - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account associated with the findings.

" - } - }, - "severityCounts": { - "target": "com.amazonaws.inspector2#SeverityCounts", - "traits": { - "smithy.api#documentation": "

An object that contains the count of matched findings per severity.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A response that contains the results of a finding aggregation by image layer.

" - } - }, - "com.amazonaws.inspector2#PackageArchitecture": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.inspector2#PackageEpoch": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.inspector2#PackageFilter": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.inspector2#StringFilter", - "traits": { - "smithy.api#documentation": "

An object that contains details on the name of the package to filter on.

" - } - }, - "version": { - "target": "com.amazonaws.inspector2#StringFilter", - "traits": { - "smithy.api#documentation": "

The package version to filter on.

" - } - }, - "epoch": { - "target": "com.amazonaws.inspector2#NumberFilter", - "traits": { - "smithy.api#documentation": "

An object that contains details on the package epoch to filter on.

" - } - }, - "release": { - "target": "com.amazonaws.inspector2#StringFilter", - "traits": { - "smithy.api#documentation": "

An object that contains details on the package release to filter on.

" - } - }, - "architecture": { - "target": "com.amazonaws.inspector2#StringFilter", - "traits": { - "smithy.api#documentation": "

An object that contains details on the package architecture type to filter on.

" - } - }, - "sourceLayerHash": { - "target": "com.amazonaws.inspector2#StringFilter", - "traits": { - "smithy.api#documentation": "

An object that contains details on the source layer hash to filter on.

" - } - }, - "sourceLambdaLayerArn": { - "target": "com.amazonaws.inspector2#StringFilter" - } - }, - "traits": { - "smithy.api#documentation": "

Contains information on the details of a package filter.

" - } - }, - "com.amazonaws.inspector2#PackageFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#PackageFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#PackageManager": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "BUNDLER", - "name": "BUNDLER" - }, - { - "value": "CARGO", - "name": "CARGO" - }, - { - "value": "COMPOSER", - "name": "COMPOSER" - }, - { - "value": "NPM", - "name": "NPM" - }, - { - "value": "NUGET", - "name": "NUGET" - }, - { - "value": "PIPENV", - "name": "PIPENV" - }, - { - "value": "POETRY", - "name": "POETRY" - }, - { - "value": "YARN", - "name": "YARN" - }, - { - "value": "GOBINARY", - "name": "GOBINARY" - }, - { - "value": "GOMOD", - "name": "GOMOD" - }, - { - "value": "JAR", - "name": "JAR" - }, - { - "value": "OS", - "name": "OS" - }, - { - "value": "PIP", - "name": "PIP" - }, - { - "value": "PYTHONPKG", - "name": "PYTHONPKG" - }, - { - "value": "NODEPKG", - "name": "NODEPKG" - }, - { - "value": "POM", - "name": "POM" - }, - { - "value": "GEMSPEC", - "name": "GEMSPEC" - } - ] - } - }, - "com.amazonaws.inspector2#PackageName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.inspector2#PackageRelease": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.inspector2#PackageSortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CRITICAL", - "name": "CRITICAL" - }, - { - "value": "HIGH", - "name": "HIGH" - }, - { - "value": "ALL", - "name": "ALL" - } - ] - } - }, - "com.amazonaws.inspector2#PackageType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "IMAGE", - "name": "IMAGE" - }, - { - "value": "ZIP", - "name": "ZIP" - } - ] - } - }, - "com.amazonaws.inspector2#PackageVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.inspector2#PackageVulnerabilityDetails": { - "type": "structure", - "members": { - "vulnerabilityId": { - "target": "com.amazonaws.inspector2#VulnerabilityId", - "traits": { - "smithy.api#documentation": "

The ID given to this vulnerability.

", - "smithy.api#required": {} - } - }, - "vulnerablePackages": { - "target": "com.amazonaws.inspector2#VulnerablePackageList", - "traits": { - "smithy.api#documentation": "

The packages impacted by this vulnerability.

" - } - }, - "source": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The source of the vulnerability information.

", - "smithy.api#required": {} - } - }, - "cvss": { - "target": "com.amazonaws.inspector2#CvssScoreList", - "traits": { - "smithy.api#documentation": "

An object that contains details about the CVSS score of a finding.

" - } - }, - "relatedVulnerabilities": { - "target": "com.amazonaws.inspector2#VulnerabilityIdList", - "traits": { - "smithy.api#documentation": "

One or more vulnerabilities related to the one identified in this finding.

" - } - }, - "sourceUrl": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A URL to the source of the vulnerability information.

" - } - }, - "vendorSeverity": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The severity the vendor has given to this vulnerability type.

" - } - }, - "vendorCreatedAt": { - "target": "com.amazonaws.inspector2#DateTimeTimestamp", - "traits": { - "smithy.api#documentation": "

The date and time that this vulnerability was first added to the vendor's database.

" - } - }, - "vendorUpdatedAt": { - "target": "com.amazonaws.inspector2#DateTimeTimestamp", - "traits": { - "smithy.api#documentation": "

The date and time the vendor last updated this vulnerability in their database.

" - } - }, - "referenceUrls": { - "target": "com.amazonaws.inspector2#NonEmptyStringList", - "traits": { - "smithy.api#documentation": "

One or more URLs that contain details about this vulnerability type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a package vulnerability finding.

" - } - }, - "com.amazonaws.inspector2#Path": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - }, - "smithy.api#pattern": "^(?:/(?:\\.[-\\w]+|[-\\w]+(?:\\.[-\\w]+)?))+/?$" - } - }, - "com.amazonaws.inspector2#PathList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#Path" - }, - "traits": { - "smithy.api#length": { - "max": 5 - } - } - }, - "com.amazonaws.inspector2#Permission": { - "type": "structure", - "members": { - "service": { - "target": "com.amazonaws.inspector2#Service", - "traits": { - "smithy.api#documentation": "

The services that the permissions allow an account to perform the given operations for.

", - "smithy.api#required": {} - } - }, - "operation": { - "target": "com.amazonaws.inspector2#Operation", - "traits": { - "smithy.api#documentation": "

The operations that can be performed with the given permissions.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains information on the permissions an account has within Amazon Inspector.

" - } - }, - "com.amazonaws.inspector2#Permissions": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#Permission" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.inspector2#Platform": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.inspector2#PlatformFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisStringFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#PlatformVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 8 - } - } - }, - "com.amazonaws.inspector2#Port": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 65535 - } - } - }, - "com.amazonaws.inspector2#PortRange": { - "type": "structure", - "members": { - "begin": { - "target": "com.amazonaws.inspector2#Port", - "traits": { - "smithy.api#documentation": "

The beginning port in a port range.

", - "smithy.api#required": {} - } - }, - "end": { - "target": "com.amazonaws.inspector2#Port", - "traits": { - "smithy.api#documentation": "

The ending port in a port range.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the port range associated with a finding.

" - } - }, - "com.amazonaws.inspector2#PortRangeFilter": { - "type": "structure", - "members": { - "beginInclusive": { - "target": "com.amazonaws.inspector2#Port", - "traits": { - "smithy.api#documentation": "

The port number the port range begins at.

" - } - }, - "endInclusive": { - "target": "com.amazonaws.inspector2#Port", - "traits": { - "smithy.api#documentation": "

The port number the port range ends at.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that describes the details of a port range filter.

" - } - }, - "com.amazonaws.inspector2#PortRangeFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#PortRangeFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#Product": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 32 - } - } - }, - "com.amazonaws.inspector2#Reason": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 1024 - } - } - }, - "com.amazonaws.inspector2#Recommendation": { - "type": "structure", - "members": { - "text": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The recommended course of action to remediate the finding.

" - } - }, - "Url": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The URL address to the CVE remediation recommendations.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the recommended course of action to remediate the finding.

" - } - }, - "com.amazonaws.inspector2#ReferenceUrls": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#NonEmptyString" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#RelatedVulnerabilities": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#RelatedVulnerability" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.inspector2#RelatedVulnerability": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0 - } - } - }, - "com.amazonaws.inspector2#RelationshipStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATED", - "name": "CREATED" - }, - { - "value": "INVITED", - "name": "INVITED" - }, - { - "value": "DISABLED", - "name": "DISABLED" - }, - { - "value": "ENABLED", - "name": "ENABLED" - }, - { - "value": "REMOVED", - "name": "REMOVED" - }, - { - "value": "RESIGNED", - "name": "RESIGNED" - }, - { - "value": "DELETED", - "name": "DELETED" - }, - { - "value": "EMAIL_VERIFICATION_IN_PROGRESS", - "name": "EMAIL_VERIFICATION_IN_PROGRESS" - }, - { - "value": "EMAIL_VERIFICATION_FAILED", - "name": "EMAIL_VERIFICATION_FAILED" - }, - { - "value": "REGION_DISABLED", - "name": "REGION_DISABLED" - }, - { - "value": "ACCOUNT_SUSPENDED", - "name": "ACCOUNT_SUSPENDED" - }, - { - "value": "CANNOT_CREATE_DETECTOR_IN_ORG_MASTER", - "name": "CANNOT_CREATE_DETECTOR_IN_ORG_MASTER" - } - ] - } - }, - "com.amazonaws.inspector2#Remediation": { - "type": "structure", - "members": { - "recommendation": { - "target": "com.amazonaws.inspector2#Recommendation", - "traits": { - "smithy.api#documentation": "

An object that contains information about the recommended course of action to remediate the finding.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information on how to remediate a finding.

" - } - }, - "com.amazonaws.inspector2#ReportFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CSV", - "name": "CSV" - }, - { - "value": "JSON", - "name": "JSON" - } - ] - } - }, - "com.amazonaws.inspector2#ReportId": { - "type": "string", - "traits": { - "smithy.api#pattern": "\\b[a-f0-9]{8}\\b-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-\\b[a-f0-9]{12}\\b" - } - }, - "com.amazonaws.inspector2#ReportTargetAccounts": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#AccountId" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.inspector2#ReportingErrorCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "INTERNAL_ERROR", - "name": "INTERNAL_ERROR" - }, - { - "value": "INVALID_PERMISSIONS", - "name": "INVALID_PERMISSIONS" - }, - { - "value": "NO_FINDINGS_FOUND", - "name": "NO_FINDINGS_FOUND" - }, - { - "value": "BUCKET_NOT_FOUND", - "name": "BUCKET_NOT_FOUND" - }, - { - "value": "INCOMPATIBLE_BUCKET_REGION", - "name": "INCOMPATIBLE_BUCKET_REGION" - }, - { - "value": "MALFORMED_KMS_KEY", - "name": "MALFORMED_KMS_KEY" - } - ] - } - }, - "com.amazonaws.inspector2#RepositoryAggregation": { - "type": "structure", - "members": { - "repositories": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The names of repositories to aggregate findings on.

" - } - }, - "sortOrder": { - "target": "com.amazonaws.inspector2#SortOrder", - "traits": { - "smithy.api#documentation": "

The order to sort results by.

" - } - }, - "sortBy": { - "target": "com.amazonaws.inspector2#RepositorySortBy", - "traits": { - "smithy.api#documentation": "

The value to sort results by.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The details that define an aggregation based on repository.

" - } - }, - "com.amazonaws.inspector2#RepositoryAggregationResponse": { - "type": "structure", - "members": { - "repository": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the repository associated with the findings.

", - "smithy.api#required": {} - } - }, - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account associated with the findings.

" - } - }, - "severityCounts": { - "target": "com.amazonaws.inspector2#SeverityCounts", - "traits": { - "smithy.api#documentation": "

An object that represent the count of matched findings per severity.

" - } - }, - "affectedImages": { - "target": "smithy.api#Long", - "traits": { - "smithy.api#documentation": "

The number of container images impacted by the findings.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A response that contains details on the results of a finding aggregation by repository.

" - } - }, - "com.amazonaws.inspector2#RepositorySortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CRITICAL", - "name": "CRITICAL" - }, - { - "value": "HIGH", - "name": "HIGH" - }, - { - "value": "ALL", - "name": "ALL" - }, - { - "value": "AFFECTED_IMAGES", - "name": "AFFECTED_IMAGES" - } - ] - } - }, - "com.amazonaws.inspector2#ResetEncryptionKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#ResetEncryptionKeyRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#ResetEncryptionKeyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Resets an encryption key. After the key is reset your resources will be encrypted by an Amazon Web Services owned key.

", - "smithy.api#http": { - "code": 200, - "method": "PUT", - "uri": "/encryptionkey/reset" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.inspector2#ResetEncryptionKeyRequest": { - "type": "structure", - "members": { - "scanType": { - "target": "com.amazonaws.inspector2#ScanType", - "traits": { - "smithy.api#documentation": "

The scan type the key encrypts.

", - "smithy.api#required": {} - } - }, - "resourceType": { - "target": "com.amazonaws.inspector2#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type the key encrypts.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#ResetEncryptionKeyResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#Resource": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.inspector2#ResourceType", - "traits": { - "smithy.api#documentation": "

The type of resource.

", - "smithy.api#required": {} - } - }, - "id": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID of the resource.

", - "smithy.api#required": {} - } - }, - "partition": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The partition of the resource.

" - } - }, - "region": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region the impacted resource is located in.

" - } - }, - "tags": { - "target": "com.amazonaws.inspector2#TagMap", - "traits": { - "smithy.api#documentation": "

The tags attached to the resource.

" - } - }, - "details": { - "target": "com.amazonaws.inspector2#ResourceDetails", - "traits": { - "smithy.api#documentation": "

An object that contains details about the resource involved in a finding.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the resource involved in a finding.

" - } - }, - "com.amazonaws.inspector2#ResourceDetails": { - "type": "structure", - "members": { - "awsEc2Instance": { - "target": "com.amazonaws.inspector2#AwsEc2InstanceDetails", - "traits": { - "smithy.api#documentation": "

An object that contains details about the Amazon EC2 instance involved in the finding.

" - } - }, - "awsEcrContainerImage": { - "target": "com.amazonaws.inspector2#AwsEcrContainerImageDetails", - "traits": { - "smithy.api#documentation": "

An object that contains details about the Amazon ECR container image involved in the finding.

" - } - }, - "awsLambdaFunction": { - "target": "com.amazonaws.inspector2#AwsLambdaFunctionDetails", - "traits": { - "smithy.api#documentation": "

A summary of the information about an Amazon Web Services Lambda function affected by a finding.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details about the resource involved in the finding.

" - } - }, - "com.amazonaws.inspector2#ResourceFilterCriteria": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.inspector2#ResourceStringFilterList", - "traits": { - "smithy.api#documentation": "

The account IDs used as resource filter criteria.

" - } - }, - "resourceId": { - "target": "com.amazonaws.inspector2#ResourceStringFilterList", - "traits": { - "smithy.api#documentation": "

The resource IDs used as resource filter criteria.

" - } - }, - "resourceType": { - "target": "com.amazonaws.inspector2#ResourceStringFilterList", - "traits": { - "smithy.api#documentation": "

The resource types used as resource filter criteria.

" - } - }, - "ecrRepositoryName": { - "target": "com.amazonaws.inspector2#ResourceStringFilterList", - "traits": { - "smithy.api#documentation": "

The ECR repository names used as resource filter criteria.

" - } - }, - "lambdaFunctionName": { - "target": "com.amazonaws.inspector2#ResourceStringFilterList", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Lambda function name used as resource filter criteria.

" - } - }, - "ecrImageTags": { - "target": "com.amazonaws.inspector2#ResourceStringFilterList", - "traits": { - "smithy.api#documentation": "

The ECR image tags used as resource filter criteria.

" - } - }, - "ec2InstanceTags": { - "target": "com.amazonaws.inspector2#ResourceMapFilterList", - "traits": { - "smithy.api#documentation": "

The EC2 instance tags used as resource filter criteria.

" - } - }, - "lambdaFunctionTags": { - "target": "com.amazonaws.inspector2#ResourceMapFilterList", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Lambda function tags used as resource filter criteria.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The resource filter criteria for a Software bill of materials (SBOM) report.

" - } - }, - "com.amazonaws.inspector2#ResourceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 10, - "max": 341 - }, - "smithy.api#pattern": "(^arn:.*:ecr:.*:\\d{12}:repository\\/(?:[a-z0-9]+(?:[._-][a-z0-9]+)*\\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*(\\/sha256:[a-z0-9]{64})?$)|(^i-([a-z0-9]{8}|[a-z0-9]{17}|\\\\*)$|(^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$))" - } - }, - "com.amazonaws.inspector2#ResourceIdFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisStringFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#ResourceList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#Resource" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#ResourceMapComparison": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EQUALS", - "name": "EQUALS" - } - ] - } - }, - "com.amazonaws.inspector2#ResourceMapFilter": { - "type": "structure", - "members": { - "comparison": { - "target": "com.amazonaws.inspector2#ResourceMapComparison", - "traits": { - "smithy.api#documentation": "

The filter's comparison.

", - "smithy.api#required": {} - } - }, - "key": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The filter's key.

", - "smithy.api#required": {} - } - }, - "value": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The filter's value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A resource map filter for a software bill of material report.

" - } - }, - "com.amazonaws.inspector2#ResourceMapFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#ResourceMapFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.inspector2#ResourceScanMetadata": { - "type": "structure", - "members": { - "ecrRepository": { - "target": "com.amazonaws.inspector2#EcrRepositoryMetadata", - "traits": { - "smithy.api#documentation": "

An object that contains details about the repository an Amazon ECR image resides in.

" - } - }, - "ecrImage": { - "target": "com.amazonaws.inspector2#EcrContainerImageMetadata", - "traits": { - "smithy.api#documentation": "

An object that contains details about the container metadata for an Amazon ECR image.

" - } - }, - "ec2": { - "target": "com.amazonaws.inspector2#Ec2Metadata", - "traits": { - "smithy.api#documentation": "

An object that contains metadata details for an Amazon EC2 instance.

" - } - }, - "lambdaFunction": { - "target": "com.amazonaws.inspector2#LambdaFunctionMetadata", - "traits": { - "smithy.api#documentation": "

An object that contains metadata details for an Amazon Web Services Lambda function.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains details about the metadata for an Amazon ECR resource.

" - } - }, - "com.amazonaws.inspector2#ResourceScanType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EC2", - "name": "EC2" - }, - { - "value": "ECR", - "name": "ECR" - }, - { - "value": "LAMBDA", - "name": "LAMBDA" - }, - { - "value": "LAMBDA_CODE", - "name": "LAMBDA_CODE" - } - ] - } - }, - "com.amazonaws.inspector2#ResourceState": { - "type": "structure", - "members": { - "ec2": { - "target": "com.amazonaws.inspector2#State", - "traits": { - "smithy.api#documentation": "

An object detailing the state of Amazon Inspector scanning for Amazon EC2 resources.

", - "smithy.api#required": {} - } - }, - "ecr": { - "target": "com.amazonaws.inspector2#State", - "traits": { - "smithy.api#documentation": "

An object detailing the state of Amazon Inspector scanning for Amazon ECR resources.

", - "smithy.api#required": {} - } - }, - "lambda": { - "target": "com.amazonaws.inspector2#State" - }, - "lambdaCode": { - "target": "com.amazonaws.inspector2#State" - } - }, - "traits": { - "smithy.api#documentation": "

Details the state of Amazon Inspector for each resource type Amazon Inspector scans.

" - } - }, - "com.amazonaws.inspector2#ResourceStatus": { - "type": "structure", - "members": { - "ec2": { - "target": "com.amazonaws.inspector2#Status", - "traits": { - "smithy.api#documentation": "

The status of Amazon Inspector scanning for Amazon EC2 resources.

", - "smithy.api#required": {} - } - }, - "ecr": { - "target": "com.amazonaws.inspector2#Status", - "traits": { - "smithy.api#documentation": "

The status of Amazon Inspector scanning for Amazon ECR resources.

", - "smithy.api#required": {} - } - }, - "lambda": { - "target": "com.amazonaws.inspector2#Status", - "traits": { - "smithy.api#documentation": "

The status of Amazon Inspector scanning for Amazon Web Services Lambda function.

" - } - }, - "lambdaCode": { - "target": "com.amazonaws.inspector2#Status", - "traits": { - "smithy.api#documentation": "

The status of Amazon Inspector scanning for custom application code for Amazon Web Services Lambda functions. \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details the status of Amazon Inspector for each resource type Amazon Inspector scans.

" - } - }, - "com.amazonaws.inspector2#ResourceStringComparison": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EQUALS", - "name": "EQUALS" - }, - { - "value": "NOT_EQUALS", - "name": "NOT_EQUALS" - } - ] - } - }, - "com.amazonaws.inspector2#ResourceStringFilter": { - "type": "structure", - "members": { - "comparison": { - "target": "com.amazonaws.inspector2#ResourceStringComparison", - "traits": { - "smithy.api#documentation": "

The filter's comparison.

", - "smithy.api#required": {} - } - }, - "value": { - "target": "com.amazonaws.inspector2#ResourceStringInput", - "traits": { - "smithy.api#documentation": "

The filter's value.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A resource string filter for a software bill of materials report.

" - } - }, - "com.amazonaws.inspector2#ResourceStringFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#ResourceStringFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#ResourceStringInput": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.inspector2#ResourceTagFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#TagFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#ResourceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AWS_EC2_INSTANCE", - "name": "AWS_EC2_INSTANCE" - }, - { - "value": "AWS_ECR_CONTAINER_IMAGE", - "name": "AWS_ECR_CONTAINER_IMAGE" - }, - { - "value": "AWS_ECR_REPOSITORY", - "name": "AWS_ECR_REPOSITORY" - }, - { - "value": "AWS_LAMBDA_FUNCTION", - "name": "AWS_LAMBDA_FUNCTION" - } - ] - } - }, - "com.amazonaws.inspector2#RiskScore": { - "type": "integer" - }, - "com.amazonaws.inspector2#RuleId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 500 - } - } - }, - "com.amazonaws.inspector2#Runtime": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NODEJS", - "name": "NODEJS" - }, - { - "value": "NODEJS_12_X", - "name": "NODEJS_12_X" - }, - { - "value": "NODEJS_14_X", - "name": "NODEJS_14_X" - }, - { - "value": "NODEJS_16_X", - "name": "NODEJS_16_X" - }, - { - "value": "JAVA_8", - "name": "JAVA_8" - }, - { - "value": "JAVA_8_AL2", - "name": "JAVA_8_AL2" - }, - { - "value": "JAVA_11", - "name": "JAVA_11" - }, - { - "value": "PYTHON_3_7", - "name": "PYTHON_3_7" - }, - { - "value": "PYTHON_3_8", - "name": "PYTHON_3_8" - }, - { - "value": "PYTHON_3_9", - "name": "PYTHON_3_9" - }, - { - "value": "UNSUPPORTED", - "name": "UNSUPPORTED" - }, - { - "value": "NODEJS_18_X", - "name": "NODEJS_18_X" - }, - { - "value": "GO_1_X", - "name": "GO_1_X" - }, - { - "value": "JAVA_17", - "name": "JAVA_17" - }, - { - "value": "PYTHON_3_10", - "name": "PYTHON_3_10" - } - ] - } - }, - "com.amazonaws.inspector2#SbomReportFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CYCLONEDX_1_4", - "name": "CYCLONEDX_1_4" - }, - { - "value": "SPDX_2_3", - "name": "SPDX_2_3" - } - ] - } - }, - "com.amazonaws.inspector2#ScanMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EC2_SSM_AGENT_BASED", - "name": "EC2_SSM_AGENT_BASED" - }, - { - "value": "EC2_AGENTLESS", - "name": "EC2_AGENTLESS" - } - ] - } - }, - "com.amazonaws.inspector2#ScanStatus": { - "type": "structure", - "members": { - "statusCode": { - "target": "com.amazonaws.inspector2#ScanStatusCode", - "traits": { - "smithy.api#documentation": "

The status code of the scan.

", - "smithy.api#required": {} - } - }, - "reason": { - "target": "com.amazonaws.inspector2#ScanStatusReason", - "traits": { - "smithy.api#documentation": "

The scan status. Possible return values and descriptions are:

\n

\n PENDING_INITIAL_SCAN - This resource has been identified for scanning, results will be available soon.

\n

\n ACCESS_DENIED - Resource access policy restricting Amazon Inspector access. Please update the IAM policy.

\n

\n INTERNAL_ERROR - Amazon Inspector has encountered an internal error for this resource. Amazon Inspector service will automatically resolve the issue and resume the scanning. No action required from the user.

\n

\n UNMANAGED_EC2_INSTANCE - The EC2 instance is not managed by SSM, please use the following SSM automation to remediate the issue: https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-awssupport-troubleshoot-managed-instance.html. Once the instance becomes managed by SSM, Inspector will automatically begin scanning this instance.

\n

\n UNSUPPORTED_OS - Amazon Inspector does not support this OS, architecture, or image manifest type at this time. To see a complete list of supported operating systems see: https://docs.aws.amazon.com/inspector/latest/user/supported.html.

\n

\n SCAN_ELIGIBILITY_EXPIRED - The configured scan duration has lapsed for this image.

\n

\n RESOURCE_TERMINATED - This resource has been terminated. The findings and coverage associated with this resource are in the process of being cleaned up.

\n

\n SUCCESSFUL - The scan was successful.

\n

\n NO_RESOURCES_FOUND - Reserved for future use.

\n

\n IMAGE_SIZE_EXCEEDED - Reserved for future use.

\n

\n SCAN_FREQUENCY_MANUAL - This image will not be covered by Amazon Inspector due to the repository scan frequency configuration.

\n

\n SCAN_FREQUENCY_SCAN_ON_PUSH - This image will be scanned one time and will not new findings because of the scan frequency configuration.

\n

\n EC2_INSTANCE_STOPPED - This EC2 instance is in a stopped state, therefore, Amazon Inspector will pause scanning. The existing findings will continue to exist until the instance is terminated. Once the instance is re-started, Inspector will automatically start scanning the instance again. Please note that you will not be charged for this instance while it’s in a stopped state.

\n

\n PENDING_DISABLE - This resource is pending cleanup during disablement. The customer will not be billed while a resource is in the pending disable status.

\n

\n NO INVENTORY - Amazon Inspector couldn’t find software application inventory to scan for vulnerabilities. This might be caused due to required Amazon Inspector associations being deleted or failing to run on your resource. Please verify the status of InspectorInventoryCollection-do-not-delete association in the SSM console for the resource. Additionally, you can verify the instance’s inventory in the SSM Fleet Manager console.

\n

\n STALE_INVENTORY - Amazon Inspector wasn’t able to collect an updated software application inventory in the last 7 days. Please confirm the required Amazon Inspector associations still exist and you can still see an updated inventory in the SSM console.

\n

\n EXCLUDED_BY_TAG - This resource was not scanned because it has been excluded by a tag.

\n

\n UNSUPPORTED_RUNTIME - The function was not scanned because it has an unsupported runtime. To see a complete list of supported runtimes see: https://docs.aws.amazon.com/inspector/latest/user/supported.html.

\n

\n UNSUPPORTED_MEDIA_TYPE - The ECR image has an unsupported media type.

\n

\n UNSUPPORTED_CONFIG_FILE - Reserved for future use.

\n

\n DEEP_INSPECTION_PACKAGE_COLLECTION_LIMIT_EXCEEDED - The instance has exceeded the 5000 package limit for Amazon Inspector Deep inspection. To resume Deep inspection for this instance you can try to adjust the custom paths associated with the account.

\n

\n DEEP_INSPECTION_DAILY_SSM_INVENTORY_LIMIT_EXCEEDED - The SSM agent couldn't send inventory to Amazon Inspector because the SSM quota for Inventory data collected per instance per day has already been reached for this instance.

\n

\n DEEP_INSPECTION_COLLECTION_TIME_LIMIT_EXCEEDED - Amazon Inspector failed to extract the package inventory because the package collection time exceeding the maximum threshold of 15 minutes.

\n

\n DEEP_INSPECTION_NO_INVENTORY The Amazon Inspector plugin hasn't yet been able to collect an inventory of packages for this instance. This is usually the result of a pending scan, however, if this status persists after 6 hours, use SSM to ensure that the required Amazon Inspector associations exist and are running for the instance.

\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The status of the scan.

" - } - }, - "com.amazonaws.inspector2#ScanStatusCode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "INACTIVE", - "name": "INACTIVE" - } - ] - } - }, - "com.amazonaws.inspector2#ScanStatusReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING_INITIAL_SCAN", - "name": "PENDING_INITIAL_SCAN" - }, - { - "value": "ACCESS_DENIED", - "name": "ACCESS_DENIED" - }, - { - "value": "INTERNAL_ERROR", - "name": "INTERNAL_ERROR" - }, - { - "value": "UNMANAGED_EC2_INSTANCE", - "name": "UNMANAGED_EC2_INSTANCE" - }, - { - "value": "UNSUPPORTED_OS", - "name": "UNSUPPORTED_OS" - }, - { - "value": "SCAN_ELIGIBILITY_EXPIRED", - "name": "SCAN_ELIGIBILITY_EXPIRED" - }, - { - "value": "RESOURCE_TERMINATED", - "name": "RESOURCE_TERMINATED" - }, - { - "value": "SUCCESSFUL", - "name": "SUCCESSFUL" - }, - { - "value": "NO_RESOURCES_FOUND", - "name": "NO_RESOURCES_FOUND" - }, - { - "value": "IMAGE_SIZE_EXCEEDED", - "name": "IMAGE_SIZE_EXCEEDED" - }, - { - "value": "SCAN_FREQUENCY_MANUAL", - "name": "SCAN_FREQUENCY_MANUAL" - }, - { - "value": "SCAN_FREQUENCY_SCAN_ON_PUSH", - "name": "SCAN_FREQUENCY_SCAN_ON_PUSH" - }, - { - "value": "EC2_INSTANCE_STOPPED", - "name": "EC2_INSTANCE_STOPPED" - }, - { - "value": "PENDING_DISABLE", - "name": "PENDING_DISABLE" - }, - { - "value": "NO_INVENTORY", - "name": "NO_INVENTORY" - }, - { - "value": "STALE_INVENTORY", - "name": "STALE_INVENTORY" - }, - { - "value": "EXCLUDED_BY_TAG", - "name": "EXCLUDED_BY_TAG" - }, - { - "value": "UNSUPPORTED_RUNTIME", - "name": "UNSUPPORTED_RUNTIME" - }, - { - "value": "UNSUPPORTED_MEDIA_TYPE", - "name": "UNSUPPORTED_MEDIA_TYPE" - }, - { - "value": "UNSUPPORTED_CONFIG_FILE", - "name": "UNSUPPORTED_CONFIG_FILE" - }, - { - "value": "DEEP_INSPECTION_PACKAGE_COLLECTION_LIMIT_EXCEEDED", - "name": "DEEP_INSPECTION_PACKAGE_COLLECTION_LIMIT_EXCEEDED" - }, - { - "value": "DEEP_INSPECTION_DAILY_SSM_INVENTORY_LIMIT_EXCEEDED", - "name": "DEEP_INSPECTION_DAILY_SSM_INVENTORY_LIMIT_EXCEEDED" - }, - { - "value": "DEEP_INSPECTION_COLLECTION_TIME_LIMIT_EXCEEDED", - "name": "DEEP_INSPECTION_COLLECTION_TIME_LIMIT_EXCEEDED" - }, - { - "value": "DEEP_INSPECTION_NO_INVENTORY", - "name": "DEEP_INSPECTION_NO_INVENTORY" - } - ] - } - }, - "com.amazonaws.inspector2#ScanType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NETWORK", - "name": "NETWORK" - }, - { - "value": "PACKAGE", - "name": "PACKAGE" - }, - { - "value": "CODE", - "name": "CODE" - } - ] - } - }, - "com.amazonaws.inspector2#Schedule": { - "type": "union", - "members": { - "oneTime": { - "target": "com.amazonaws.inspector2#OneTimeSchedule", - "traits": { - "smithy.api#documentation": "

The schedule's one time.

" - } - }, - "daily": { - "target": "com.amazonaws.inspector2#DailySchedule", - "traits": { - "smithy.api#documentation": "

The schedule's daily.

" - } - }, - "weekly": { - "target": "com.amazonaws.inspector2#WeeklySchedule", - "traits": { - "smithy.api#documentation": "

The schedule's weekly.

" - } - }, - "monthly": { - "target": "com.amazonaws.inspector2#MonthlySchedule", - "traits": { - "smithy.api#documentation": "

The schedule's monthly.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A schedule.

" - } - }, - "com.amazonaws.inspector2#SearchVulnerabilities": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#SearchVulnerabilitiesRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#SearchVulnerabilitiesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists Amazon Inspector coverage details for a specific vulnerability.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/vulnerabilities/search" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "vulnerabilities" - } - } - }, - "com.amazonaws.inspector2#SearchVulnerabilitiesFilterCriteria": { - "type": "structure", - "members": { - "vulnerabilityIds": { - "target": "com.amazonaws.inspector2#VulnIdList", - "traits": { - "smithy.api#documentation": "

The IDs for specific vulnerabilities.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Details on the criteria used to define the filter for a vulnerability search.\n

" - } - }, - "com.amazonaws.inspector2#SearchVulnerabilitiesRequest": { - "type": "structure", - "members": { - "filterCriteria": { - "target": "com.amazonaws.inspector2#SearchVulnerabilitiesFilterCriteria", - "traits": { - "smithy.api#documentation": "

The criteria used to filter the results of a vulnerability search.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#SearchVulnerabilitiesResponse": { - "type": "structure", - "members": { - "vulnerabilities": { - "target": "com.amazonaws.inspector2#Vulnerabilities", - "traits": { - "smithy.api#documentation": "

Details about the listed vulnerability.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.inspector2#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination parameter to be used on the next list operation to retrieve more items.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#SecurityGroupId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^sg-([a-z0-9]{8}|[a-z0-9]{17}|\\*)$" - } - }, - "com.amazonaws.inspector2#SecurityGroupIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#SecurityGroupId" - }, - "traits": { - "smithy.api#length": { - "max": 5 - } - } - }, - "com.amazonaws.inspector2#SendCisSessionHealth": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#SendCisSessionHealthRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#SendCisSessionHealthResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#ConflictException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Sends a CIS session health. \n This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. \n The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.\n

", - "smithy.api#examples": [ - { - "title": "Sample SendCisSessionHealth Call", - "input": { - "scanJobId": "624b746d-e080-44ae-8c1d-48e653365a38", - "sessionToken": "624b746d-e080-44ae-8c1d-48e653365a31" - }, - "output": {} - } - ], - "smithy.api#http": { - "code": 200, - "method": "PUT", - "uri": "/cissession/health/send" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.inspector2#SendCisSessionHealthRequest": { - "type": "structure", - "members": { - "scanJobId": { - "target": "com.amazonaws.inspector2#UUID", - "traits": { - "smithy.api#documentation": "

A unique identifier for the scan job.

", - "smithy.api#required": {} - } - }, - "sessionToken": { - "target": "com.amazonaws.inspector2#UUID", - "traits": { - "smithy.api#documentation": "

The unique token that identifies the CIS session.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#SendCisSessionHealthResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#SendCisSessionTelemetry": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#SendCisSessionTelemetryRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#SendCisSessionTelemetryResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#ConflictException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Sends a CIS session telemetry. \n This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. \n The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.\n

", - "smithy.api#examples": [ - { - "title": "Sample SendCisSessionTelemetry Call", - "input": { - "scanJobId": "624b746d-e080-44ae-8c1d-48e653365a38", - "sessionToken": "624b746d-e080-44ae-8c1d-48e653365a31", - "messages": [ - { - "ruleId": "1.12.1", - "status": "FAILED", - "cisRuleDetails": "dGVzdCBleGFtcGxlCg==" - }, - { - "ruleId": "1.2.1", - "status": "PASSED", - "cisRuleDetails": "dGVzdCBleGFtcGxlCg==dGVzdCBleGFtcGxlCg" - } - ] - }, - "output": {} - } - ], - "smithy.api#http": { - "code": 200, - "method": "PUT", - "uri": "/cissession/telemetry/send" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.inspector2#SendCisSessionTelemetryRequest": { - "type": "structure", - "members": { - "scanJobId": { - "target": "com.amazonaws.inspector2#UUID", - "traits": { - "smithy.api#documentation": "

A unique identifier for the scan job.

", - "smithy.api#required": {} - } - }, - "sessionToken": { - "target": "com.amazonaws.inspector2#UUID", - "traits": { - "smithy.api#documentation": "

The unique token that identifies the CIS session.

", - "smithy.api#required": {} - } - }, - "messages": { - "target": "com.amazonaws.inspector2#CisSessionMessages", - "traits": { - "smithy.api#documentation": "

The CIS session telemetry messages.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#SendCisSessionTelemetryResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#Service": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EC2", - "name": "EC2" - }, - { - "value": "ECR", - "name": "ECR" - }, - { - "value": "LAMBDA", - "name": "LAMBDA" - } - ] - } - }, - "com.amazonaws.inspector2#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - }, - "resourceId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The ID of the resource that exceeds a service quota.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

You have exceeded your service quota. To perform the requested action, remove some of\n the relevant resources, or use Service Quotas to request a service quota increase.

", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.inspector2#Severity": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "INFORMATIONAL", - "name": "INFORMATIONAL" - }, - { - "value": "LOW", - "name": "LOW" - }, - { - "value": "MEDIUM", - "name": "MEDIUM" - }, - { - "value": "HIGH", - "name": "HIGH" - }, - { - "value": "CRITICAL", - "name": "CRITICAL" - }, - { - "value": "UNTRIAGED", - "name": "UNTRIAGED" - } - ] - } - }, - "com.amazonaws.inspector2#SeverityCounts": { - "type": "structure", - "members": { - "all": { - "target": "smithy.api#Long", - "traits": { - "smithy.api#documentation": "

The total count of findings from all severities.

" - } - }, - "medium": { - "target": "smithy.api#Long", - "traits": { - "smithy.api#documentation": "

The total count of medium severity findings.

" - } - }, - "high": { - "target": "smithy.api#Long", - "traits": { - "smithy.api#documentation": "

The total count of high severity findings.

" - } - }, - "critical": { - "target": "smithy.api#Long", - "traits": { - "smithy.api#documentation": "

The total count of critical severity findings.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains the counts of aggregated finding per severity.

" - } - }, - "com.amazonaws.inspector2#SortCriteria": { - "type": "structure", - "members": { - "field": { - "target": "com.amazonaws.inspector2#SortField", - "traits": { - "smithy.api#documentation": "

The finding detail field by which results are sorted.

", - "smithy.api#required": {} - } - }, - "sortOrder": { - "target": "com.amazonaws.inspector2#SortOrder", - "traits": { - "smithy.api#documentation": "

The order by which findings are sorted.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the criteria used to sort finding results.

" - } - }, - "com.amazonaws.inspector2#SortField": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AWS_ACCOUNT_ID", - "name": "AWS_ACCOUNT_ID" - }, - { - "value": "FINDING_TYPE", - "name": "FINDING_TYPE" - }, - { - "value": "SEVERITY", - "name": "SEVERITY" - }, - { - "value": "FIRST_OBSERVED_AT", - "name": "FIRST_OBSERVED_AT" - }, - { - "value": "LAST_OBSERVED_AT", - "name": "LAST_OBSERVED_AT" - }, - { - "value": "FINDING_STATUS", - "name": "FINDING_STATUS" - }, - { - "value": "RESOURCE_TYPE", - "name": "RESOURCE_TYPE" - }, - { - "value": "ECR_IMAGE_PUSHED_AT", - "name": "ECR_IMAGE_PUSHED_AT" - }, - { - "value": "ECR_IMAGE_REPOSITORY_NAME", - "name": "ECR_IMAGE_REPOSITORY_NAME" - }, - { - "value": "ECR_IMAGE_REGISTRY", - "name": "ECR_IMAGE_REGISTRY" - }, - { - "value": "NETWORK_PROTOCOL", - "name": "NETWORK_PROTOCOL" - }, - { - "value": "COMPONENT_TYPE", - "name": "COMPONENT_TYPE" - }, - { - "value": "VULNERABILITY_ID", - "name": "VULNERABILITY_ID" - }, - { - "value": "VULNERABILITY_SOURCE", - "name": "VULNERABILITY_SOURCE" - }, - { - "value": "INSPECTOR_SCORE", - "name": "INSPECTOR_SCORE" - }, - { - "value": "VENDOR_SEVERITY", - "name": "VENDOR_SEVERITY" - }, - { - "value": "EPSS_SCORE", - "name": "EPSS_SCORE" - } - ] - } - }, - "com.amazonaws.inspector2#SortOrder": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ASC", - "name": "ASC" - }, - { - "value": "DESC", - "name": "DESC" - } - ] - } - }, - "com.amazonaws.inspector2#SourceLayerHash": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 71, - "max": 71 - }, - "smithy.api#pattern": "^sha256:[a-z0-9]{64}$" - } - }, - "com.amazonaws.inspector2#StartCisSession": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#StartCisSessionRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#StartCisSessionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#ConflictException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Starts a CIS session. \n This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. \n The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.\n

", - "smithy.api#examples": [ - { - "title": "Sample SendCisSessionHealth Call", - "input": { - "scanJobId": "624b746d-e080-44ae-8c1d-48e653365a38", - "message": { - "sessionToken": "624b746d-e080-44ae-8c1d-48e653365a31" - } - }, - "output": {} - } - ], - "smithy.api#http": { - "code": 200, - "method": "PUT", - "uri": "/cissession/start" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.inspector2#StartCisSessionMessage": { - "type": "structure", - "members": { - "sessionToken": { - "target": "com.amazonaws.inspector2#UUID", - "traits": { - "smithy.api#documentation": "

The unique token that identifies the CIS session.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The start CIS session message.

" - } - }, - "com.amazonaws.inspector2#StartCisSessionRequest": { - "type": "structure", - "members": { - "scanJobId": { - "target": "com.amazonaws.inspector2#UUID", - "traits": { - "smithy.api#documentation": "

A unique identifier for the scan job.

", - "smithy.api#required": {} - } - }, - "message": { - "target": "com.amazonaws.inspector2#StartCisSessionMessage", - "traits": { - "smithy.api#documentation": "

The start CIS session message.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#StartCisSessionResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#State": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.inspector2#Status", - "traits": { - "smithy.api#documentation": "

The status of Amazon Inspector for the account.

", - "smithy.api#required": {} - } - }, - "errorCode": { - "target": "com.amazonaws.inspector2#ErrorCode", - "traits": { - "smithy.api#documentation": "

The error code explaining why the account failed to enable Amazon Inspector.

", - "smithy.api#required": {} - } - }, - "errorMessage": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The error message received when the account failed to enable Amazon Inspector.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that described the state of Amazon Inspector scans for an account.

" - } - }, - "com.amazonaws.inspector2#Status": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ENABLING", - "name": "ENABLING" - }, - { - "value": "ENABLED", - "name": "ENABLED" - }, - { - "value": "DISABLING", - "name": "DISABLING" - }, - { - "value": "DISABLED", - "name": "DISABLED" - }, - { - "value": "SUSPENDING", - "name": "SUSPENDING" - }, - { - "value": "SUSPENDED", - "name": "SUSPENDED" - } - ] - } - }, - "com.amazonaws.inspector2#StatusCounts": { - "type": "structure", - "members": { - "failed": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The number of checks that failed.

" - } - }, - "skipped": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The number of checks that were skipped.

" - } - }, - "passed": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The number of checks that passed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The status counts.

" - } - }, - "com.amazonaws.inspector2#Step": { - "type": "structure", - "members": { - "componentId": { - "target": "com.amazonaws.inspector2#Component", - "traits": { - "smithy.api#documentation": "

The component ID.

", - "smithy.api#required": {} - } - }, - "componentType": { - "target": "com.amazonaws.inspector2#ComponentType", - "traits": { - "smithy.api#documentation": "

The component type.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the step associated with a finding.

" - } - }, - "com.amazonaws.inspector2#StepList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#Step" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 30 - } - } - }, - "com.amazonaws.inspector2#StopCisMessageProgress": { - "type": "structure", - "members": { - "totalChecks": { - "target": "com.amazonaws.inspector2#CheckCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The progress' total checks.

" - } - }, - "successfulChecks": { - "target": "com.amazonaws.inspector2#CheckCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The progress' successful checks.

" - } - }, - "failedChecks": { - "target": "com.amazonaws.inspector2#CheckCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The progress' failed checks.

" - } - }, - "notEvaluatedChecks": { - "target": "com.amazonaws.inspector2#CheckCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The progress' not evaluated checks.

" - } - }, - "unknownChecks": { - "target": "com.amazonaws.inspector2#CheckCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The progress' unknown checks.

" - } - }, - "notApplicableChecks": { - "target": "com.amazonaws.inspector2#CheckCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The progress' not applicable checks.

" - } - }, - "informationalChecks": { - "target": "com.amazonaws.inspector2#CheckCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The progress' informational checks.

" - } - }, - "errorChecks": { - "target": "com.amazonaws.inspector2#CheckCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The progress' error checks.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The stop CIS message progress.

" - } - }, - "com.amazonaws.inspector2#StopCisSession": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#StopCisSessionRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#StopCisSessionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#ConflictException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Stops a CIS session. \n This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. \n The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.\n

", - "smithy.api#examples": [ - { - "title": "Sample StopCisSession Call", - "input": { - "scanJobId": "624b746d-e080-44ae-8c1d-48e653365a38", - "sessionToken": "624b746d-e080-44ae-8c1d-48e653365a31", - "message": { - "status": "FAILED", - "reason": "Failure Reason", - "progress": { - "informationalChecks": 1, - "errorChecks": 1, - "successfulChecks": 5, - "notApplicableChecks": 0, - "totalChecks": 10, - "unknownChecks": 0, - "notEvaluatedChecks": 2, - "failedChecks": 0 + "traits": { + "smithy.api#documentation": "

Information on the vulnerable package identified by a finding.

" + } + }, + "com.amazonaws.inspector2#VulnerablePackageList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#VulnerablePackage" + } + }, + "com.amazonaws.inspector2#VulnerablePackageRemediation": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.inspector2#WeeklySchedule": { + "type": "structure", + "members": { + "startTime": { + "target": "com.amazonaws.inspector2#Time", + "traits": { + "smithy.api#documentation": "

The weekly schedule's start time.

", + "smithy.api#required": {} + } }, - "computePlatform": { - "vendor": "canonical", - "product": "ubuntu", - "version": "20.04" - }, - "benchmarkVersion": "2.0.0", - "benchmarkProfile": "xccdf_org.cisecurity.benchmarks_profile_Level_1" - } - }, - "output": {} - } - ], - "smithy.api#http": { - "code": 200, - "method": "PUT", - "uri": "/cissession/stop" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.inspector2#StopCisSessionMessage": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.inspector2#StopCisSessionStatus", - "traits": { - "smithy.api#documentation": "

The status of the message.

", - "smithy.api#required": {} - } - }, - "reason": { - "target": "com.amazonaws.inspector2#Reason", - "traits": { - "smithy.api#documentation": "

The reason for the message.

" - } - }, - "progress": { - "target": "com.amazonaws.inspector2#StopCisMessageProgress", - "traits": { - "smithy.api#documentation": "

The progress of the message.

", - "smithy.api#required": {} - } - }, - "computePlatform": { - "target": "com.amazonaws.inspector2#ComputePlatform", - "traits": { - "smithy.api#documentation": "

The message compute platform.

" - } - }, - "benchmarkVersion": { - "target": "com.amazonaws.inspector2#BenchmarkVersion", - "traits": { - "smithy.api#documentation": "

The message benchmark version.

" - } - }, - "benchmarkProfile": { - "target": "com.amazonaws.inspector2#BenchmarkProfile", - "traits": { - "smithy.api#documentation": "

The message benchmark profile.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The stop CIS session message.

" - } - }, - "com.amazonaws.inspector2#StopCisSessionRequest": { - "type": "structure", - "members": { - "scanJobId": { - "target": "com.amazonaws.inspector2#UUID", - "traits": { - "smithy.api#documentation": "

A unique identifier for the scan job.

", - "smithy.api#required": {} - } - }, - "sessionToken": { - "target": "com.amazonaws.inspector2#UUID", - "traits": { - "smithy.api#documentation": "

The unique token that identifies the CIS session.

", - "smithy.api#required": {} - } - }, - "message": { - "target": "com.amazonaws.inspector2#StopCisSessionMessage", - "traits": { - "smithy.api#documentation": "

The stop CIS session message.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#StopCisSessionResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#StopCisSessionStatus": { - "type": "enum", - "members": { - "SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "INTERRUPTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERRUPTED" - } - }, - "UNSUPPORTED_OS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNSUPPORTED_OS" - } - } - } - }, - "com.amazonaws.inspector2#StringComparison": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EQUALS", - "name": "EQUALS" - }, - { - "value": "PREFIX", - "name": "PREFIX" - }, - { - "value": "NOT_EQUALS", - "name": "NOT_EQUALS" - } - ] - } - }, - "com.amazonaws.inspector2#StringFilter": { - "type": "structure", - "members": { - "comparison": { - "target": "com.amazonaws.inspector2#StringComparison", - "traits": { - "smithy.api#documentation": "

The operator to use when comparing values in the filter.

", - "smithy.api#required": {} - } - }, - "value": { - "target": "com.amazonaws.inspector2#StringInput", - "traits": { - "smithy.api#documentation": "

The value to filter on.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that describes the details of a string filter.

" - } - }, - "com.amazonaws.inspector2#StringFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#StringFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#StringInput": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.inspector2#StringList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#NonEmptyString" - } - }, - "com.amazonaws.inspector2#SubnetId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^subnet-([a-z0-9]{8}|[a-z0-9]{17}|\\*)$" - } - }, - "com.amazonaws.inspector2#SubnetIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#SubnetId" - }, - "traits": { - "smithy.api#length": { - "max": 16 - } - } - }, - "com.amazonaws.inspector2#SuggestedFix": { - "type": "structure", - "members": { - "description": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The fix's description.

", - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, - "code": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The fix's code.

", - "smithy.api#length": { - "min": 1, - "max": 2500 - } - } - } - }, - "traits": { - "smithy.api#documentation": "

A suggested fix for a vulnerability in your Lambda function code.

" - } - }, - "com.amazonaws.inspector2#SuggestedFixes": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#SuggestedFix" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.inspector2#TagComparison": { - "type": "enum", - "members": { - "EQUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EQUALS" - } - } - } - }, - "com.amazonaws.inspector2#TagFilter": { - "type": "structure", - "members": { - "comparison": { - "target": "com.amazonaws.inspector2#TagComparison", - "traits": { - "smithy.api#documentation": "

The tag filter comparison value.

", - "smithy.api#required": {} - } - }, - "key": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The tag filter key.

", - "smithy.api#required": {} - } - }, - "value": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The tag filter value.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The tag filter.

" - } - }, - "com.amazonaws.inspector2#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" - } - }, - "com.amazonaws.inspector2#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.inspector2#TagList": { - "type": "list", - "member": { - "target": "smithy.api#String" - } - }, - "com.amazonaws.inspector2#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.inspector2#MapKey" - }, - "value": { - "target": "com.amazonaws.inspector2#MapValue" - } - }, - "com.amazonaws.inspector2#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#BadRequestException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds tags to a resource.

", - "smithy.api#http": { - "uri": "/tags/{resourceArn}", - "method": "POST" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.inspector2#TagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.inspector2#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to apply a tag to.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.inspector2#TagMap", - "traits": { - "smithy.api#documentation": "

The tags to be added to a resource.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.inspector2#TagResourceResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.inspector2#TagValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#TargetResourceTagsValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.inspector2#Target": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.inspector2#TargetAccount": { - "type": "string", - "traits": { - "smithy.api#pattern": "^\\d{12}|ALL_ACCOUNTS|SELF$" - } - }, - "com.amazonaws.inspector2#TargetAccountList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#TargetAccount" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10000 - }, - "smithy.api#uniqueItems": {} - } - }, - "com.amazonaws.inspector2#TargetResourceTags": { - "type": "map", - "key": { - "target": "com.amazonaws.inspector2#TargetResourceTagsKey" - }, - "value": { - "target": "com.amazonaws.inspector2#TagValueList" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.inspector2#TargetResourceTagsKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=\\-@]*$" - } - }, - "com.amazonaws.inspector2#TargetResourceTagsValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.inspector2#TargetStatusFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisTargetStatusFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#TargetStatusReasonFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisTargetStatusReasonFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#Targets": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#Target" - }, - "traits": { - "smithy.api#length": { - "min": 0 - } - } - }, - "com.amazonaws.inspector2#ThrottlingException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - }, - "retryAfterSeconds": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The number of seconds to wait before retrying the request.

", - "smithy.api#httpHeader": "Retry-After" - } - } - }, - "traits": { - "smithy.api#documentation": "

The limit on the number of requests per second was exceeded.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429, - "smithy.api#retryable": { - "throttling": true - } - } - }, - "com.amazonaws.inspector2#Time": { - "type": "structure", - "members": { - "timeOfDay": { - "target": "com.amazonaws.inspector2#TimeOfDay", - "traits": { - "smithy.api#documentation": "

The time of day in 24-hour format (00:00).

", - "smithy.api#required": {} - } - }, - "timezone": { - "target": "com.amazonaws.inspector2#Timezone", - "traits": { - "smithy.api#documentation": "

The timezone.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The time.

" - } - }, - "com.amazonaws.inspector2#TimeOfDay": { - "type": "string", - "traits": { - "smithy.api#pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$" - } - }, - "com.amazonaws.inspector2#Timezone": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.inspector2#TitleAggregation": { - "type": "structure", - "members": { - "titles": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The finding titles to aggregate on.

" - } - }, - "vulnerabilityIds": { - "target": "com.amazonaws.inspector2#StringFilterList", - "traits": { - "smithy.api#documentation": "

The vulnerability IDs of the findings.

" - } - }, - "resourceType": { - "target": "com.amazonaws.inspector2#AggregationResourceType", - "traits": { - "smithy.api#documentation": "

The resource type to aggregate on.

" - } - }, - "sortOrder": { - "target": "com.amazonaws.inspector2#SortOrder", - "traits": { - "smithy.api#documentation": "

The order to sort results by.

" - } - }, - "sortBy": { - "target": "com.amazonaws.inspector2#TitleSortBy", - "traits": { - "smithy.api#documentation": "

The value to sort results by.

" - } - }, - "findingType": { - "target": "com.amazonaws.inspector2#AggregationFindingType", - "traits": { - "smithy.api#documentation": "

The type of finding to aggregate on.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The details that define an aggregation based on finding title.

" - } - }, - "com.amazonaws.inspector2#TitleAggregationResponse": { - "type": "structure", - "members": { - "title": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The title that the findings were aggregated on.

", - "smithy.api#required": {} - } - }, - "vulnerabilityId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The vulnerability ID of the finding.

" - } - }, - "accountId": { - "target": "com.amazonaws.inspector2#AccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account associated with the findings.

" - } - }, - "severityCounts": { - "target": "com.amazonaws.inspector2#SeverityCounts", - "traits": { - "smithy.api#documentation": "

An object that represent the count of matched findings per severity.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A response that contains details on the results of a finding aggregation by title.

" - } - }, - "com.amazonaws.inspector2#TitleFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#CisStringFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.inspector2#TitleSortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CRITICAL", - "name": "CRITICAL" - }, - { - "value": "HIGH", - "name": "HIGH" - }, - { - "value": "ALL", - "name": "ALL" - } - ] - } - }, - "com.amazonaws.inspector2#Tool": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0 - } - } - }, - "com.amazonaws.inspector2#Tools": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#Tool" - } - }, - "com.amazonaws.inspector2#Ttp": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 30 - } - } - }, - "com.amazonaws.inspector2#Ttps": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#Ttp" - }, - "traits": { - "smithy.api#length": { - "min": 0 - } - } - }, - "com.amazonaws.inspector2#UUID": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - } - }, - "com.amazonaws.inspector2#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes tags from a resource.

", - "smithy.api#http": { - "uri": "/tags/{resourceArn}", - "method": "DELETE" - } - } - }, - "com.amazonaws.inspector2#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.inspector2#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the resource to remove tags from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.inspector2#TagKeyList", - "traits": { - "smithy.api#documentation": "

The tag keys to remove from the resource.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.inspector2#UntagResourceResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.inspector2#UpdateCisScanConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#UpdateCisScanConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#UpdateCisScanConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a CIS scan configuration.

", - "smithy.api#examples": [ - { - "title": "Sample UpdateCisScanConfiguration Call", - "input": { - "scanConfigurationArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-configuration/624b746d-e080-44ae-8c1d-48e653365a38", - "scanName": "sample_new", - "securityLevel": "LEVEL_2", - "schedule": { - "daily": { - "startTime": { - "timeOfDay": "12:56", - "timezone": "UTC" - } - } - }, - "targets": { - "accountIds": ["SELF"], - "targetResourceTags": { - "key2": ["value2"] + "days": { + "target": "com.amazonaws.inspector2#DaysList", + "traits": { + "smithy.api#documentation": "

The weekly schedule's days.

", + "smithy.api#required": {} + } } - } }, - "output": { - "scanConfigurationArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-configuration/624b746d-e080-44ae-8c1d-48e653365a38" - } - } - ], - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/cis/scan-configuration/update" - } - } - }, - "com.amazonaws.inspector2#UpdateCisScanConfigurationRequest": { - "type": "structure", - "members": { - "scanConfigurationArn": { - "target": "com.amazonaws.inspector2#CisScanConfigurationArn", - "traits": { - "smithy.api#documentation": "

The CIS scan configuration ARN.

", - "smithy.api#required": {} - } - }, - "scanName": { - "target": "com.amazonaws.inspector2#CisScanName", - "traits": { - "smithy.api#documentation": "

The scan name for the CIS scan configuration.

" - } - }, - "securityLevel": { - "target": "com.amazonaws.inspector2#CisSecurityLevel", - "traits": { - "smithy.api#documentation": "

\n The security level for the CIS scan configuration. \n Security level refers to the Benchmark levels that CIS assigns to a profile.\n

" - } - }, - "schedule": { - "target": "com.amazonaws.inspector2#Schedule", - "traits": { - "smithy.api#documentation": "

The schedule for the CIS scan configuration.

" - } - }, - "targets": { - "target": "com.amazonaws.inspector2#UpdateCisTargets", - "traits": { - "smithy.api#documentation": "

The targets for the CIS scan configuration.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#UpdateCisScanConfigurationResponse": { - "type": "structure", - "members": { - "scanConfigurationArn": { - "target": "com.amazonaws.inspector2#CisScanConfigurationArn", - "traits": { - "smithy.api#documentation": "

The CIS scan configuration ARN.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#UpdateCisTargets": { - "type": "structure", - "members": { - "accountIds": { - "target": "com.amazonaws.inspector2#TargetAccountList", - "traits": { - "smithy.api#documentation": "

The target account ids.

" - } - }, - "targetResourceTags": { - "target": "com.amazonaws.inspector2#TargetResourceTags", - "traits": { - "smithy.api#documentation": "

The target resource tags.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Updates CIS targets.

" - } - }, - "com.amazonaws.inspector2#UpdateConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#UpdateConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#UpdateConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates setting configurations for your Amazon Inspector account. When you use this API as an Amazon Inspector delegated administrator this updates the setting for all accounts you manage. Member accounts in an organization cannot update this setting.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/configuration/update" - } - } - }, - "com.amazonaws.inspector2#UpdateConfigurationRequest": { - "type": "structure", - "members": { - "ecrConfiguration": { - "target": "com.amazonaws.inspector2#EcrConfiguration", - "traits": { - "smithy.api#documentation": "

Specifies how the ECR automated re-scan will be updated for your environment.

" - } - }, - "ec2Configuration": { - "target": "com.amazonaws.inspector2#Ec2Configuration", - "traits": { - "smithy.api#documentation": "

Specifies how the Amazon EC2 automated scan will be updated for your environment.

" - } - } - } - }, - "com.amazonaws.inspector2#UpdateConfigurationResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.inspector2#UpdateEc2DeepInspectionConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#UpdateEc2DeepInspectionConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#UpdateEc2DeepInspectionConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Activates, deactivates Amazon Inspector deep inspection, or updates custom paths for your account.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/ec2deepinspectionconfiguration/update" - } - } - }, - "com.amazonaws.inspector2#UpdateEc2DeepInspectionConfigurationRequest": { - "type": "structure", - "members": { - "activateDeepInspection": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Specify TRUE to activate Amazon Inspector deep inspection in your account, or FALSE to deactivate. Member accounts in an organization cannot deactivate deep inspection, instead the delegated administrator for the organization can deactivate a member account using BatchUpdateMemberEc2DeepInspectionStatus.

" - } - }, - "packagePaths": { - "target": "com.amazonaws.inspector2#PathList", - "traits": { - "smithy.api#documentation": "

The Amazon Inspector deep inspection custom paths you are adding for your account.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#UpdateEc2DeepInspectionConfigurationResponse": { - "type": "structure", - "members": { - "packagePaths": { - "target": "com.amazonaws.inspector2#PathList", - "traits": { - "smithy.api#documentation": "

The current Amazon Inspector deep inspection custom paths for your account.

" - } - }, - "orgPackagePaths": { - "target": "com.amazonaws.inspector2#PathList", - "traits": { - "smithy.api#documentation": "

The current Amazon Inspector deep inspection custom paths for the organization.

" - } - }, - "status": { - "target": "com.amazonaws.inspector2#Ec2DeepInspectionStatus", - "traits": { - "smithy.api#documentation": "

The status of Amazon Inspector deep inspection in your account.

" - } - }, - "errorMessage": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

An error message explaining why new Amazon Inspector deep inspection custom paths could not be added.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#UpdateEncryptionKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#UpdateEncryptionKeyRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#UpdateEncryptionKeyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an encryption key. A ResourceNotFoundException means that an Amazon Web Services owned key is being used for encryption.

", - "smithy.api#http": { - "code": 200, - "method": "PUT", - "uri": "/encryptionkey/update" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.inspector2#UpdateEncryptionKeyRequest": { - "type": "structure", - "members": { - "kmsKeyId": { - "target": "com.amazonaws.inspector2#KmsKeyArn", - "traits": { - "smithy.api#documentation": "

A KMS key ID for the encryption key.

", - "smithy.api#required": {} - } - }, - "scanType": { - "target": "com.amazonaws.inspector2#ScanType", - "traits": { - "smithy.api#documentation": "

The scan type for the encryption key.

", - "smithy.api#required": {} - } - }, - "resourceType": { - "target": "com.amazonaws.inspector2#ResourceType", - "traits": { - "smithy.api#documentation": "

The resource type for the encryption key.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#UpdateEncryptionKeyResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#UpdateFilter": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#UpdateFilterRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#UpdateFilterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Specifies the action that is to be applied to the findings that match the filter.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/filters/update" - } - } - }, - "com.amazonaws.inspector2#UpdateFilterRequest": { - "type": "structure", - "members": { - "action": { - "target": "com.amazonaws.inspector2#FilterAction", - "traits": { - "smithy.api#documentation": "

Specifies the action that is to be applied to the findings that match the filter.

" - } - }, - "description": { - "target": "com.amazonaws.inspector2#FilterDescription", - "traits": { - "smithy.api#documentation": "

A description of the filter.

" - } - }, - "filterCriteria": { - "target": "com.amazonaws.inspector2#FilterCriteria", - "traits": { - "smithy.api#documentation": "

Defines the criteria to be update in the filter.

" - } - }, - "name": { - "target": "com.amazonaws.inspector2#FilterName", - "traits": { - "smithy.api#documentation": "

The name of the filter.

" - } - }, - "filterArn": { - "target": "com.amazonaws.inspector2#FilterArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the filter to update.

", - "smithy.api#required": {} - } - }, - "reason": { - "target": "com.amazonaws.inspector2#FilterReason", - "traits": { - "smithy.api#documentation": "

The reason the filter was updated.

" - } - } - } - }, - "com.amazonaws.inspector2#UpdateFilterResponse": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.inspector2#FilterArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the successfully updated filter.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.inspector2#UpdateOrgEc2DeepInspectionConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#UpdateOrgEc2DeepInspectionConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#UpdateOrgEc2DeepInspectionConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the Amazon Inspector deep inspection custom paths for your organization. You must be an Amazon Inspector delegated administrator to use this API.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/ec2deepinspectionconfiguration/org/update" - } - } - }, - "com.amazonaws.inspector2#UpdateOrgEc2DeepInspectionConfigurationRequest": { - "type": "structure", - "members": { - "orgPackagePaths": { - "target": "com.amazonaws.inspector2#PathList", - "traits": { - "smithy.api#documentation": "

The Amazon Inspector deep inspection custom paths you are adding for your organization.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.inspector2#UpdateOrgEc2DeepInspectionConfigurationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.inspector2#UpdateOrganizationConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.inspector2#UpdateOrganizationConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.inspector2#UpdateOrganizationConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.inspector2#AccessDeniedException" - }, - { - "target": "com.amazonaws.inspector2#InternalServerException" - }, - { - "target": "com.amazonaws.inspector2#ThrottlingException" - }, - { - "target": "com.amazonaws.inspector2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the configurations for your Amazon Inspector organization.

", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/organizationconfiguration/update" - } - } - }, - "com.amazonaws.inspector2#UpdateOrganizationConfigurationRequest": { - "type": "structure", - "members": { - "autoEnable": { - "target": "com.amazonaws.inspector2#AutoEnable", - "traits": { - "smithy.api#documentation": "

Defines which scan types are enabled automatically for new members of your Amazon Inspector organization.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.inspector2#UpdateOrganizationConfigurationResponse": { - "type": "structure", - "members": { - "autoEnable": { - "target": "com.amazonaws.inspector2#AutoEnable", - "traits": { - "smithy.api#documentation": "

The updated status of scan types automatically enabled for new members of your Amazon Inspector organization.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.inspector2#Usage": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.inspector2#UsageType", - "traits": { - "smithy.api#documentation": "

The type scan.

" - } - }, - "total": { - "target": "com.amazonaws.inspector2#UsageValue", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total of usage.

" - } - }, - "estimatedMonthlyCost": { - "target": "com.amazonaws.inspector2#MonthlyCostEstimate", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The estimated monthly cost of Amazon Inspector.

" - } - }, - "currency": { - "target": "com.amazonaws.inspector2#Currency", - "traits": { - "smithy.api#documentation": "

The currency type used when calculating usage data.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains usage information about the cost of Amazon Inspector operation.

" - } - }, - "com.amazonaws.inspector2#UsageAccountId": { - "type": "string", - "traits": { - "smithy.api#pattern": "[0-9]{12}" - } - }, - "com.amazonaws.inspector2#UsageAccountIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#UsageAccountId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 7000 - } - } - }, - "com.amazonaws.inspector2#UsageList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#Usage" - } - }, - "com.amazonaws.inspector2#UsageTotal": { - "type": "structure", - "members": { - "accountId": { - "target": "com.amazonaws.inspector2#MeteringAccountId", - "traits": { - "smithy.api#documentation": "

The account ID of the account that usage data was retrieved for.

" - } - }, - "usage": { - "target": "com.amazonaws.inspector2#UsageList", - "traits": { - "smithy.api#documentation": "

An object representing the total usage for an account.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The total of usage for an account ID.

" - } - }, - "com.amazonaws.inspector2#UsageTotalList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#UsageTotal" - } - }, - "com.amazonaws.inspector2#UsageType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "EC2_INSTANCE_HOURS", - "value": "EC2_INSTANCE_HOURS" - }, - { - "name": "ECR_INITIAL_SCAN", - "value": "ECR_INITIAL_SCAN" - }, - { - "name": "ECR_RESCAN", - "value": "ECR_RESCAN" - }, - { - "name": "LAMBDA_FUNCTION_HOURS", - "value": "LAMBDA_FUNCTION_HOURS" - }, - { - "name": "LAMBDA_FUNCTION_CODE_HOURS", - "value": "LAMBDA_FUNCTION_CODE_HOURS" - } - ] - } - }, - "com.amazonaws.inspector2#UsageValue": { - "type": "double", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.inspector2#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - }, - "reason": { - "target": "com.amazonaws.inspector2#ValidationExceptionReason", - "traits": { - "smithy.api#documentation": "

The reason for the validation failure.

", - "smithy.api#required": {} - } - }, - "fields": { - "target": "com.amazonaws.inspector2#ValidationExceptionFields", - "traits": { - "smithy.api#documentation": "

The fields that failed validation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The request has failed validation due to missing required fields or having invalid\n inputs.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.inspector2#ValidationExceptionField": { - "type": "structure", - "members": { - "name": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The name of the validation exception.

", - "smithy.api#required": {} - } - }, - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The validation exception message.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that describes a validation exception.

" - } - }, - "com.amazonaws.inspector2#ValidationExceptionFields": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#ValidationExceptionField" - } - }, - "com.amazonaws.inspector2#ValidationExceptionReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CANNOT_PARSE", - "name": "CANNOT_PARSE" - }, - { - "value": "FIELD_VALIDATION_FAILED", - "name": "FIELD_VALIDATION_FAILED" - }, - { - "value": "OTHER", - "name": "OTHER" - } - ] - } - }, - "com.amazonaws.inspector2#Vendor": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 16 - } - } - }, - "com.amazonaws.inspector2#VendorCreatedAt": { - "type": "timestamp" - }, - "com.amazonaws.inspector2#VendorSeverity": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.inspector2#VendorUpdatedAt": { - "type": "timestamp" - }, - "com.amazonaws.inspector2#Version": { - "type": "string", - "traits": { - "smithy.api#pattern": "^\\$LATEST|[0-9]+$" - } - }, - "com.amazonaws.inspector2#VpcId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^vpc-([a-z0-9]{8}|[a-z0-9]{17}|\\*)$" - } - }, - "com.amazonaws.inspector2#VulnId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^CVE-[12][0-9]{3}-[0-9]{1,10}$" - } - }, - "com.amazonaws.inspector2#VulnIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#VulnId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.inspector2#Vulnerabilities": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#Vulnerability" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.inspector2#Vulnerability": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.inspector2#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The ID for the specific vulnerability.

", - "smithy.api#required": {} - } - }, - "cwes": { - "target": "com.amazonaws.inspector2#Cwes", - "traits": { - "smithy.api#documentation": "

The Common Weakness Enumeration (CWE) associated with the vulnerability.

" - } - }, - "cisaData": { - "target": "com.amazonaws.inspector2#CisaData", - "traits": { - "smithy.api#documentation": "

An object that contains the Cybersecurity and Infrastructure Security Agency (CISA) details for the vulnerability.

" - } - }, - "source": { - "target": "com.amazonaws.inspector2#VulnerabilitySource", - "traits": { - "smithy.api#documentation": "

The source of the vulnerability information. Possible results are RHEL, AMAZON_CVE, DEBIAN or NVD.

" - } - }, - "description": { - "target": "com.amazonaws.inspector2#VulnerabilityDescription", - "traits": { - "smithy.api#documentation": "

A description of the vulnerability.

" - } - }, - "atigData": { - "target": "com.amazonaws.inspector2#AtigData", - "traits": { - "smithy.api#documentation": "

An object that contains information about the Amazon Web Services Threat Intel Group (ATIG) details for the vulnerability.

" - } - }, - "vendorSeverity": { - "target": "com.amazonaws.inspector2#VendorSeverity", - "traits": { - "smithy.api#documentation": "

The severity assigned by the vendor.

" - } - }, - "cvss3": { - "target": "com.amazonaws.inspector2#Cvss3", - "traits": { - "smithy.api#documentation": "

An object that contains the Common Vulnerability Scoring System (CVSS) Version 3 details for the vulnerability.

" - } - }, - "relatedVulnerabilities": { - "target": "com.amazonaws.inspector2#RelatedVulnerabilities", - "traits": { - "smithy.api#documentation": "

A list of related vulnerabilities.

" - } - }, - "cvss2": { - "target": "com.amazonaws.inspector2#Cvss2", - "traits": { - "smithy.api#documentation": "

An object that contains the Common Vulnerability Scoring System (CVSS) Version 2 details for the vulnerability.

" - } - }, - "vendorCreatedAt": { - "target": "com.amazonaws.inspector2#VendorCreatedAt", - "traits": { - "smithy.api#documentation": "

The date and time when the vendor created this vulnerability.

" - } - }, - "vendorUpdatedAt": { - "target": "com.amazonaws.inspector2#VendorUpdatedAt", - "traits": { - "smithy.api#documentation": "

The date and time when the vendor last updated this vulnerability.

" - } - }, - "sourceUrl": { - "target": "com.amazonaws.inspector2#VulnerabilitySourceUrl", - "traits": { - "smithy.api#documentation": "

A link to the official source material for this vulnerability.

" - } - }, - "referenceUrls": { - "target": "com.amazonaws.inspector2#VulnerabilityReferenceUrls", - "traits": { - "smithy.api#documentation": "

Links to various resources with more information on this vulnerability.

" - } - }, - "exploitObserved": { - "target": "com.amazonaws.inspector2#ExploitObserved", - "traits": { - "smithy.api#documentation": "

An object that contains details on when the exploit was observed.

" - } - }, - "detectionPlatforms": { - "target": "com.amazonaws.inspector2#DetectionPlatforms", - "traits": { - "smithy.api#documentation": "

Platforms that the vulnerability can be detected on.

" - } - }, - "epss": { - "target": "com.amazonaws.inspector2#Epss", - "traits": { - "smithy.api#documentation": "

An object that contains the Exploit Prediction Scoring System (EPSS) score for a vulnerability.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains details about a specific vulnerability Amazon Inspector can detect.

" - } - }, - "com.amazonaws.inspector2#VulnerabilityDescription": { - "type": "string" - }, - "com.amazonaws.inspector2#VulnerabilityId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.inspector2#VulnerabilityIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#VulnerabilityId" - } - }, - "com.amazonaws.inspector2#VulnerabilityReferenceUrl": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0 - } - } - }, - "com.amazonaws.inspector2#VulnerabilityReferenceUrls": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#VulnerabilityReferenceUrl" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.inspector2#VulnerabilitySource": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NVD", - "name": "NVD" - } - ] - } - }, - "com.amazonaws.inspector2#VulnerabilitySourceUrl": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0 - } - } - }, - "com.amazonaws.inspector2#VulnerablePackage": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.inspector2#PackageName", - "traits": { - "smithy.api#documentation": "

The name of the vulnerable package.

", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.inspector2#PackageVersion", - "traits": { - "smithy.api#documentation": "

The version of the vulnerable package.

", - "smithy.api#required": {} - } - }, - "sourceLayerHash": { - "target": "com.amazonaws.inspector2#SourceLayerHash", - "traits": { - "smithy.api#documentation": "

The source layer hash of the vulnerable package.

" - } - }, - "epoch": { - "target": "com.amazonaws.inspector2#PackageEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The epoch of the vulnerable package.

" - } - }, - "release": { - "target": "com.amazonaws.inspector2#PackageRelease", - "traits": { - "smithy.api#documentation": "

The release of the vulnerable package.

" - } - }, - "arch": { - "target": "com.amazonaws.inspector2#PackageArchitecture", - "traits": { - "smithy.api#documentation": "

The architecture of the vulnerable package.

" - } - }, - "packageManager": { - "target": "com.amazonaws.inspector2#PackageManager", - "traits": { - "smithy.api#documentation": "

The package manager of the vulnerable package.

" - } - }, - "filePath": { - "target": "com.amazonaws.inspector2#FilePath", - "traits": { - "smithy.api#documentation": "

The file path of the vulnerable package.

" - } - }, - "fixedInVersion": { - "target": "com.amazonaws.inspector2#PackageVersion", - "traits": { - "smithy.api#documentation": "

The version of the package that contains the vulnerability fix.

" - } - }, - "remediation": { - "target": "com.amazonaws.inspector2#VulnerablePackageRemediation", - "traits": { - "smithy.api#documentation": "

The code to run in your environment to update packages with a fix available.

" - } - }, - "sourceLambdaLayerArn": { - "target": "com.amazonaws.inspector2#LambdaLayerArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the Amazon Web Services Lambda function affected by a finding.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information on the vulnerable package identified by a finding.

" - } - }, - "com.amazonaws.inspector2#VulnerablePackageList": { - "type": "list", - "member": { - "target": "com.amazonaws.inspector2#VulnerablePackage" - } - }, - "com.amazonaws.inspector2#VulnerablePackageRemediation": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.inspector2#WeeklySchedule": { - "type": "structure", - "members": { - "startTime": { - "target": "com.amazonaws.inspector2#Time", - "traits": { - "smithy.api#documentation": "

The weekly schedule's start time.

", - "smithy.api#required": {} - } - }, - "days": { - "target": "com.amazonaws.inspector2#DaysList", - "traits": { - "smithy.api#documentation": "

The weekly schedule's days.

", - "smithy.api#required": {} - } + "traits": { + "smithy.api#documentation": "

A weekly schedule.

" + } } - }, - "traits": { - "smithy.api#documentation": "

A weekly schedule.

" - } } - } -} +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/quicksight.json b/codegen/sdk-codegen/aws-models/quicksight.json index ddc8a4cc8cc2..98db4f282c85 100644 --- a/codegen/sdk-codegen/aws-models/quicksight.json +++ b/codegen/sdk-codegen/aws-models/quicksight.json @@ -1,56531 +1,56662 @@ { - "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.quicksight#AccessDeniedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

You don't have access to this item. The provided credentials couldn't be\n\t\t\tvalidated. You might not be authorized to carry out the request. Make sure that your\n\t\t\taccount is authorized to use the Amazon QuickSight service, that your policies have the\n\t\t\tcorrect permissions, and that you are using the correct credentials.

", - "smithy.api#error": "client", - "smithy.api#httpError": 401 - } - }, - "com.amazonaws.quicksight#AccountCustomization": { - "type": "structure", - "members": { - "DefaultTheme": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The default theme for this Amazon QuickSight subscription.

" - } - }, - "DefaultEmailCustomizationTemplate": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The default email customization template.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight customizations associated with your Amazon Web Services account or a QuickSight namespace in a specific Amazon Web Services Region.

" - } - }, - "com.amazonaws.quicksight#AccountInfo": { - "type": "structure", - "members": { - "AccountName": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The account name that you provided for the Amazon QuickSight subscription in your\n Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It's unique over all of Amazon Web Services, and it appears only when\n users sign in.

" - } - }, - "Edition": { - "target": "com.amazonaws.quicksight#Edition", - "traits": { - "smithy.api#documentation": "

The edition of your Amazon QuickSight account.

" - } - }, - "NotificationEmail": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The email address that will be used for Amazon QuickSight to send notifications regarding your Amazon Web Services account or Amazon QuickSight subscription.

" - } - }, - "AuthenticationType": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The way that your Amazon QuickSight account is authenticated.

" - } - }, - "AccountSubscriptionStatus": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The status of your account subscription.

" - } - }, - "IAMIdentityCenterInstanceArn": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM Identity Center instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains the following account information\n elements:

\n " - } - }, - "com.amazonaws.quicksight#AccountName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 62 - }, - "smithy.api#pattern": "^(?!D-|d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*$" - } - }, - "com.amazonaws.quicksight#AccountSettings": { - "type": "structure", - "members": { - "AccountName": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The \"account name\" you provided for the Amazon QuickSight subscription in your Amazon Web Services account.\n You create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web Services and\n it appears only when users sign in.

" - } - }, - "Edition": { - "target": "com.amazonaws.quicksight#Edition", - "traits": { - "smithy.api#documentation": "

The edition of Amazon QuickSight that you're currently subscribed to:\n Enterprise edition or Standard edition.

" - } - }, - "DefaultNamespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The default Amazon QuickSight namespace for your Amazon Web Services account.

" - } - }, - "NotificationEmail": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The main notification email for your Amazon QuickSight subscription.

" - } - }, - "PublicSharingEnabled": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For more information about turning on public sharing, see UpdatePublicSharingSettings.

" - } - }, - "TerminationProtectionEnabled": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubsctiption request. A False value will allow the ccount to be deleted.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight settings associated with your Amazon Web Services account.

" - } - }, - "com.amazonaws.quicksight#ActionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#String" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#ActiveIAMPolicyAssignment": { - "type": "structure", - "members": { - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "

A name for the IAM policy assignment.

" - } - }, - "PolicyArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The active Identity and Access Management (IAM) policy assignment.

" - } - }, - "com.amazonaws.quicksight#ActiveIAMPolicyAssignmentList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ActiveIAMPolicyAssignment" - } - }, - "com.amazonaws.quicksight#AdHocFilteringOption": { - "type": "structure", - "members": { - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#DashboardBehavior", - "traits": { - "smithy.api#documentation": "

Availability status.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An ad hoc (one-time) filtering option.

" - } - }, - "com.amazonaws.quicksight#AdditionalDashboardIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#AggFunction": { - "type": "structure", - "members": { - "Aggregation": { - "target": "com.amazonaws.quicksight#AggType", - "traits": { - "smithy.api#documentation": "

The aggregation of an Agg function.

" - } - }, - "AggregationFunctionParameters": { - "target": "com.amazonaws.quicksight#AggFunctionParamMap", - "traits": { - "smithy.api#documentation": "

The aggregation parameters for an Agg function.

" - } - }, - "Period": { - "target": "com.amazonaws.quicksight#TopicTimeGranularity", - "traits": { - "smithy.api#documentation": "

The period of an Agg function.

" - } - }, - "PeriodField": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The period field for an Agg function.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition of an Agg function.

" - } - }, - "com.amazonaws.quicksight#AggFunctionParamKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.quicksight#AggFunctionParamMap": { - "type": "map", - "key": { - "target": "com.amazonaws.quicksight#AggFunctionParamKey" - }, - "value": { - "target": "com.amazonaws.quicksight#AggFunctionParamValue" - } - }, - "com.amazonaws.quicksight#AggFunctionParamValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.quicksight#AggType": { - "type": "enum", - "members": { - "SUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUM" - } - }, - "MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MIN" - } - }, - "MAX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX" - } - }, - "COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNT" - } - }, - "AVERAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVERAGE" - } - }, - "DISTINCT_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISTINCT_COUNT" - } - }, - "STDEV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEV" - } - }, - "STDEVP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEVP" - } - }, - "VAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VAR" - } - }, - "VARP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VARP" - } - }, - "PERCENTILE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENTILE" - } - }, - "MEDIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIAN" - } - }, - "PTD_SUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PTD_SUM" - } - }, - "PTD_MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PTD_MIN" - } - }, - "PTD_MAX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PTD_MAX" - } - }, - "PTD_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PTD_COUNT" - } - }, - "PTD_DISTINCT_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PTD_DISTINCT_COUNT" - } - }, - "PTD_AVERAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PTD_AVERAGE" - } - }, - "COLUMN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLUMN" - } - }, - "CUSTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM" - } - } - } - }, - "com.amazonaws.quicksight#AggregationFunction": { - "type": "structure", - "members": { - "NumericalAggregationFunction": { - "target": "com.amazonaws.quicksight#NumericalAggregationFunction", - "traits": { - "smithy.api#documentation": "

Aggregation for numerical values.

" - } - }, - "CategoricalAggregationFunction": { - "target": "com.amazonaws.quicksight#CategoricalAggregationFunction", - "traits": { - "smithy.api#documentation": "

Aggregation for categorical values.

\n " - } - }, - "DateAggregationFunction": { - "target": "com.amazonaws.quicksight#DateAggregationFunction", - "traits": { - "smithy.api#documentation": "

Aggregation for date values.

\n " - } - }, - "AttributeAggregationFunction": { - "target": "com.amazonaws.quicksight#AttributeAggregationFunction", - "traits": { - "smithy.api#documentation": "

Aggregation for attributes.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An aggregation function aggregates values from a dimension or measure.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#AggregationFunctionParameters": { - "type": "map", - "key": { - "target": "com.amazonaws.quicksight#LimitedString" - }, - "value": { - "target": "com.amazonaws.quicksight#LimitedString" - } - }, - "com.amazonaws.quicksight#AggregationPartitionBy": { - "type": "structure", - "members": { - "FieldName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The field Name for an AggregationPartitionBy.

" - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The TimeGranularity for an AggregationPartitionBy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition of an AggregationPartitionBy.

" - } - }, - "com.amazonaws.quicksight#AggregationPartitionByList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AggregationPartitionBy" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AggregationSortConfiguration": { - "type": "structure", - "members": { - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that determines the sort order of aggregated values.

", - "smithy.api#required": {} - } - }, - "SortDirection": { - "target": "com.amazonaws.quicksight#SortDirection", - "traits": { - "smithy.api#documentation": "

The sort direction of values.

\n ", - "smithy.api#required": {} - } - }, - "AggregationFunction": { - "target": "com.amazonaws.quicksight#AggregationFunction", - "traits": { - "smithy.api#documentation": "

The function that aggregates the values in Column.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration options to sort aggregated values.

" - } - }, - "com.amazonaws.quicksight#AggregationSortConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AggregationSortConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#AliasName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^[\\w\\-]+|(\\$LATEST)|(\\$PUBLISHED)$" - } - }, - "com.amazonaws.quicksight#AllSheetsFilterScopeConfiguration": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

An empty object that represents that the AllSheets option is the chosen value for the FilterScopeConfiguration parameter. This structure applies the filter to all visuals on all sheets of an Analysis, Dashboard, or Template.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#AmazonElasticsearchParameters": { - "type": "structure", - "members": { - "Domain": { - "target": "com.amazonaws.quicksight#Domain", - "traits": { - "smithy.api#documentation": "

The OpenSearch domain.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for OpenSearch.

" - } - }, - "com.amazonaws.quicksight#AmazonOpenSearchParameters": { - "type": "structure", - "members": { - "Domain": { - "target": "com.amazonaws.quicksight#Domain", - "traits": { - "smithy.api#documentation": "

The OpenSearch domain.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for OpenSearch.

" - } - }, - "com.amazonaws.quicksight#Analysis": { - "type": "structure", - "members": { - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the analysis.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#AnalysisName", - "traits": { - "smithy.api#documentation": "

The descriptive name of the analysis.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

Status associated with the analysis.

" - } - }, - "Errors": { - "target": "com.amazonaws.quicksight#AnalysisErrorList", - "traits": { - "smithy.api#documentation": "

Errors associated with the analysis.

" - } - }, - "DataSetArns": { - "target": "com.amazonaws.quicksight#DataSetArnsList", - "traits": { - "smithy.api#documentation": "

The ARNs of the datasets of the analysis.

" - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the theme of the analysis.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the analysis was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the analysis was last updated.

" - } - }, - "Sheets": { - "target": "com.amazonaws.quicksight#SheetList", - "traits": { - "smithy.api#documentation": "

A list of the associated sheets with the unique identifier and name of each sheet.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata structure for an analysis in Amazon QuickSight

" - } - }, - "com.amazonaws.quicksight#AnalysisDefaults": { - "type": "structure", - "members": { - "DefaultNewSheetConfiguration": { - "target": "com.amazonaws.quicksight#DefaultNewSheetConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration for default new sheet settings.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for default analysis settings.

" - } - }, - "com.amazonaws.quicksight#AnalysisDefinition": { - "type": "structure", - "members": { - "DataSetIdentifierDeclarations": { - "target": "com.amazonaws.quicksight#DataSetIdentifierDeclarationList", - "traits": { - "smithy.api#documentation": "

An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead\n of dataset ARNs throughout analysis sub-structures.

", - "smithy.api#required": {} - } - }, - "Sheets": { - "target": "com.amazonaws.quicksight#SheetDefinitionList", - "traits": { - "smithy.api#documentation": "

An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about\n a sheet within this analysis.

" - } - }, - "CalculatedFields": { - "target": "com.amazonaws.quicksight#CalculatedFields", - "traits": { - "smithy.api#documentation": "

An array of calculated field definitions for the analysis.

" - } - }, - "ParameterDeclarations": { - "target": "com.amazonaws.quicksight#ParameterDeclarationList", - "traits": { - "smithy.api#documentation": "

An array of parameter declarations for an analysis.

\n

Parameters are named variables that can transfer a value for use by an action or an object.

\n

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

" - } - }, - "FilterGroups": { - "target": "com.amazonaws.quicksight#FilterGroupList", - "traits": { - "smithy.api#documentation": "

Filter definitions for an analysis.

\n

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.

" - } - }, - "ColumnConfigurations": { - "target": "com.amazonaws.quicksight#ColumnConfigurationList", - "traits": { - "smithy.api#documentation": "

\n An array of analysis-level column configurations. Column configurations can be used to set default\n formatting for a column to be used throughout an analysis.\n

" - } - }, - "AnalysisDefaults": { - "target": "com.amazonaws.quicksight#AnalysisDefaults" - }, - "Options": { - "target": "com.amazonaws.quicksight#AssetOptions", - "traits": { - "smithy.api#documentation": "

An array of option definitions for an analysis.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition of an analysis.

" - } - }, - "com.amazonaws.quicksight#AnalysisError": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.quicksight#AnalysisErrorType", - "traits": { - "smithy.api#documentation": "

The type of the analysis error.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The message associated with the analysis error.

" - } - }, - "ViolatedEntities": { - "target": "com.amazonaws.quicksight#EntityList", - "traits": { - "smithy.api#documentation": "

Lists the violated entities that caused the analysis error

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Analysis error.

" - } - }, - "com.amazonaws.quicksight#AnalysisErrorList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AnalysisError" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.quicksight#AnalysisErrorType": { - "type": "enum", - "members": { - "ACCESS_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCESS_DENIED" - } - }, - "SOURCE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOURCE_NOT_FOUND" - } - }, - "DATA_SET_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_SET_NOT_FOUND" - } - }, - "INTERNAL_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_FAILURE" - } - }, - "PARAMETER_VALUE_INCOMPATIBLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARAMETER_VALUE_INCOMPATIBLE" - } - }, - "PARAMETER_TYPE_INVALID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARAMETER_TYPE_INVALID" - } - }, - "PARAMETER_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARAMETER_NOT_FOUND" - } - }, - "COLUMN_TYPE_MISMATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLUMN_TYPE_MISMATCH" - } - }, - "COLUMN_GEOGRAPHIC_ROLE_MISMATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLUMN_GEOGRAPHIC_ROLE_MISMATCH" - } - }, - "COLUMN_REPLACEMENT_MISSING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLUMN_REPLACEMENT_MISSING" - } - } - } - }, - "com.amazonaws.quicksight#AnalysisFilterAttribute": { - "type": "enum", - "members": { - "QUICKSIGHT_USER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT_USER" - } - }, - "QUICKSIGHT_VIEWER_OR_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT_VIEWER_OR_OWNER" - } - }, - "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" - } - }, - "QUICKSIGHT_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT_OWNER" - } - }, - "DIRECT_QUICKSIGHT_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_OWNER" - } - }, - "DIRECT_QUICKSIGHT_SOLE_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_SOLE_OWNER" - } - }, - "ANALYSIS_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ANALYSIS_NAME" - } - } - } - }, - "com.amazonaws.quicksight#AnalysisName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#AnalysisSearchFilter": { - "type": "structure", - "members": { - "Operator": { - "target": "com.amazonaws.quicksight#FilterOperator", - "traits": { - "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\": \"StringEquals\". Valid values are \"StringEquals\" and \"StringLike\".

\n

If you set the operator value to \"StringEquals\", you need to provide an ownership related filter in the \"NAME\" field and the arn of the user or group whose folders you want to search in the \"Value\" field. For example, \"Name\":\"DIRECT_QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

\n

If you set the value to \"StringLike\", you need to provide the name of the folders you are searching for. For example, \"Name\":\"ANALYSIS_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\". The \"StringLike\" operator only supports the NAME value ANALYSIS_NAME.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#AnalysisFilterAttribute", - "traits": { - "smithy.api#documentation": "

The name of the value that you want to use as a filter, for example \"Name\":\n \"QUICKSIGHT_OWNER\".

\n

Valid values are defined as follows:

\n " - } - }, - "Value": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The value of the named item, in this case QUICKSIGHT_USER, that you want\n to use as a filter, for example \"Value\". An example is\n \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A filter that you apply when searching for one or more analyses.

" - } - }, - "com.amazonaws.quicksight#AnalysisSearchFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AnalysisSearchFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#AnalysisSourceEntity": { - "type": "structure", - "members": { - "SourceTemplate": { - "target": "com.amazonaws.quicksight#AnalysisSourceTemplate", - "traits": { - "smithy.api#documentation": "

The source template for the source entity of the analysis.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The source entity of an analysis.

" - } - }, - "com.amazonaws.quicksight#AnalysisSourceTemplate": { - "type": "structure", - "members": { - "DataSetReferences": { - "target": "com.amazonaws.quicksight#DataSetReferenceList", - "traits": { - "smithy.api#documentation": "

The dataset references of the source template of an analysis.

", - "smithy.api#required": {} - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source template of an analysis.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The source template of an analysis.

" - } - }, - "com.amazonaws.quicksight#AnalysisSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the analysis.

" - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis. This ID displays in the URL.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#AnalysisName", - "traits": { - "smithy.api#documentation": "

The name of the analysis. This name is displayed in the Amazon QuickSight console.\n

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The last known status for the analysis.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the analysis was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the analysis was last updated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The summary metadata that describes an analysis.

" - } - }, - "com.amazonaws.quicksight#AnalysisSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AnalysisSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#Anchor": { - "type": "structure", - "members": { - "AnchorType": { - "target": "com.amazonaws.quicksight#AnchorType", - "traits": { - "smithy.api#documentation": "

The AnchorType for the Anchor.

" - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The TimeGranularity of the Anchor.

" - } - }, - "Offset": { - "target": "com.amazonaws.quicksight#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The offset of the Anchor.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition of the Anchor.

" - } - }, - "com.amazonaws.quicksight#AnchorDateConfiguration": { - "type": "structure", - "members": { - "AnchorOption": { - "target": "com.amazonaws.quicksight#AnchorOption", - "traits": { - "smithy.api#documentation": "

The options for the date configuration. Choose one of the options below:

\n " - } - }, - "ParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The name of the parameter that is used for the anchor date configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The date configuration of the filter.

" - } - }, - "com.amazonaws.quicksight#AnchorOption": { - "type": "enum", - "members": { - "NOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOW" - } - } - } - }, - "com.amazonaws.quicksight#AnchorType": { - "type": "enum", - "members": { - "TODAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TODAY" - } - } - } - }, - "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfiguration": { - "type": "structure", - "members": { - "InitialDashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard.

\n

The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the dashboard that you want to embed.

" - } - }, - "com.amazonaws.quicksight#AnonymousUserDashboardVisualEmbeddingConfiguration": { - "type": "structure", - "members": { - "InitialDashboardVisualId": { - "target": "com.amazonaws.quicksight#DashboardVisualId", - "traits": { - "smithy.api#documentation": "

The visual ID for the visual that you want the user to see. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.

\n

The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.

" - } - }, - "com.amazonaws.quicksight#AnonymousUserEmbeddingExperienceConfiguration": { - "type": "structure", - "members": { - "Dashboard": { - "target": "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfiguration", - "traits": { - "smithy.api#documentation": "

The type of embedding experience. In this case, Amazon QuickSight dashboards.

" - } - }, - "DashboardVisual": { - "target": "com.amazonaws.quicksight#AnonymousUserDashboardVisualEmbeddingConfiguration", - "traits": { - "smithy.api#documentation": "

The type of embedding experience. In this case, Amazon QuickSight visuals.

" - } - }, - "QSearchBar": { - "target": "com.amazonaws.quicksight#AnonymousUserQSearchBarEmbeddingConfiguration", - "traits": { - "smithy.api#documentation": "

The Q search bar that you want to use for anonymous user embedding.

" - } - }, - "GenerativeQnA": { - "target": "com.amazonaws.quicksight#AnonymousUserGenerativeQnAEmbeddingConfiguration", - "traits": { - "smithy.api#documentation": "

The Generative Q&A experience that you want to use for anonymous user embedding.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The type of experience you want to embed. For anonymous users, you can embed Amazon QuickSight dashboards.

" - } - }, - "com.amazonaws.quicksight#AnonymousUserGenerativeQnAEmbeddingConfiguration": { - "type": "structure", - "members": { - "InitialTopicId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight Q topic ID of the new reader experience topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Generative Q&A experience with this new reader experience topic pre selected.

\n

The Amazon Resource Name (ARN) of this Q new reader experience topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The settings that you want to use for the Generative Q&A experience.

" - } - }, - "com.amazonaws.quicksight#AnonymousUserQSearchBarEmbeddingConfiguration": { - "type": "structure", - "members": { - "InitialTopicId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight Q topic ID of the legacy topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this legacy topic pre-selected.

\n

The Amazon Resource Name (ARN) of this Q legacy topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The settings that you want to use with the Q search bar.

" - } - }, - "com.amazonaws.quicksight#AnonymousUserSnapshotJobResult": { - "type": "structure", - "members": { - "FileGroups": { - "target": "com.amazonaws.quicksight#SnapshotJobResultFileGroupList", - "traits": { - "smithy.api#documentation": "

A list of SnapshotJobResultFileGroup objects that contain information on the files that are requested during a StartDashboardSnapshotJob API call. If the job succeeds, these objects contain the location where the snapshot artifacts are stored. If the job fails, the objects contain information about the error that caused the job to fail.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains the file groups that are requested for the artifact generation in a StartDashboardSnapshotJob API call.\n

" - } - }, - "com.amazonaws.quicksight#AnonymousUserSnapshotJobResultList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AnonymousUserSnapshotJobResult" - } - }, - "com.amazonaws.quicksight#AnswerId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[A-Za-z0-9-_.\\\\+]*$" - } - }, - "com.amazonaws.quicksight#AnswerIds": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AnswerId" - } - }, - "com.amazonaws.quicksight#ArcAxisConfiguration": { - "type": "structure", - "members": { - "Range": { - "target": "com.amazonaws.quicksight#ArcAxisDisplayRange", - "traits": { - "smithy.api#documentation": "

The arc axis range of a GaugeChartVisual.

" - } - }, - "ReserveRange": { - "target": "com.amazonaws.quicksight#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The reserved range of the arc axis.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The arc axis configuration of a GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#ArcAxisDisplayRange": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The minimum value of the arc axis range.

" - } - }, - "Max": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum value of the arc axis range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The arc axis range of a GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#ArcConfiguration": { - "type": "structure", - "members": { - "ArcAngle": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The option that determines the arc angle of a GaugeChartVisual.

" - } - }, - "ArcThickness": { - "target": "com.amazonaws.quicksight#ArcThicknessOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the arc thickness of a GaugeChartVisual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The arc configuration of a GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#ArcOptions": { - "type": "structure", - "members": { - "ArcThickness": { - "target": "com.amazonaws.quicksight#ArcThickness", - "traits": { - "smithy.api#documentation": "

The arc thickness of a GaugeChartVisual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the arc thickness of a GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#ArcThickness": { - "type": "enum", - "members": { - "SMALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SMALL" - } - }, - "MEDIUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIUM" - } - }, - "LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LARGE" - } - }, - "WHOLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WHOLE" - } - } - } - }, - "com.amazonaws.quicksight#ArcThicknessOptions": { - "type": "enum", - "members": { - "SMALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SMALL" - } - }, - "MEDIUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIUM" - } - }, - "LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LARGE" - } - } - } - }, - "com.amazonaws.quicksight#Arn": { - "type": "string" - }, - "com.amazonaws.quicksight#ArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Arn" - } - }, - "com.amazonaws.quicksight#AssetBundleCloudFormationOverridePropertyConfiguration": { - "type": "structure", - "members": { - "ResourceIdOverrideConfiguration": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobResourceIdOverrideConfiguration", - "traits": { - "smithy.api#documentation": "

An optional list of structures that control how resource IDs are parameterized in the returned CloudFormation template.

" - } - }, - "VPCConnections": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionOverridePropertiesList", - "traits": { - "smithy.api#documentation": "

An optional list of structures that control how VPCConnection resources are parameterized in the returned CloudFormation template.

" - } - }, - "RefreshSchedules": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobRefreshScheduleOverridePropertiesList", - "traits": { - "smithy.api#documentation": "

An optional list of structures that control how RefreshSchedule resources are parameterized in the returned CloudFormation template.

" - } - }, - "DataSources": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSourceOverridePropertiesList", - "traits": { - "smithy.api#documentation": "

An optional list of structures that control how DataSource resources are parameterized in the returned CloudFormation template.

" - } - }, - "DataSets": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSetOverridePropertiesList", - "traits": { - "smithy.api#documentation": "

An optional list of structures that control how DataSet resources are parameterized in the returned CloudFormation template.

" - } - }, - "Themes": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobThemeOverridePropertiesList", - "traits": { - "smithy.api#documentation": "

An optional list of structures that control how Theme resources are parameterized in the returned CloudFormation template.

" - } - }, - "Analyses": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobAnalysisOverridePropertiesList", - "traits": { - "smithy.api#documentation": "

An optional list of structures that control how Analysis resources are parameterized in the returned CloudFormation template.

" - } - }, - "Dashboards": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDashboardOverridePropertiesList", - "traits": { - "smithy.api#documentation": "

An optional list of structures that control how Dashboard resources are parameterized in the returned CloudFormation template.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An optional collection of CloudFormation property configurations that control how the export job is generated.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportFormat": { - "type": "enum", - "members": { - "CLOUDFORMATION_JSON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLOUDFORMATION_JSON" - } - }, - "QUICKSIGHT_JSON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT_JSON" - } - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobAnalysisOverrideProperties": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the specific Analysis resource whose override properties are configured in this structure.

", - "smithy.api#required": {} - } - }, - "Properties": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobAnalysisPropertyToOverrideList", - "traits": { - "smithy.api#documentation": "

A list of Analysis resource properties to generate variables for in the returned CloudFormation template.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Controls how a specific Analysis resource is parameterized in the returned CloudFormation template.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobAnalysisOverridePropertiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobAnalysisOverrideProperties" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobAnalysisPropertyToOverride": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobAnalysisPropertyToOverrideList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobAnalysisPropertyToOverride" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDashboardOverrideProperties": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the specific Dashboard resource whose override properties are configured in this structure.

", - "smithy.api#required": {} - } - }, - "Properties": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDashboardPropertyToOverrideList", - "traits": { - "smithy.api#documentation": "

A list of Dashboard resource properties to generate variables for in the returned CloudFormation template.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Controls how a specific Dashboard resource is parameterized in the returned CloudFormation template.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDashboardOverridePropertiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDashboardOverrideProperties" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDashboardPropertyToOverride": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDashboardPropertyToOverrideList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDashboardPropertyToOverride" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDataSetOverrideProperties": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the specific DataSet resource whose override properties are configured in this structure.

", - "smithy.api#required": {} - } - }, - "Properties": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSetPropertyToOverrideList", - "traits": { - "smithy.api#documentation": "

A list of DataSet resource properties to generate variables for in the returned CloudFormation template.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Controls how a specific DataSet resource is parameterized in the returned CloudFormation template.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDataSetOverridePropertiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSetOverrideProperties" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDataSetPropertyToOverride": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDataSetPropertyToOverrideList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSetPropertyToOverride" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDataSourceOverrideProperties": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the specific DataSource resource whose override properties are configured in this structure.

", - "smithy.api#required": {} - } - }, - "Properties": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSourcePropertyToOverrideList", - "traits": { - "smithy.api#documentation": "

A list of DataSource resource properties to generate variables for in the returned CloudFormation template.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Controls how a specific DataSource resource is parameterized in the returned CloudFormation template.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDataSourceOverridePropertiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSourceOverrideProperties" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDataSourcePropertyToOverride": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "DISABLE_SSL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DisableSsl" - } - }, - "SECRET_ARN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SecretArn" - } - }, - "USERNAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Username" - } - }, - "PASSWORD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Password" - } - }, - "DOMAIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Domain" - } - }, - "WORK_GROUP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WorkGroup" - } - }, - "HOST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Host" - } - }, - "PORT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Port" - } - }, - "DATABASE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Database" - } - }, - "DATA_SET_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DataSetName" - } - }, - "CATALOG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Catalog" - } - }, - "INSTANCE_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InstanceId" - } - }, - "CLUSTER_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ClusterId" - } - }, - "MANIFEST_FILE_LOCATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ManifestFileLocation" - } - }, - "WAREHOUSE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Warehouse" - } - }, - "ROLE_ARN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RoleArn" - } - }, - "PRODUCT_TYPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ProductType" - } - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDataSourcePropertyToOverrideList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSourcePropertyToOverride" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobError": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the resource whose processing caused an error.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The specific error type of the error that occurred.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A description of the error.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an error that occurred during an Asset Bundle export job.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobErrorList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobError" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobRefreshScheduleOverrideProperties": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the specific RefreshSchedule resource whose override properties are configured in this structure.

", - "smithy.api#required": {} - } - }, - "Properties": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobRefreshSchedulePropertyToOverrideList", - "traits": { - "smithy.api#documentation": "

A list of RefreshSchedule resource properties to generate variables for in the returned CloudFormation template.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Controls how a specific RefreshSchedule resource is parameterized in the returned CloudFormation template.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobRefreshScheduleOverridePropertiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobRefreshScheduleOverrideProperties" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobRefreshSchedulePropertyToOverride": { - "type": "enum", - "members": { - "START_AFTER_DATE_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StartAfterDateTime" - } - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobRefreshSchedulePropertyToOverrideList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobRefreshSchedulePropertyToOverride" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobResourceIdOverrideConfiguration": { - "type": "structure", - "members": { - "PrefixForAllResources": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An optional structure that configures resource ID overrides for the export job.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobStatus": { - "type": "enum", - "members": { - "QUEUED_FOR_IMMEDIATE_EXECUTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUEUED_FOR_IMMEDIATE_EXECUTION" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "SUCCESSFUL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESSFUL" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobSummary": { - "type": "structure", - "members": { - "JobStatus": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobStatus", - "traits": { - "smithy.api#documentation": "

The current status of the export job.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the export job.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the export job was created.

" - } - }, - "AssetBundleExportJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the export job.

" - } - }, - "IncludeAllDependencies": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The flag that determines the inclusion of resource dependencies in the returned asset bundle.

" - } - }, - "ExportFormat": { - "target": "com.amazonaws.quicksight#AssetBundleExportFormat", - "traits": { - "smithy.api#documentation": "

The format for the export job.

" - } - }, - "IncludePermissions": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The flag that determines the inclusion of permissions associated with each resource ARN.

" - } - }, - "IncludeTags": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The flag that determines the inclusion of tags associated with each resource ARN.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A summary of the export job that includes details of the job's configuration and its current status.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobSummary" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobThemeOverrideProperties": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the specific Theme resource whose override properties are configured in this structure.

", - "smithy.api#required": {} - } - }, - "Properties": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobThemePropertyToOverrideList", - "traits": { - "smithy.api#documentation": "

A list of Theme resource properties to generate variables for in the returned CloudFormation template.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Controls how a specific Theme resource is parameterized in the returned CloudFormation template.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobThemeOverridePropertiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobThemeOverrideProperties" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobThemePropertyToOverride": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobThemePropertyToOverrideList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobThemePropertyToOverride" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionOverrideProperties": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the specific VPCConnection resource whose override properties are configured in this structure.

", - "smithy.api#required": {} - } - }, - "Properties": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionPropertyToOverrideList", - "traits": { - "smithy.api#documentation": "

A list of VPCConnection resource properties to generate variables for in the returned CloudFormation template.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Controls how a specific VPCConnection resource is parameterized in the outputted CloudFormation template.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionOverridePropertiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionOverrideProperties" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionPropertyToOverride": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "DNS_RESOLVERS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DnsResolvers" - } - }, - "ROLE_ARN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RoleArn" - } - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionPropertyToOverrideList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionPropertyToOverride" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobValidationStrategy": { - "type": "structure", - "members": { - "StrictModeForAllResources": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates whether to export resources under strict or lenient mode.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The option to relax the validation that is required to export each asset. When StrictModeForAllResource is set to false, validation is skipped for specific UI errors.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobWarning": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the resource whose processing caused a warning.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A description of the warning.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a warning that occurred during an Asset Bundle export job.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobWarningList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobWarning" - } - }, - "com.amazonaws.quicksight#AssetBundleImportBodyBlob": { - "type": "blob", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20971520 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#AssetBundleImportFailureAction": { - "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" - } - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideParameters": { - "type": "structure", - "members": { - "AnalysisId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis that you ant to apply overrides to.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

A new name for the analysis.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The override parameters for a single analysis that is being imported.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideParametersList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideParameters" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverridePermissions": { - "type": "structure", - "members": { - "AnalysisIds": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", - "traits": { - "smithy.api#documentation": "

A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.

", - "smithy.api#required": {} - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", - "traits": { - "smithy.api#documentation": "

A list of permissions for the analyses that you want to apply overrides to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains a list of permissions to be applied to a list of analysis IDs.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverridePermissionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverridePermissions" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideTags": { - "type": "structure", - "members": { - "AnalysisIds": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", - "traits": { - "smithy.api#documentation": "

A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

A list of tags for the analyses that you want to apply overrides to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of analysis IDs.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideTagsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideTags" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideParameters": { - "type": "structure", - "members": { - "DashboardId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dashboard that you want to apply overrides to.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

A new name for the dashboard.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The override parameters for a single dashboard that is being imported.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideParametersList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideParameters" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverridePermissions": { - "type": "structure", - "members": { - "DashboardIds": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", - "traits": { - "smithy.api#documentation": "

A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.

", - "smithy.api#required": {} - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", - "traits": { - "smithy.api#documentation": "

A list of permissions for the dashboards that you want to apply overrides to.

" - } - }, - "LinkSharingConfiguration": { - "target": "com.amazonaws.quicksight#AssetBundleResourceLinkSharingConfiguration", - "traits": { - "smithy.api#documentation": "

A structure that contains the link sharing configurations that you want to apply overrides to.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains a list of permissions to be applied to a list of dashboard IDs.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverridePermissionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverridePermissions" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideTags": { - "type": "structure", - "members": { - "DashboardIds": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", - "traits": { - "smithy.api#documentation": "

A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

A list of tags for the dashboards that you want to apply overrides to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of dashboard IDs.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideTagsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideTags" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideParameters": { - "type": "structure", - "members": { - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset to apply overrides to.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

A new name for the dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The override parameters for a single dataset that is being imported.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideParametersList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideParameters" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverridePermissions": { - "type": "structure", - "members": { - "DataSetIds": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", - "traits": { - "smithy.api#documentation": "

A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.

", - "smithy.api#required": {} - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", - "traits": { - "smithy.api#documentation": "

A list of permissions for the datasets that you want to apply overrides to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains a list of permissions to be applied to a list of dataset IDs.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverridePermissionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverridePermissions" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideTags": { - "type": "structure", - "members": { - "DataSetIds": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", - "traits": { - "smithy.api#documentation": "

A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

A list of tags for the datasets that you want to apply overrides to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of dataset IDs.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideTagsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideTags" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSourceCredentialPair": { - "type": "structure", - "members": { - "Username": { - "target": "com.amazonaws.quicksight#DbUsername", - "traits": { - "smithy.api#documentation": "

The username for the data source connection.

", - "smithy.api#required": {} - } - }, - "Password": { - "target": "com.amazonaws.quicksight#Password", - "traits": { - "smithy.api#documentation": "

The password for the data source connection.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A username and password credential pair to use to import a data source resource.

", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSourceCredentials": { - "type": "structure", - "members": { - "CredentialPair": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceCredentialPair", - "traits": { - "smithy.api#documentation": "

A username and password credential pair to be used to create the imported data source. Keep this field blank if you are using a Secrets Manager secret to provide credentials.

" - } - }, - "SecretArn": { - "target": "com.amazonaws.quicksight#SecretArn", - "traits": { - "smithy.api#documentation": "

The ARN of the Secrets Manager secret that's used to create the imported data source. Keep this field blank, unless you are using a secret in place of a credential pair.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The login credentials to use to import a data source resource.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideParameters": { - "type": "structure", - "members": { - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source to apply overrides to.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

A new name for the data source.

" - } - }, - "DataSourceParameters": { - "target": "com.amazonaws.quicksight#DataSourceParameters" - }, - "VpcConnectionProperties": { - "target": "com.amazonaws.quicksight#VpcConnectionProperties" - }, - "SslProperties": { - "target": "com.amazonaws.quicksight#SslProperties" - }, - "Credentials": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceCredentials", - "traits": { - "smithy.api#documentation": "

An optional structure that provides the credentials to be used to create the imported data source.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The override parameters for a single data source that is being imported.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideParametersList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideParameters" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverridePermissions": { - "type": "structure", - "members": { - "DataSourceIds": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", - "traits": { - "smithy.api#documentation": "

A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.

", - "smithy.api#required": {} - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", - "traits": { - "smithy.api#documentation": "

A list of permissions for the data source that you want to apply overrides to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains a list of permissions to be applied to a list of data source IDs.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverridePermissionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverridePermissions" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideTags": { - "type": "structure", - "members": { - "DataSourceIds": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", - "traits": { - "smithy.api#documentation": "

A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

A list of tags for the data source that you want to apply overrides to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of data source IDs.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideTagsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideTags" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobError": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the resource whose processing caused an error.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The specific error type or the error that occurred.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A description of the error.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an error that occurred within an Asset Bundle import execution.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobErrorList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobError" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobOverrideParameters": { - "type": "structure", - "members": { - "ResourceIdOverrideConfiguration": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobResourceIdOverrideConfiguration", - "traits": { - "smithy.api#documentation": "

An optional structure that configures resource ID overrides to be applied within the import job.

" - } - }, - "VPCConnections": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideParametersList", - "traits": { - "smithy.api#documentation": "

A list of overrides for any VPCConnection resources that are present in the asset bundle that is imported.

" - } - }, - "RefreshSchedules": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobRefreshScheduleOverrideParametersList", - "traits": { - "smithy.api#documentation": "

A list of overrides for any RefreshSchedule resources that are present in the asset bundle that is imported.

" - } - }, - "DataSources": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideParametersList", - "traits": { - "smithy.api#documentation": "

A list of overrides for any DataSource resources that are present in the asset bundle that is imported.

" - } - }, - "DataSets": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideParametersList", - "traits": { - "smithy.api#documentation": "

A list of overrides for any DataSet resources that are present in the asset bundle that is imported.

" - } - }, - "Themes": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideParametersList", - "traits": { - "smithy.api#documentation": "

A list of overrides for any Theme resources that are present in the asset bundle that is imported.

" - } - }, - "Analyses": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideParametersList", - "traits": { - "smithy.api#documentation": "

A list of overrides for any Analysis resources that are present in the asset bundle that is imported.

" - } - }, - "Dashboards": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideParametersList", - "traits": { - "smithy.api#documentation": "

A list of overrides for any Dashboard resources that are present in the asset bundle that is imported.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A list of overrides that modify the asset bundle resource configuration before the resource is imported.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobOverridePermissions": { - "type": "structure", - "members": { - "DataSources": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverridePermissionsList", - "traits": { - "smithy.api#documentation": "

A list of permissions overrides for any DataSource resources that are present in the asset bundle that is imported.

" - } - }, - "DataSets": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverridePermissionsList", - "traits": { - "smithy.api#documentation": "

A list of permissions overrides for any DataSet resources that are present in the asset bundle that is imported.

" - } - }, - "Themes": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverridePermissionsList", - "traits": { - "smithy.api#documentation": "

A list of permissions overrides for any Theme resources that are present in the asset bundle that is imported.

" - } - }, - "Analyses": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverridePermissionsList", - "traits": { - "smithy.api#documentation": "

A list of permissions overrides for any Analysis resources that are present in the asset bundle that is imported.

" - } - }, - "Dashboards": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverridePermissionsList", - "traits": { - "smithy.api#documentation": "

A list of permissions overrides for any Dashboard resources that are present in the asset bundle that is imported.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains the override permission configurations that modify the permissions for specified resources before the resource is imported.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobOverrideTags": { - "type": "structure", - "members": { - "VPCConnections": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideTagsList", - "traits": { - "smithy.api#documentation": "

A list of tag overrides for any VPCConnection resources that are present in the asset bundle that is imported.

" - } - }, - "DataSources": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideTagsList", - "traits": { - "smithy.api#documentation": "

A list of tag overrides for any DataSource resources that are present in the asset bundle that is imported.

" - } - }, - "DataSets": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideTagsList", - "traits": { - "smithy.api#documentation": "

A list of tag overrides for any DataSet resources that are present in the asset bundle that is imported.

" - } - }, - "Themes": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideTagsList", - "traits": { - "smithy.api#documentation": "

A list of tag overrides for any Theme resources that are present in the asset bundle that is imported.

" - } - }, - "Analyses": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideTagsList", - "traits": { - "smithy.api#documentation": "

A list of tag overrides for any Analysis resources that are present in the asset bundle that is imported.

" - } - }, - "Dashboards": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideTagsList", - "traits": { - "smithy.api#documentation": "

A list of tag overrides for any Dashboard resources that are present in the asset bundle that is imported.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains the override tag configuration that modify the tags that are assigned to specified resources before the resource is imported.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobOverrideValidationStrategy": { - "type": "structure", - "members": { - "StrictModeForAllResources": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An optional parameter that overrides the validation strategy for all analyses and dashboards before the resource is imported.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobRefreshScheduleOverrideParameters": { - "type": "structure", - "members": { - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

A partial identifier for the specific RefreshSchedule resource that is being overridden. This structure is used together with the ScheduleID structure.

", - "smithy.api#required": {} - } - }, - "ScheduleId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A partial identifier for the specific RefreshSchedule resource being overridden. This structure is used together with the DataSetId structure.

", - "smithy.api#required": {} - } - }, - "StartAfterDateTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

An override for the StartAfterDateTime of a RefreshSchedule. Make\n sure that the StartAfterDateTime is set to a time that takes\n place in the future.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A list of overrides for a specific RefreshsSchedule resource that is present in the asset bundle that is imported.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobRefreshScheduleOverrideParametersList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobRefreshScheduleOverrideParameters" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobResourceIdOverrideConfiguration": { - "type": "structure", - "members": { - "PrefixForAllResources": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An optional structure that configures resource ID overrides for the import job.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobStatus": { - "type": "enum", - "members": { - "QUEUED_FOR_IMMEDIATE_EXECUTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUEUED_FOR_IMMEDIATE_EXECUTION" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "SUCCESSFUL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESSFUL" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "FAILED_ROLLBACK_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_ROLLBACK_IN_PROGRESS" - } - }, - "FAILED_ROLLBACK_COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_ROLLBACK_COMPLETED" - } - }, - "FAILED_ROLLBACK_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_ROLLBACK_ERROR" - } - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobSummary": { - "type": "structure", - "members": { - "JobStatus": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobStatus", - "traits": { - "smithy.api#documentation": "

The current status of the import job.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the import job.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the import job was created.

" - } - }, - "AssetBundleImportJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

" - } - }, - "FailureAction": { - "target": "com.amazonaws.quicksight#AssetBundleImportFailureAction", - "traits": { - "smithy.api#documentation": "

The failure action for the import job.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A summary of the import job that includes details of the requested job's configuration and its current status.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobSummary" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideParameters": { - "type": "structure", - "members": { - "ThemeId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the theme to apply overrides to.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

A new name for the theme.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The override parameters for a single theme that is imported.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideParametersList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideParameters" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobThemeOverridePermissions": { - "type": "structure", - "members": { - "ThemeIds": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", - "traits": { - "smithy.api#documentation": "

A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.

", - "smithy.api#required": {} - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", - "traits": { - "smithy.api#documentation": "

A list of permissions for the themes that you want to apply overrides to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains a list of permissions to be applied to a list of theme IDs.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobThemeOverridePermissionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverridePermissions" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideTags": { - "type": "structure", - "members": { - "ThemeIds": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", - "traits": { - "smithy.api#documentation": "

A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

A list of tags for the themes that you want to apply overrides to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of theme IDs.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideTagsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideTags" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideParameters": { - "type": "structure", - "members": { - "VPCConnectionId": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", - "traits": { - "smithy.api#documentation": "

The ID of the VPC Connection to apply overrides to.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

A new name for the VPC connection.

" - } - }, - "SubnetIds": { - "target": "com.amazonaws.quicksight#SubnetIdList", - "traits": { - "smithy.api#documentation": "

A list of new subnet IDs for the VPC connection you are importing. This field is\n required if you are importing the VPC connection from another Amazon Web Services account or Region.

" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.quicksight#SecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A new security group ID for the VPC connection you are importing. This field is required\n if you are importing the VPC connection from another Amazon Web Services account or Region.

" - } - }, - "DnsResolvers": { - "target": "com.amazonaws.quicksight#DnsResolverList", - "traits": { - "smithy.api#documentation": "

An optional override of DNS resolvers to be used by the VPC connection.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.quicksight#RoleArn", - "traits": { - "smithy.api#documentation": "

An optional override of the role ARN to be used by the VPC connection.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The override parameters for a single VPC connection that is imported.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideParametersList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideParameters" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideTags": { - "type": "structure", - "members": { - "VPCConnectionIds": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", - "traits": { - "smithy.api#documentation": "

A list of VPC connection IDs that you want to apply overrides to. You can use * to override all VPC connections in this asset bundle.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

A list of tags for the VPC connections that you want to apply overrides to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of VPC connection IDs.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideTagsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideTags" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobWarning": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the resource that the warning occurred for.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A description of the warning that occurred during an Asset Bundle import job.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a warning that occurred during an Asset Bundle import job.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobWarningList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobWarning" - } - }, - "com.amazonaws.quicksight#AssetBundleImportSource": { - "type": "structure", - "members": { - "Body": { - "target": "com.amazonaws.quicksight#AssetBundleImportBodyBlob", - "traits": { - "smithy.api#documentation": "

The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB.

\n

If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or\n PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using\n an SDK for a different language or receiving related errors, try to base64 encode your data.

" - } - }, - "S3Uri": { - "target": "com.amazonaws.quicksight#S3Uri", - "traits": { - "smithy.api#documentation": "

The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller\n has read access to. The file must be a zip format file and can't exceed 20 MB.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportSourceDescription": { - "type": "structure", - "members": { - "Body": { - "target": "com.amazonaws.quicksight#SensitiveS3Uri", - "traits": { - "smithy.api#documentation": "

An HTTPS download URL for the provided asset bundle that you optionally provided at the start of the import job. This URL is valid for five minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed. The downloaded asset bundle is a .qs zip file.

" - } - }, - "S3Uri": { - "target": "com.amazonaws.quicksight#S3Uri", - "traits": { - "smithy.api#documentation": "

The Amazon S3 URI that you provided at the start of the import job.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A description of the import source that you provide at the start of an import job. This value is set to either Body or S3Uri, depending on how the StartAssetBundleImportJobRequest is configured.

" - } - }, - "com.amazonaws.quicksight#AssetBundlePrincipalList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Principal" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#AssetBundleResourceArns": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Arn" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#AssetBundleResourceLinkSharingConfiguration": { - "type": "structure", - "members": { - "Permissions": { - "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", - "traits": { - "smithy.api#documentation": "

A list of link sharing permissions for the dashboards that you want to apply overrides to.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains the configuration of a shared link to an Amazon QuickSight dashboard.

" - } - }, - "com.amazonaws.quicksight#AssetBundleResourcePermissions": { - "type": "structure", - "members": { - "Principals": { - "target": "com.amazonaws.quicksight#AssetBundlePrincipalList", - "traits": { - "smithy.api#documentation": "

A list of principals to grant permissions on.

", - "smithy.api#required": {} - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#ActionList", - "traits": { - "smithy.api#documentation": "

A list of IAM actions to grant permissions on.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains the permissions for the resource that you want to override in an asset bundle import job.

" - } - }, - "com.amazonaws.quicksight#AssetBundleRestrictiveResourceId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^\\*|[\\w\\-]{1,2048}$" - } - }, - "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetOptions": { - "type": "structure", - "members": { - "Timezone": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

Determines the timezone for the analysis.

" - } - }, - "WeekStart": { - "target": "com.amazonaws.quicksight#DayOfTheWeek", - "traits": { - "smithy.api#documentation": "

Determines the week start day for an analysis.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An array of analysis level configurations.

" - } - }, - "com.amazonaws.quicksight#AssignmentStatus": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DRAFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DRAFT" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.quicksight#AthenaParameters": { - "type": "structure", - "members": { - "WorkGroup": { - "target": "com.amazonaws.quicksight#WorkGroup", - "traits": { - "smithy.api#documentation": "

The workgroup that Amazon Athena uses.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.quicksight#RoleArn", - "traits": { - "smithy.api#documentation": "

Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Parameters for Amazon Athena.

" - } - }, - "com.amazonaws.quicksight#AttributeAggregationFunction": { - "type": "structure", - "members": { - "SimpleAttributeAggregation": { - "target": "com.amazonaws.quicksight#SimpleAttributeAggregationFunction", - "traits": { - "smithy.api#documentation": "

The built-in aggregation functions for attributes.

\n " - } - }, - "ValueForMultipleValues": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to '*'.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Aggregation for attributes.

" - } - }, - "com.amazonaws.quicksight#AuroraParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

Host.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

Port.

", - "smithy.api#required": {} - } - }, - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

Database.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Parameters for Amazon Aurora.

" - } - }, - "com.amazonaws.quicksight#AuroraPostgreSqlParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

The Amazon Aurora PostgreSQL-Compatible host to connect to.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

The port that Amazon Aurora PostgreSQL is listening on.

", - "smithy.api#required": {} - } - }, - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

The Amazon Aurora PostgreSQL database to connect to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Parameters for Amazon Aurora PostgreSQL-Compatible Edition.

" - } - }, - "com.amazonaws.quicksight#AuthenticationMethodOption": { - "type": "enum", - "members": { - "IAM_AND_QUICKSIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM_AND_QUICKSIGHT" - } - }, - "IAM_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM_ONLY" - } - }, - "ACTIVE_DIRECTORY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE_DIRECTORY" - } - }, - "IAM_IDENTITY_CENTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM_IDENTITY_CENTER" - } - } - } - }, - "com.amazonaws.quicksight#AuthorSpecifiedAggregation": { - "type": "enum", - "members": { - "COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNT" - } - }, - "DISTINCT_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISTINCT_COUNT" - } - }, - "MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MIN" - } - }, - "MAX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX" - } - }, - "MEDIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIAN" - } - }, - "SUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUM" - } - }, - "AVERAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVERAGE" - } - }, - "STDEV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEV" - } - }, - "STDEVP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEVP" - } - }, - "VAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VAR" - } - }, - "VARP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VARP" - } - }, - "PERCENTILE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENTILE" - } - } - } - }, - "com.amazonaws.quicksight#AuthorSpecifiedAggregations": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AuthorSpecifiedAggregation" - } - }, - "com.amazonaws.quicksight#AuthorizedTargetsByService": { - "type": "structure", - "members": { - "Service": { - "target": "com.amazonaws.quicksight#ServiceType", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Web Services service.

" - } - }, - "AuthorizedTargets": { - "target": "com.amazonaws.quicksight#AuthorizedTargetsList", - "traits": { - "smithy.api#documentation": "

Aist of authorized targets that are represented by IAM Identity Center application ARNs.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The authorized targets that are associated with a service.

" - } - }, - "com.amazonaws.quicksight#AuthorizedTargetsByServices": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AuthorizedTargetsByService" - } - }, - "com.amazonaws.quicksight#AuthorizedTargetsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#String" - } - }, - "com.amazonaws.quicksight#AwsAccountId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 12, - "max": 12 - }, - "smithy.api#pattern": "^[0-9]{12}$" - } - }, - "com.amazonaws.quicksight#AwsAndAccountId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(aws|[0-9]{12})$" - } - }, - "com.amazonaws.quicksight#AwsIotAnalyticsParameters": { - "type": "structure", - "members": { - "DataSetName": { - "target": "com.amazonaws.quicksight#DataSetName", - "traits": { - "smithy.api#documentation": "

Dataset name.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for IoT Analytics.

" - } - }, - "com.amazonaws.quicksight#AxisBinding": { - "type": "enum", - "members": { - "PRIMARY_YAXIS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRIMARY_YAXIS" - } - }, - "SECONDARY_YAXIS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SECONDARY_YAXIS" - } - } - } - }, - "com.amazonaws.quicksight#AxisDataOptions": { - "type": "structure", - "members": { - "NumericAxisOptions": { - "target": "com.amazonaws.quicksight#NumericAxisOptions", - "traits": { - "smithy.api#documentation": "

The options for an axis with a numeric field.

" - } - }, - "DateAxisOptions": { - "target": "com.amazonaws.quicksight#DateAxisOptions", - "traits": { - "smithy.api#documentation": "

The options for an axis with a date field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The data options for an axis.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#AxisDisplayDataDrivenRange": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

The options that are saved for future extension.

" - } - }, - "com.amazonaws.quicksight#AxisDisplayMinMaxRange": { - "type": "structure", - "members": { - "Minimum": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The minimum setup for an axis display range.

" - } - }, - "Maximum": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum setup for an axis display range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum and maximum setup for an axis display range.

" - } - }, - "com.amazonaws.quicksight#AxisDisplayOptions": { - "type": "structure", - "members": { - "TickLabelOptions": { - "target": "com.amazonaws.quicksight#AxisTickLabelOptions", - "traits": { - "smithy.api#documentation": "

The tick label options of an axis.

" - } - }, - "AxisLineVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines whether or not the axis line is visible.

" - } - }, - "GridLineVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines whether or not the grid line is visible.

" - } - }, - "DataOptions": { - "target": "com.amazonaws.quicksight#AxisDataOptions", - "traits": { - "smithy.api#documentation": "

The data options for an axis.

" - } - }, - "ScrollbarOptions": { - "target": "com.amazonaws.quicksight#ScrollBarOptions", - "traits": { - "smithy.api#documentation": "

The scroll bar options for an axis.

" - } - }, - "AxisOffset": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The offset value that determines the starting placement of the axis within a visual's bounds.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options for the axis label.

" - } - }, - "com.amazonaws.quicksight#AxisDisplayRange": { - "type": "structure", - "members": { - "MinMax": { - "target": "com.amazonaws.quicksight#AxisDisplayMinMaxRange", - "traits": { - "smithy.api#documentation": "

The minimum and maximum setup of an axis display range.

" - } - }, - "DataDriven": { - "target": "com.amazonaws.quicksight#AxisDisplayDataDrivenRange", - "traits": { - "smithy.api#documentation": "

The data-driven setup of an axis display range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The range setup of a numeric axis display range.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#AxisLabelOptions": { - "type": "structure", - "members": { - "FontConfiguration": { - "target": "com.amazonaws.quicksight#FontConfiguration", - "traits": { - "smithy.api#documentation": "

The font configuration of the axis label.

" - } - }, - "CustomLabel": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The text for the axis label.

" - } - }, - "ApplyTo": { - "target": "com.amazonaws.quicksight#AxisLabelReferenceOptions", - "traits": { - "smithy.api#documentation": "

The options that indicate which field the label belongs to.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The label options for a chart axis. You must specify the field that the label is targeted to.

" - } - }, - "com.amazonaws.quicksight#AxisLabelOptionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AxisLabelOptions" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#AxisLabelReferenceOptions": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field that the axis label is targeted to.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the axis label is targeted to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The reference that specifies where the axis label is applied to.

" - } - }, - "com.amazonaws.quicksight#AxisLinearScale": { - "type": "structure", - "members": { - "StepCount": { - "target": "com.amazonaws.quicksight#Integer", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The step count setup of a linear axis.

" - } - }, - "StepSize": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The step size setup of a linear axis.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The liner axis scale setup.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#AxisLogarithmicScale": { - "type": "structure", - "members": { - "Base": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The base setup of a logarithmic axis scale.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The logarithmic axis scale setup.

" - } - }, - "com.amazonaws.quicksight#AxisScale": { - "type": "structure", - "members": { - "Linear": { - "target": "com.amazonaws.quicksight#AxisLinearScale", - "traits": { - "smithy.api#documentation": "

The linear axis scale setup.

" - } - }, - "Logarithmic": { - "target": "com.amazonaws.quicksight#AxisLogarithmicScale", - "traits": { - "smithy.api#documentation": "

The logarithmic axis scale setup.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The scale setup\n options for a numeric axis display.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#AxisTickLabelOptions": { - "type": "structure", - "members": { - "LabelOptions": { - "target": "com.amazonaws.quicksight#LabelOptions", - "traits": { - "smithy.api#documentation": "

Determines whether or not the axis ticks are visible.

" - } - }, - "RotationAngle": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The rotation angle of the axis tick labels.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The tick label options of an axis.

" - } - }, - "com.amazonaws.quicksight#BarChartAggregatedFieldWells": { - "type": "structure", - "members": { - "Category": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The category (y-axis) field well of a bar chart.

" - } - }, - "Values": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The value field wells of a bar chart. Values are aggregated by\n category.

" - } - }, - "Colors": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The color (group/color) field well of a bar chart.

" - } - }, - "SmallMultiples": { - "target": "com.amazonaws.quicksight#SmallMultiplesDimensionFieldList", - "traits": { - "smithy.api#documentation": "

The small multiples field well of a bar chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a bar chart.

" - } - }, - "com.amazonaws.quicksight#BarChartConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#BarChartFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#BarChartSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a BarChartVisual.

" - } - }, - "Orientation": { - "target": "com.amazonaws.quicksight#BarChartOrientation", - "traits": { - "smithy.api#documentation": "

The orientation of the bars in a bar chart visual. There are two valid values in this structure:

\n " - } - }, - "BarsArrangement": { - "target": "com.amazonaws.quicksight#BarsArrangement", - "traits": { - "smithy.api#documentation": "

Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" - } - }, - "SmallMultiplesOptions": { - "target": "com.amazonaws.quicksight#SmallMultiplesOptions", - "traits": { - "smithy.api#documentation": "

The small multiples setup for the visual.

" - } - }, - "CategoryAxis": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The label display options (grid line, range, scale, axis step) for bar chart category.

" - } - }, - "CategoryLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility and sort icon visibility) for a bar chart.

" - } - }, - "ValueAxis": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The label display options (grid line, range, scale, axis step) for a bar chart value.

" - } - }, - "ValueLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility and sort icon visibility) for a bar chart value.

" - } - }, - "ColorLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "

The legend display setup of the visual.

" - } - }, - "DataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The tooltip display setup of the visual.

" - } - }, - "ReferenceLines": { - "target": "com.amazonaws.quicksight#ReferenceLineList", - "traits": { - "smithy.api#documentation": "

The reference line setup of the visual.

" - } - }, - "ContributionAnalysisDefaults": { - "target": "com.amazonaws.quicksight#ContributionAnalysisDefaultList", - "traits": { - "smithy.api#documentation": "

The contribution analysis (anomaly configuration) setup of the visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a BarChartVisual.

" - } - }, - "com.amazonaws.quicksight#BarChartFieldWells": { - "type": "structure", - "members": { - "BarChartAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#BarChartAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a bar chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field wells of a BarChartVisual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#BarChartOrientation": { - "type": "enum", - "members": { - "HORIZONTAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HORIZONTAL" - } - }, - "VERTICAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VERTICAL" - } - } - } - }, - "com.amazonaws.quicksight#BarChartSortConfiguration": { - "type": "structure", - "members": { - "CategorySort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of category fields.

" - } - }, - "CategoryItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of categories displayed in a bar chart.

" - } - }, - "ColorSort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of color fields in a bar chart.

" - } - }, - "ColorItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of values displayed in a bar chart.

" - } - }, - "SmallMultiplesSort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the small multiples field.

" - } - }, - "SmallMultiplesLimitConfiguration": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of small multiples panels that are displayed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

sort-configuration-description

" - } - }, - "com.amazonaws.quicksight#BarChartVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#BarChartConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the visual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A bar chart.

\n

The BarChartVisual structure describes a visual that is a member of the bar chart family. The following charts can be described using this structure:

\n \n

For more information, see Using bar charts in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#BarsArrangement": { - "type": "enum", - "members": { - "CLUSTERED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLUSTERED" - } - }, - "STACKED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STACKED" - } - }, - "STACKED_PERCENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STACKED_PERCENT" - } - } - } - }, - "com.amazonaws.quicksight#BaseMapStyleType": { - "type": "enum", - "members": { - "LIGHT_GRAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LIGHT_GRAY" - } - }, - "DARK_GRAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DARK_GRAY" - } - }, - "STREET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STREET" - } - }, - "IMAGERY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMAGERY" - } - } - } - }, - "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswer": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswerRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates new reviewed answers for a Q Topic.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/batch-create-reviewed-answers", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswerRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that you want to create a reviewed answer in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Answers": { - "target": "com.amazonaws.quicksight#CreateTopicReviewedAnswers", - "traits": { - "smithy.api#documentation": "

The definition of the Answers to be created.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswerResponse": { - "type": "structure", - "members": { - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region\n for each Amazon Web Services account.

" - } - }, - "TopicArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "SucceededAnswers": { - "target": "com.amazonaws.quicksight#SucceededTopicReviewedAnswers", - "traits": { - "smithy.api#documentation": "

The definition of Answers that are successfully created.

" - } - }, - "InvalidAnswers": { - "target": "com.amazonaws.quicksight#InvalidTopicReviewedAnswers", - "traits": { - "smithy.api#documentation": "

The definition of Answers that are invalid and not created.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswer": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswerRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes reviewed answers for Q Topic.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/batch-delete-reviewed-answers", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswerRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that you want to delete a reviewed answers in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID for the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AnswerIds": { - "target": "com.amazonaws.quicksight#AnswerIds", - "traits": { - "smithy.api#documentation": "

The Answer IDs of the Answers to be deleted.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswerResponse": { - "type": "structure", - "members": { - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "TopicArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "SucceededAnswers": { - "target": "com.amazonaws.quicksight#SucceededTopicReviewedAnswers", - "traits": { - "smithy.api#documentation": "

The definition of Answers that are successfully deleted.

" - } - }, - "InvalidAnswers": { - "target": "com.amazonaws.quicksight#InvalidTopicReviewedAnswers", - "traits": { - "smithy.api#documentation": "

The definition of Answers that are invalid and not deleted.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#BigQueryParameters": { - "type": "structure", - "members": { - "ProjectId": { - "target": "com.amazonaws.quicksight#ProjectId", - "traits": { - "smithy.api#documentation": "

The Google Cloud Platform project ID where your datasource was created.

", - "smithy.api#required": {} - } - }, - "DataSetRegion": { - "target": "com.amazonaws.quicksight#DataSetRegion", - "traits": { - "smithy.api#documentation": "

The storage location where you create a Google BigQuery data source.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters that are required to connect to a Google BigQuery data source.

" - } - }, - "com.amazonaws.quicksight#BinCountLimit": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 1000 - } - } - }, - "com.amazonaws.quicksight#BinCountOptions": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.quicksight#BinCountValue", - "traits": { - "smithy.api#documentation": "

The options that determine the bin count value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the bin count of a histogram.

" - } - }, - "com.amazonaws.quicksight#BinCountValue": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.quicksight#BinWidthOptions": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.quicksight#BinWidthValue", - "traits": { - "smithy.api#documentation": "

The options that determine the bin width value.

" - } - }, - "BinCountLimit": { - "target": "com.amazonaws.quicksight#BinCountLimit", - "traits": { - "smithy.api#documentation": "

The options that determine the bin count limit.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the bin width of a histogram.

" - } - }, - "com.amazonaws.quicksight#BinWidthValue": { - "type": "double", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.quicksight#BodySectionConfiguration": { - "type": "structure", - "members": { - "SectionId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a body section.

", - "smithy.api#required": {} - } - }, - "Content": { - "target": "com.amazonaws.quicksight#BodySectionContent", - "traits": { - "smithy.api#documentation": "

The configuration of content in a body section.

", - "smithy.api#required": {} - } - }, - "Style": { - "target": "com.amazonaws.quicksight#SectionStyle", - "traits": { - "smithy.api#documentation": "

The style options of a body section.

" - } - }, - "PageBreakConfiguration": { - "target": "com.amazonaws.quicksight#SectionPageBreakConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of a page break for a section.

" - } - }, - "RepeatConfiguration": { - "target": "com.amazonaws.quicksight#BodySectionRepeatConfiguration", - "traits": { - "smithy.api#documentation": "

Describes the configurations that are required to declare a section as repeating.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a body section.

" - } - }, - "com.amazonaws.quicksight#BodySectionConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#BodySectionConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 28 - } - } - }, - "com.amazonaws.quicksight#BodySectionContent": { - "type": "structure", - "members": { - "Layout": { - "target": "com.amazonaws.quicksight#SectionLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

The layout configuration of a body section.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of content in a body section.

" - } - }, - "com.amazonaws.quicksight#BodySectionDynamicCategoryDimensionConfiguration": { - "type": "structure", - "members": { - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#required": {} - } - }, - "Limit": { - "target": "com.amazonaws.quicksight#BodySectionDynamicDimensionLimit", - "traits": { - "smithy.api#documentation": "

Number of values to use from the column for repetition.

" - } - }, - "SortByMetrics": { - "target": "com.amazonaws.quicksight#BodySectionDynamicDimensionSortConfigurationList", - "traits": { - "smithy.api#documentation": "

Sort criteria on the column values that you use for repetition.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Category dataset column and constraints for the dynamic values used to repeat the contents of a section.

" - } - }, - "com.amazonaws.quicksight#BodySectionDynamicDimensionLimit": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.quicksight#BodySectionDynamicDimensionSortConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnSort" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#BodySectionDynamicNumericDimensionConfiguration": { - "type": "structure", - "members": { - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#required": {} - } - }, - "Limit": { - "target": "com.amazonaws.quicksight#BodySectionDynamicDimensionLimit", - "traits": { - "smithy.api#documentation": "

Number of values to use from the column for repetition.

" - } - }, - "SortByMetrics": { - "target": "com.amazonaws.quicksight#BodySectionDynamicDimensionSortConfigurationList", - "traits": { - "smithy.api#documentation": "

Sort criteria on the column values that you use for repetition.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Numeric dataset column and constraints for the dynamic values used to repeat the contents of a section.

" - } - }, - "com.amazonaws.quicksight#BodySectionRepeatConfiguration": { - "type": "structure", - "members": { - "DimensionConfigurations": { - "target": "com.amazonaws.quicksight#BodySectionRepeatDimensionConfigurationList", - "traits": { - "smithy.api#documentation": "

List of BodySectionRepeatDimensionConfiguration values that describe the dataset column and constraints for the column used to repeat the contents of a section.

" - } - }, - "PageBreakConfiguration": { - "target": "com.amazonaws.quicksight#BodySectionRepeatPageBreakConfiguration", - "traits": { - "smithy.api#documentation": "

Page break configuration to apply for each repeating instance.

" - } - }, - "NonRepeatingVisuals": { - "target": "com.amazonaws.quicksight#NonRepeatingVisualsList", - "traits": { - "smithy.api#documentation": "

List of visuals to exclude from repetition in repeating sections. The visuals will render identically, and ignore the repeating configurations in all repeating instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the configurations that are required to declare a section as repeating.

" - } - }, - "com.amazonaws.quicksight#BodySectionRepeatDimensionConfiguration": { - "type": "structure", - "members": { - "DynamicCategoryDimensionConfiguration": { - "target": "com.amazonaws.quicksight#BodySectionDynamicCategoryDimensionConfiguration", - "traits": { - "smithy.api#documentation": "

Describes the Category dataset column and constraints around the dynamic values that will be used in repeating the section contents.

" - } - }, - "DynamicNumericDimensionConfiguration": { - "target": "com.amazonaws.quicksight#BodySectionDynamicNumericDimensionConfiguration", - "traits": { - "smithy.api#documentation": "

Describes the Numeric dataset column and constraints around the dynamic values used to repeat the contents of a section.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the dataset column and constraints for the dynamic values used to repeat the contents of a section. The dataset column is either Category or Numeric column configuration

" - } - }, - "com.amazonaws.quicksight#BodySectionRepeatDimensionConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#BodySectionRepeatDimensionConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 3 - } - } - }, - "com.amazonaws.quicksight#BodySectionRepeatPageBreakConfiguration": { - "type": "structure", - "members": { - "After": { - "target": "com.amazonaws.quicksight#SectionAfterPageBreak" - } - }, - "traits": { - "smithy.api#documentation": "

The page break configuration to apply for each repeating instance.

" - } - }, - "com.amazonaws.quicksight#BookmarksConfigurations": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that determines whether a user\n can bookmark an embedded dashboard.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The bookmarks configuration of an embedded dashboard.

" - } - }, - "com.amazonaws.quicksight#Boolean": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.quicksight#BooleanObject": { - "type": "boolean" - }, - "com.amazonaws.quicksight#BorderStyle": { - "type": "structure", - "members": { - "Show": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The option to enable display of borders for visuals.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options for tile borders for visuals.

" - } - }, - "com.amazonaws.quicksight#BoxPlotAggregatedFieldWells": { - "type": "structure", - "members": { - "GroupBy": { - "target": "com.amazonaws.quicksight#BoxPlotDimensionFieldList", - "traits": { - "smithy.api#documentation": "

The group by field well of a box plot chart. Values are grouped based on group by fields.

" - } - }, - "Values": { - "target": "com.amazonaws.quicksight#BoxPlotMeasureFieldList", - "traits": { - "smithy.api#documentation": "

The value field well of a box plot chart. Values are aggregated based on group by fields.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The aggregated field well for a box plot.

" - } - }, - "com.amazonaws.quicksight#BoxPlotChartConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#BoxPlotFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#BoxPlotSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a BoxPlotVisual.

" - } - }, - "BoxPlotOptions": { - "target": "com.amazonaws.quicksight#BoxPlotOptions", - "traits": { - "smithy.api#documentation": "

The box plot chart options for a box plot visual

" - } - }, - "CategoryAxis": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The label display options (grid line, range, scale, axis step) of a box plot category.

" - } - }, - "CategoryLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility and sort Icon visibility) of a box plot category.

" - } - }, - "PrimaryYAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The label display options (grid line, range, scale, axis step) of a box plot category.

" - } - }, - "PrimaryYAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility and sort icon visibility) of a box plot value.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions" - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The tooltip display setup of the visual.

" - } - }, - "ReferenceLines": { - "target": "com.amazonaws.quicksight#ReferenceLineList", - "traits": { - "smithy.api#documentation": "

The reference line setup of the visual.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a BoxPlotVisual.

" - } - }, - "com.amazonaws.quicksight#BoxPlotDimensionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DimensionField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#BoxPlotFieldWells": { - "type": "structure", - "members": { - "BoxPlotAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#BoxPlotAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a box plot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field wells of a BoxPlotVisual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#BoxPlotFillStyle": { - "type": "enum", - "members": { - "SOLID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOLID" - } - }, - "TRANSPARENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRANSPARENT" - } - } - } - }, - "com.amazonaws.quicksight#BoxPlotMeasureFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MeasureField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.quicksight#BoxPlotOptions": { - "type": "structure", - "members": { - "StyleOptions": { - "target": "com.amazonaws.quicksight#BoxPlotStyleOptions", - "traits": { - "smithy.api#documentation": "

The style options of the box plot.

" - } - }, - "OutlierVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines the visibility of the outlier in a box plot.

" - } - }, - "AllDataPointsVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines the visibility of all data points of the box plot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options of a box plot visual.

" - } - }, - "com.amazonaws.quicksight#BoxPlotSortConfiguration": { - "type": "structure", - "members": { - "CategorySort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of a group by fields.

" - } - }, - "PaginationConfiguration": { - "target": "com.amazonaws.quicksight#PaginationConfiguration", - "traits": { - "smithy.api#documentation": "

The pagination configuration of a table visual or box plot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a BoxPlotVisual.

" - } - }, - "com.amazonaws.quicksight#BoxPlotStyleOptions": { - "type": "structure", - "members": { - "FillStyle": { - "target": "com.amazonaws.quicksight#BoxPlotFillStyle", - "traits": { - "smithy.api#documentation": "

The fill styles (solid, transparent) of the box plot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The style options of the box plot.

" - } - }, - "com.amazonaws.quicksight#BoxPlotVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#BoxPlotChartConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the visual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A box plot.

\n

For more information, see Using box plots in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#CIDR": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(3[0-2]|[1-2][0-9]|[1-9]))$" - } - }, - "com.amazonaws.quicksight#CalculatedColumn": { - "type": "structure", - "members": { - "ColumnName": { - "target": "com.amazonaws.quicksight#ColumnName", - "traits": { - "smithy.api#documentation": "

Column name.

", - "smithy.api#required": {} - } - }, - "ColumnId": { - "target": "com.amazonaws.quicksight#ColumnId", - "traits": { - "smithy.api#documentation": "

A unique ID to identify a calculated column. During a dataset update, if the column ID\n of a calculated column matches that of an existing calculated column, Amazon QuickSight\n preserves the existing calculated column.

", - "smithy.api#required": {} - } - }, - "Expression": { - "target": "com.amazonaws.quicksight#Expression", - "traits": { - "smithy.api#documentation": "

An expression that defines the calculated column.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A calculated column for a dataset.

" - } - }, - "com.amazonaws.quicksight#CalculatedColumnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#CalculatedColumn" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.quicksight#CalculatedField": { - "type": "structure", - "members": { - "DataSetIdentifier": { - "target": "com.amazonaws.quicksight#DataSetIdentifier", - "traits": { - "smithy.api#documentation": "

The data set that is used in this calculated field.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ColumnName", - "traits": { - "smithy.api#documentation": "

The name of the calculated field.

", - "smithy.api#required": {} - } - }, - "Expression": { - "target": "com.amazonaws.quicksight#CalculatedFieldExpression", - "traits": { - "smithy.api#documentation": "

The expression of the calculated field.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The calculated field of an analysis.

" - } - }, - "com.amazonaws.quicksight#CalculatedFieldExpression": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32000 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#CalculatedFieldReferenceList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Identifier" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 250 - } - } - }, - "com.amazonaws.quicksight#CalculatedFields": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#CalculatedField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.quicksight#CalculatedMeasureField": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The custom field ID.

", - "smithy.api#required": {} - } - }, - "Expression": { - "target": "com.amazonaws.quicksight#Expression", - "traits": { - "smithy.api#documentation": "

The expression in the table calculation.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The table calculation measure field for pivot tables.

" - } - }, - "com.amazonaws.quicksight#CancelIngestion": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CancelIngestionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CancelIngestionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Cancels an ongoing ingestion of data into SPICE.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CancelIngestionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the dataset used in the ingestion.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "IngestionId": { - "target": "com.amazonaws.quicksight#IngestionId", - "traits": { - "smithy.api#documentation": "

An ID for the ingestion.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CancelIngestionResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the data ingestion.

" - } - }, - "IngestionId": { - "target": "com.amazonaws.quicksight#IngestionId", - "traits": { - "smithy.api#documentation": "

An ID for the ingestion.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CascadingControlConfiguration": { - "type": "structure", - "members": { - "SourceControls": { - "target": "com.amazonaws.quicksight#CascadingControlSourceList", - "traits": { - "smithy.api#documentation": "

A list of source controls that determine the values that are used in the current control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

" - } - }, - "com.amazonaws.quicksight#CascadingControlSource": { - "type": "structure", - "members": { - "SourceSheetControlId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The source sheet control ID of a CascadingControlSource.

" - } - }, - "ColumnToMatch": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column identifier that determines which column to look up for the source sheet control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The source controls that are used in a CascadingControlConfiguration.

" - } - }, - "com.amazonaws.quicksight#CascadingControlSourceList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#CascadingControlSource" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#CastColumnTypeOperation": { - "type": "structure", - "members": { - "ColumnName": { - "target": "com.amazonaws.quicksight#ColumnName", - "traits": { - "smithy.api#documentation": "

Column name.

", - "smithy.api#required": {} - } - }, - "NewColumnType": { - "target": "com.amazonaws.quicksight#ColumnDataType", - "traits": { - "smithy.api#documentation": "

New column data type.

", - "smithy.api#required": {} - } - }, - "SubType": { - "target": "com.amazonaws.quicksight#ColumnDataSubType", - "traits": { - "smithy.api#documentation": "

The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.

" - } - }, - "Format": { - "target": "com.amazonaws.quicksight#TypeCastFormat", - "traits": { - "smithy.api#documentation": "

When casting a column from string to datetime type, you can supply a string in a\n format supported by Amazon QuickSight to denote the source data format.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A transform operation that casts a column to a different type.

" - } - }, - "com.amazonaws.quicksight#Catalog": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - } - } - }, - "com.amazonaws.quicksight#CategoricalAggregationFunction": { - "type": "enum", - "members": { - "COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNT" - } - }, - "DISTINCT_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISTINCT_COUNT" - } - } - } - }, - "com.amazonaws.quicksight#CategoricalDimensionField": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The custom field ID.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that is used in the CategoricalDimensionField.

", - "smithy.api#required": {} - } - }, - "HierarchyId": { - "target": "com.amazonaws.quicksight#HierarchyId", - "traits": { - "smithy.api#documentation": "

The custom hierarchy ID.

" - } - }, - "FormatConfiguration": { - "target": "com.amazonaws.quicksight#StringFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The format configuration of the field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The dimension type field with categorical type columns..

" - } - }, - "com.amazonaws.quicksight#CategoricalMeasureField": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The custom field ID.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that is used in the CategoricalMeasureField.

", - "smithy.api#required": {} - } - }, - "AggregationFunction": { - "target": "com.amazonaws.quicksight#CategoricalAggregationFunction", - "traits": { - "smithy.api#documentation": "

The aggregation function of the measure field.

" - } - }, - "FormatConfiguration": { - "target": "com.amazonaws.quicksight#StringFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The format configuration of the field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The measure type field with categorical type columns.

" - } - }, - "com.amazonaws.quicksight#CategoryDrillDownFilter": { - "type": "structure", - "members": { - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "CategoryValues": { - "target": "com.amazonaws.quicksight#CategoryValueList", - "traits": { - "smithy.api#documentation": "

A list of the string inputs that are the values of the category drill down filter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The category drill down filter.

" - } - }, - "com.amazonaws.quicksight#CategoryFilter": { - "type": "structure", - "members": { - "FilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "Configuration": { - "target": "com.amazonaws.quicksight#CategoryFilterConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration for a CategoryFilter.

", - "smithy.api#required": {} - } - }, - "DefaultFilterControlConfiguration": { - "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", - "traits": { - "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A CategoryFilter filters text values.

\n

For more information, see Adding text filters in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#CategoryFilterConfiguration": { - "type": "structure", - "members": { - "FilterListConfiguration": { - "target": "com.amazonaws.quicksight#FilterListConfiguration", - "traits": { - "smithy.api#documentation": "

A list of filter configurations. In the Amazon QuickSight console, this filter type is called a filter list.

" - } - }, - "CustomFilterListConfiguration": { - "target": "com.amazonaws.quicksight#CustomFilterListConfiguration", - "traits": { - "smithy.api#documentation": "

A list of custom filter values. In the Amazon QuickSight console, this filter type is called a custom filter list.

" - } - }, - "CustomFilterConfiguration": { - "target": "com.amazonaws.quicksight#CustomFilterConfiguration", - "traits": { - "smithy.api#documentation": "

A custom filter that filters based on a single value. This filter can be partially matched.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for a CategoryFilter.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#CategoryFilterFunction": { - "type": "enum", - "members": { - "EXACT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXACT" - } - }, - "CONTAINS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTAINS" - } - } - } - }, - "com.amazonaws.quicksight#CategoryFilterMatchOperator": { - "type": "enum", - "members": { - "EQUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EQUALS" - } - }, - "DOES_NOT_EQUAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOES_NOT_EQUAL" - } - }, - "CONTAINS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTAINS" - } - }, - "DOES_NOT_CONTAIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOES_NOT_CONTAIN" - } - }, - "STARTS_WITH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTS_WITH" - } - }, - "ENDS_WITH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENDS_WITH" - } - } - } - }, - "com.amazonaws.quicksight#CategoryFilterSelectAllOptions": { - "type": "enum", - "members": { - "FILTER_ALL_VALUES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FILTER_ALL_VALUES" - } - } - } - }, - "com.amazonaws.quicksight#CategoryFilterType": { - "type": "enum", - "members": { - "CUSTOM_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM_FILTER" - } - }, - "CUSTOM_FILTER_LIST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM_FILTER_LIST" - } - }, - "FILTER_LIST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FILTER_LIST" - } - } - } - }, - "com.amazonaws.quicksight#CategoryInnerFilter": { - "type": "structure", - "members": { - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#required": {} - } - }, - "Configuration": { - "target": "com.amazonaws.quicksight#CategoryFilterConfiguration", - "traits": { - "smithy.api#required": {} - } - }, - "DefaultFilterControlConfiguration": { - "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration" - } - }, - "traits": { - "smithy.api#documentation": "

A CategoryInnerFilter filters text values for the NestedFilter.

" - } - }, - "com.amazonaws.quicksight#CategoryValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - } - } - }, - "com.amazonaws.quicksight#CategoryValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#CategoryValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100000 - } - } - }, - "com.amazonaws.quicksight#CellValueSynonym": { - "type": "structure", - "members": { - "CellValue": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The cell value.

" - } - }, - "Synonyms": { - "target": "com.amazonaws.quicksight#StringList", - "traits": { - "smithy.api#documentation": "

Other names or aliases for the cell value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents the cell value synonym.

" - } - }, - "com.amazonaws.quicksight#CellValueSynonyms": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#CellValueSynonym" - } - }, - "com.amazonaws.quicksight#ChartAxisLabelOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of an axis label on a chart. Choose one of the following options:

\n " - } - }, - "SortIconVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility configuration of the sort icon on a chart's axis label.

" - } - }, - "AxisLabelOptions": { - "target": "com.amazonaws.quicksight#AxisLabelOptionsList", - "traits": { - "smithy.api#documentation": "

The label options for a chart axis.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The label options for an axis on a chart.

" - } - }, - "com.amazonaws.quicksight#ClusterId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#ClusterMarker": { - "type": "structure", - "members": { - "SimpleClusterMarker": { - "target": "com.amazonaws.quicksight#SimpleClusterMarker", - "traits": { - "smithy.api#documentation": "

The simple cluster marker of the cluster marker.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The cluster marker that is a part of the cluster marker\n configuration.

" - } - }, - "com.amazonaws.quicksight#ClusterMarkerConfiguration": { - "type": "structure", - "members": { - "ClusterMarker": { - "target": "com.amazonaws.quicksight#ClusterMarker", - "traits": { - "smithy.api#documentation": "

The cluster marker that is a part of the cluster marker configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The cluster marker configuration of the geospatial map selected point style.

" - } - }, - "com.amazonaws.quicksight#CollectiveConstant": { - "type": "structure", - "members": { - "ValueList": { - "target": "com.amazonaws.quicksight#StringList", - "traits": { - "smithy.api#documentation": "

A list of values for the collective constant.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a collective constant.

" - } - }, - "com.amazonaws.quicksight#CollectiveConstantEntry": { - "type": "structure", - "members": { - "ConstantType": { - "target": "com.amazonaws.quicksight#ConstantType", - "traits": { - "smithy.api#documentation": "

The ConstantType of a CollectiveConstantEntry.

" - } - }, - "Value": { - "target": "com.amazonaws.quicksight#ConstantValueString", - "traits": { - "smithy.api#documentation": "

The value of a CollectiveConstantEntry.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a CollectiveConstantEntry.

" - } - }, - "com.amazonaws.quicksight#CollectiveConstantEntryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#CollectiveConstantEntry" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2000 - } - } - }, - "com.amazonaws.quicksight#ColorFillType": { - "type": "enum", - "members": { - "DISCRETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISCRETE" - } - }, - "GRADIENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GRADIENT" - } - } - } - }, - "com.amazonaws.quicksight#ColorList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#HexColor" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#ColorScale": { - "type": "structure", - "members": { - "Colors": { - "target": "com.amazonaws.quicksight#ColorScaleColorList", - "traits": { - "smithy.api#documentation": "

Determines the list of colors that are applied to the visual.

", - "smithy.api#required": {} - } - }, - "ColorFillType": { - "target": "com.amazonaws.quicksight#ColorFillType", - "traits": { - "smithy.api#documentation": "

Determines the color fill type.

", - "smithy.api#required": {} - } - }, - "NullValueColor": { - "target": "com.amazonaws.quicksight#DataColor", - "traits": { - "smithy.api#documentation": "

Determines the color that is applied to null values.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines the color scale that is applied to the visual.

" - } - }, - "com.amazonaws.quicksight#ColorScaleColorList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataColor" - }, - "traits": { - "smithy.api#length": { - "min": 2, - "max": 3 - } - } - }, - "com.amazonaws.quicksight#ColorsConfiguration": { - "type": "structure", - "members": { - "CustomColors": { - "target": "com.amazonaws.quicksight#CustomColorsList", - "traits": { - "smithy.api#documentation": "

A list of up to 50 custom colors.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The color configurations for a column.

" - } - }, - "com.amazonaws.quicksight#ColumnConfiguration": { - "type": "structure", - "members": { - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column.

", - "smithy.api#required": {} - } - }, - "FormatConfiguration": { - "target": "com.amazonaws.quicksight#FormatConfiguration", - "traits": { - "smithy.api#documentation": "

The format configuration of a column.

" - } - }, - "Role": { - "target": "com.amazonaws.quicksight#ColumnRole", - "traits": { - "smithy.api#documentation": "

The role of the column.

" - } - }, - "ColorsConfiguration": { - "target": "com.amazonaws.quicksight#ColorsConfiguration", - "traits": { - "smithy.api#documentation": "

The color configurations of the column.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The general configuration of a column.

" - } - }, - "com.amazonaws.quicksight#ColumnConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2000 - } - } - }, - "com.amazonaws.quicksight#ColumnDataRole": { - "type": "enum", - "members": { - "DIMENSION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIMENSION" - } - }, - "MEASURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEASURE" - } - } - } - }, - "com.amazonaws.quicksight#ColumnDataSubType": { - "type": "enum", - "members": { - "FLOAT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FLOAT" - } - }, - "FIXED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIXED" - } - } - } - }, - "com.amazonaws.quicksight#ColumnDataType": { - "type": "enum", - "members": { - "STRING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STRING" - } - }, - "INTEGER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTEGER" - } - }, - "DECIMAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DECIMAL" - } - }, - "DATETIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATETIME" - } - } - } - }, - "com.amazonaws.quicksight#ColumnDescription": { - "type": "structure", - "members": { - "Text": { - "target": "com.amazonaws.quicksight#ColumnDescriptiveText", - "traits": { - "smithy.api#documentation": "

The text of a description for a column.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata that contains a description for a column.

" - } - }, - "com.amazonaws.quicksight#ColumnDescriptiveText": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.quicksight#ColumnGroup": { - "type": "structure", - "members": { - "GeoSpatialColumnGroup": { - "target": "com.amazonaws.quicksight#GeoSpatialColumnGroup", - "traits": { - "smithy.api#documentation": "

Geospatial column group that denotes a hierarchy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Groupings of columns that work together in certain Amazon QuickSight features. This is\n a variant type structure. For this structure to be valid, only one of the attributes can\n be non-null.

" - } - }, - "com.amazonaws.quicksight#ColumnGroupColumnSchema": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of the column group's column schema.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure describing the name, data type, and geographic role of the columns.

" - } - }, - "com.amazonaws.quicksight#ColumnGroupColumnSchemaList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnGroupColumnSchema" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.quicksight#ColumnGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnGroup" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 8 - } - } - }, - "com.amazonaws.quicksight#ColumnGroupName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#ColumnGroupSchema": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of the column group schema.

" - } - }, - "ColumnGroupColumnSchemaList": { - "target": "com.amazonaws.quicksight#ColumnGroupColumnSchemaList", - "traits": { - "smithy.api#documentation": "

A structure containing the list of schemas for column group columns.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The column group schema.

" - } - }, - "com.amazonaws.quicksight#ColumnGroupSchemaList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnGroupSchema" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.quicksight#ColumnHierarchy": { - "type": "structure", - "members": { - "ExplicitHierarchy": { - "target": "com.amazonaws.quicksight#ExplicitHierarchy", - "traits": { - "smithy.api#documentation": "

The option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.

" - } - }, - "DateTimeHierarchy": { - "target": "com.amazonaws.quicksight#DateTimeHierarchy", - "traits": { - "smithy.api#documentation": "

The option that determines the hierarchy of any DateTime fields.

" - } - }, - "PredefinedHierarchy": { - "target": "com.amazonaws.quicksight#PredefinedHierarchy", - "traits": { - "smithy.api#documentation": "

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The option that determines the hierarchy of the fields for a visual element.

" - } - }, - "com.amazonaws.quicksight#ColumnHierarchyList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnHierarchy" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2 - } - } - }, - "com.amazonaws.quicksight#ColumnId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#ColumnIdentifier": { - "type": "structure", - "members": { - "DataSetIdentifier": { - "target": "com.amazonaws.quicksight#DataSetIdentifier", - "traits": { - "smithy.api#documentation": "

The data set that the column belongs to.

", - "smithy.api#required": {} - } - }, - "ColumnName": { - "target": "com.amazonaws.quicksight#ColumnName", - "traits": { - "smithy.api#documentation": "

The name of the column.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A column of a data set.

" - } - }, - "com.amazonaws.quicksight#ColumnLevelPermissionRule": { - "type": "structure", - "members": { - "Principals": { - "target": "com.amazonaws.quicksight#PrincipalList", - "traits": { - "smithy.api#documentation": "

An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.

" - } - }, - "ColumnNames": { - "target": "com.amazonaws.quicksight#ColumnNameList", - "traits": { - "smithy.api#documentation": "

An array of column names.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A rule defined to grant access on one or more restricted columns.\n Each dataset can have multiple rules.\n To create a restricted column, you add it to one or more rules.\n Each rule must contain at least one column and at least one user or group.\n To be able to see a restricted column, a user or group needs to be added\n to a rule for that column.

" - } - }, - "com.amazonaws.quicksight#ColumnLevelPermissionRuleList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnLevelPermissionRule" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.quicksight#ColumnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnName" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16 - } - } - }, - "com.amazonaws.quicksight#ColumnName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.quicksight#ColumnNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#String" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.quicksight#ColumnOrderingType": { - "type": "enum", - "members": { - "GREATER_IS_BETTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GREATER_IS_BETTER" - } - }, - "LESSER_IS_BETTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LESSER_IS_BETTER" - } - }, - "SPECIFIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SPECIFIED" - } - } - } - }, - "com.amazonaws.quicksight#ColumnRole": { - "type": "enum", - "members": { - "DIMENSION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIMENSION" - } - }, - "MEASURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEASURE" - } - } - } - }, - "com.amazonaws.quicksight#ColumnSchema": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of the column schema.

" - } - }, - "DataType": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The data type of the column schema.

" - } - }, - "GeographicRole": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The geographic role of the column schema.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The column schema.

" - } - }, - "com.amazonaws.quicksight#ColumnSchemaList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnSchema" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.quicksight#ColumnSort": { - "type": "structure", - "members": { - "SortBy": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#required": {} - } - }, - "Direction": { - "target": "com.amazonaws.quicksight#SortDirection", - "traits": { - "smithy.api#documentation": "

The sort direction.

", - "smithy.api#required": {} - } - }, - "AggregationFunction": { - "target": "com.amazonaws.quicksight#AggregationFunction", - "traits": { - "smithy.api#documentation": "

The aggregation function that is defined in the column sort.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration for a column that is not used in a field well.

" - } - }, - "com.amazonaws.quicksight#ColumnTag": { - "type": "structure", - "members": { - "ColumnGeographicRole": { - "target": "com.amazonaws.quicksight#GeoSpatialDataRole", - "traits": { - "smithy.api#documentation": "

A geospatial role for a column.

" - } - }, - "ColumnDescription": { - "target": "com.amazonaws.quicksight#ColumnDescription", - "traits": { - "smithy.api#documentation": "

A description for a column.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A tag for a column in a\n \n TagColumnOperation\n \n structure. This is a\n variant type structure. For this structure to be valid, only one of the attributes can\n be non-null.

" - } - }, - "com.amazonaws.quicksight#ColumnTagList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnTag" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16 - } - } - }, - "com.amazonaws.quicksight#ColumnTagName": { - "type": "enum", - "members": { - "COLUMN_GEOGRAPHIC_ROLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLUMN_GEOGRAPHIC_ROLE" - } - }, - "COLUMN_DESCRIPTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLUMN_DESCRIPTION" - } - } - } - }, - "com.amazonaws.quicksight#ColumnTagNames": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnTagName" - } - }, - "com.amazonaws.quicksight#ColumnTooltipItem": { - "type": "structure", - "members": { - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The target column of the tooltip item.

", - "smithy.api#required": {} - } - }, - "Label": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The label of the tooltip item.

" - } - }, - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the tooltip item.

" - } - }, - "Aggregation": { - "target": "com.amazonaws.quicksight#AggregationFunction", - "traits": { - "smithy.api#documentation": "

The aggregation function of the column tooltip item.

" - } - }, - "TooltipTarget": { - "target": "com.amazonaws.quicksight#TooltipTarget", - "traits": { - "smithy.api#documentation": "

Determines the target of the column tooltip item in a combo chart visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The tooltip item for the columns that are not part of a field well.

" - } - }, - "com.amazonaws.quicksight#ComboChartAggregatedFieldWells": { - "type": "structure", - "members": { - "Category": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The aggregated category field wells of a combo chart.

" - } - }, - "BarValues": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The aggregated BarValues field well of a combo chart.

" - } - }, - "Colors": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The aggregated colors field well of a combo chart.

" - } - }, - "LineValues": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The aggregated LineValues field well of a combo chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a combo chart.

" - } - }, - "com.amazonaws.quicksight#ComboChartConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#ComboChartFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#ComboChartSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a ComboChartVisual.

" - } - }, - "BarsArrangement": { - "target": "com.amazonaws.quicksight#BarsArrangement", - "traits": { - "smithy.api#documentation": "

Determines the bar arrangement in a combo chart. The following are valid values in this structure:

\n " - } - }, - "CategoryAxis": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The category axis of a combo chart.

" - } - }, - "CategoryLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.

" - } - }, - "PrimaryYAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.

" - } - }, - "PrimaryYAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.

" - } - }, - "SecondaryYAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.

" - } - }, - "SecondaryYAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.

" - } - }, - "SingleAxisOptions": { - "target": "com.amazonaws.quicksight#SingleAxisOptions" - }, - "ColorLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "

The legend display setup of the visual.

" - } - }, - "BarDataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

\n

The data label options for a bar in a combo chart.

" - } - }, - "LineDataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

\n

The data label options for a line in a combo chart.

" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The legend display setup of the visual.

" - } - }, - "ReferenceLines": { - "target": "com.amazonaws.quicksight#ReferenceLineList", - "traits": { - "smithy.api#documentation": "

The reference line setup of the visual.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a ComboChartVisual.

" - } - }, - "com.amazonaws.quicksight#ComboChartFieldWells": { - "type": "structure", - "members": { - "ComboChartAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#ComboChartAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a combo chart. Combo charts only have aggregated field wells. Columns in a combo chart are aggregated by category.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#ComboChartSortConfiguration": { - "type": "structure", - "members": { - "CategorySort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the category field well in a combo chart.

" - } - }, - "CategoryItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The item limit configuration for the category field well of a combo chart.

" - } - }, - "ColorSort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the color field well in a combo chart.

" - } - }, - "ColorItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The item limit configuration of the color field well in a combo chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a ComboChartVisual.

" - } - }, - "com.amazonaws.quicksight#ComboChartVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#ComboChartConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the visual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A combo chart.

\n

The ComboChartVisual includes stacked bar combo charts and clustered bar combo charts

\n

For more information, see Using combo charts in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#ComparativeOrder": { - "type": "structure", - "members": { - "UseOrdering": { - "target": "com.amazonaws.quicksight#ColumnOrderingType", - "traits": { - "smithy.api#documentation": "

The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER, LESSER_IS_BETTER and SPECIFIED.

" - } - }, - "SpecifedOrder": { - "target": "com.amazonaws.quicksight#StringList", - "traits": { - "smithy.api#documentation": "

The list of columns to be used in the ordering.

" - } - }, - "TreatUndefinedSpecifiedValues": { - "target": "com.amazonaws.quicksight#UndefinedSpecifiedValueType", - "traits": { - "smithy.api#documentation": "

The treat of undefined specified values. Valid values for this structure are LEAST and MOST.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a comparative order.

" - } - }, - "com.amazonaws.quicksight#ComparisonConfiguration": { - "type": "structure", - "members": { - "ComparisonMethod": { - "target": "com.amazonaws.quicksight#ComparisonMethod", - "traits": { - "smithy.api#documentation": "

The method of the comparison. Choose from the following options:

\n " - } - }, - "ComparisonFormat": { - "target": "com.amazonaws.quicksight#ComparisonFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The format of the comparison.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The comparison display configuration of a KPI or gauge chart.

" - } - }, - "com.amazonaws.quicksight#ComparisonFormatConfiguration": { - "type": "structure", - "members": { - "NumberDisplayFormatConfiguration": { - "target": "com.amazonaws.quicksight#NumberDisplayFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The number display format.

" - } - }, - "PercentageDisplayFormatConfiguration": { - "target": "com.amazonaws.quicksight#PercentageDisplayFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The percentage display format.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The format of the comparison.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#ComparisonMethod": { - "type": "enum", - "members": { - "DIFFERENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIFFERENCE" - } - }, - "PERCENT_DIFFERENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENT_DIFFERENCE" - } - }, - "PERCENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENT" - } - } - } - }, - "com.amazonaws.quicksight#ComparisonMethodType": { - "type": "enum", - "members": { - "DIFF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIFF" - } - }, - "PERC_DIFF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERC_DIFF" - } - }, - "DIFF_AS_PERC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIFF_AS_PERC" - } - }, - "POP_CURRENT_DIFF_AS_PERC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POP_CURRENT_DIFF_AS_PERC" - } - }, - "POP_CURRENT_DIFF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POP_CURRENT_DIFF" - } - }, - "POP_OVERTIME_DIFF_AS_PERC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POP_OVERTIME_DIFF_AS_PERC" - } - }, - "POP_OVERTIME_DIFF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POP_OVERTIME_DIFF" - } - }, - "PERCENT_OF_TOTAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENT_OF_TOTAL" - } - }, - "RUNNING_SUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING_SUM" - } - }, - "MOVING_AVERAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MOVING_AVERAGE" - } - } - } - }, - "com.amazonaws.quicksight#Computation": { - "type": "structure", - "members": { - "TopBottomRanked": { - "target": "com.amazonaws.quicksight#TopBottomRankedComputation", - "traits": { - "smithy.api#documentation": "

The top ranked and bottom ranked computation configuration.

" - } - }, - "TopBottomMovers": { - "target": "com.amazonaws.quicksight#TopBottomMoversComputation", - "traits": { - "smithy.api#documentation": "

The top movers and bottom movers computation configuration.

" - } - }, - "TotalAggregation": { - "target": "com.amazonaws.quicksight#TotalAggregationComputation", - "traits": { - "smithy.api#documentation": "

The total aggregation computation configuration.

" - } - }, - "MaximumMinimum": { - "target": "com.amazonaws.quicksight#MaximumMinimumComputation", - "traits": { - "smithy.api#documentation": "

The maximum and minimum computation configuration.

" - } - }, - "MetricComparison": { - "target": "com.amazonaws.quicksight#MetricComparisonComputation", - "traits": { - "smithy.api#documentation": "

The metric comparison computation configuration.

" - } - }, - "PeriodOverPeriod": { - "target": "com.amazonaws.quicksight#PeriodOverPeriodComputation", - "traits": { - "smithy.api#documentation": "

The period over period computation configuration.

" - } - }, - "PeriodToDate": { - "target": "com.amazonaws.quicksight#PeriodToDateComputation", - "traits": { - "smithy.api#documentation": "

The period to DataSetIdentifier computation configuration.

" - } - }, - "GrowthRate": { - "target": "com.amazonaws.quicksight#GrowthRateComputation", - "traits": { - "smithy.api#documentation": "

The growth rate computation configuration.

" - } - }, - "UniqueValues": { - "target": "com.amazonaws.quicksight#UniqueValuesComputation", - "traits": { - "smithy.api#documentation": "

The unique values computation configuration.

" - } - }, - "Forecast": { - "target": "com.amazonaws.quicksight#ForecastComputation", - "traits": { - "smithy.api#documentation": "

The forecast computation configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The computation union that is used in an insight visual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#ComputationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Computation" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#ConcurrentUpdatingException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String" - } - }, - "traits": { - "smithy.api#documentation": "

A resource is already in a state that indicates an operation is happening that must complete\n\t\t\tbefore a new update can be applied.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.quicksight#ConditionalFormattingColor": { - "type": "structure", - "members": { - "Solid": { - "target": "com.amazonaws.quicksight#ConditionalFormattingSolidColor", - "traits": { - "smithy.api#documentation": "

Formatting configuration for solid color.

" - } - }, - "Gradient": { - "target": "com.amazonaws.quicksight#ConditionalFormattingGradientColor", - "traits": { - "smithy.api#documentation": "

Formatting configuration for gradient color.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The formatting configuration for the color.

" - } - }, - "com.amazonaws.quicksight#ConditionalFormattingCustomIconCondition": { - "type": "structure", - "members": { - "Expression": { - "target": "com.amazonaws.quicksight#Expression", - "traits": { - "smithy.api#documentation": "

The expression that determines the condition of the icon set.

", - "smithy.api#required": {} - } - }, - "IconOptions": { - "target": "com.amazonaws.quicksight#ConditionalFormattingCustomIconOptions", - "traits": { - "smithy.api#documentation": "

Custom icon options for an icon set.

", - "smithy.api#required": {} - } - }, - "Color": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

Determines the color of the icon.

" - } - }, - "DisplayConfiguration": { - "target": "com.amazonaws.quicksight#ConditionalFormattingIconDisplayConfiguration", - "traits": { - "smithy.api#documentation": "

Determines the icon display configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines the custom condition for an icon set.

" - } - }, - "com.amazonaws.quicksight#ConditionalFormattingCustomIconOptions": { - "type": "structure", - "members": { - "Icon": { - "target": "com.amazonaws.quicksight#Icon", - "traits": { - "smithy.api#documentation": "

Determines the type of icon.

" - } - }, - "UnicodeIcon": { - "target": "com.amazonaws.quicksight#UnicodeIcon", - "traits": { - "smithy.api#documentation": "

Determines the Unicode icon type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Custom icon options for an icon set.

" - } - }, - "com.amazonaws.quicksight#ConditionalFormattingGradientColor": { - "type": "structure", - "members": { - "Expression": { - "target": "com.amazonaws.quicksight#Expression", - "traits": { - "smithy.api#documentation": "

The expression that determines the formatting configuration for gradient color.

", - "smithy.api#required": {} - } - }, - "Color": { - "target": "com.amazonaws.quicksight#GradientColor", - "traits": { - "smithy.api#documentation": "

Determines the color.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Formatting configuration for gradient color.

" - } - }, - "com.amazonaws.quicksight#ConditionalFormattingIcon": { - "type": "structure", - "members": { - "IconSet": { - "target": "com.amazonaws.quicksight#ConditionalFormattingIconSet", - "traits": { - "smithy.api#documentation": "

Formatting configuration for icon set.

" - } - }, - "CustomCondition": { - "target": "com.amazonaws.quicksight#ConditionalFormattingCustomIconCondition", - "traits": { - "smithy.api#documentation": "

Determines the custom condition for an icon set.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The formatting configuration for the icon.

" - } - }, - "com.amazonaws.quicksight#ConditionalFormattingIconDisplayConfiguration": { - "type": "structure", - "members": { - "IconDisplayOption": { - "target": "com.amazonaws.quicksight#ConditionalFormattingIconDisplayOption", - "traits": { - "smithy.api#documentation": "

Determines the icon display configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines the icon display configuration.

" - } - }, - "com.amazonaws.quicksight#ConditionalFormattingIconDisplayOption": { - "type": "enum", - "members": { - "ICON_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ICON_ONLY" - } - } - } - }, - "com.amazonaws.quicksight#ConditionalFormattingIconSet": { - "type": "structure", - "members": { - "Expression": { - "target": "com.amazonaws.quicksight#Expression", - "traits": { - "smithy.api#documentation": "

The expression that determines the formatting configuration for the icon set.

", - "smithy.api#required": {} - } - }, - "IconSetType": { - "target": "com.amazonaws.quicksight#ConditionalFormattingIconSetType", - "traits": { - "smithy.api#documentation": "

Determines the icon set type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Formatting configuration for icon set.

" - } - }, - "com.amazonaws.quicksight#ConditionalFormattingIconSetType": { - "type": "enum", - "members": { - "PLUS_MINUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PLUS_MINUS" - } - }, - "CHECK_X": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CHECK_X" - } - }, - "THREE_COLOR_ARROW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THREE_COLOR_ARROW" - } - }, - "THREE_GRAY_ARROW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THREE_GRAY_ARROW" - } - }, - "CARET_UP_MINUS_DOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CARET_UP_MINUS_DOWN" - } - }, - "THREE_SHAPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THREE_SHAPE" - } - }, - "THREE_CIRCLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THREE_CIRCLE" - } - }, - "FLAGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FLAGS" - } - }, - "BARS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BARS" - } - }, - "FOUR_COLOR_ARROW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FOUR_COLOR_ARROW" - } - }, - "FOUR_GRAY_ARROW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FOUR_GRAY_ARROW" - } - } - } - }, - "com.amazonaws.quicksight#ConditionalFormattingSolidColor": { - "type": "structure", - "members": { - "Expression": { - "target": "com.amazonaws.quicksight#Expression", - "traits": { - "smithy.api#documentation": "

The expression that determines the formatting configuration for solid color.

", - "smithy.api#required": {} - } - }, - "Color": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

Determines the color.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Formatting configuration for solid color.

" - } - }, - "com.amazonaws.quicksight#ConflictException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Updating or deleting a resource can cause an inconsistent state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.quicksight#ConstantType": { - "type": "enum", - "members": { - "SINGULAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SINGULAR" - } - }, - "RANGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RANGE" - } - }, - "COLLECTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLLECTIVE" - } - } - } - }, - "com.amazonaws.quicksight#ConstantValueString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.quicksight#ContextMenuOption": { - "type": "structure", - "members": { - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#DashboardBehavior", - "traits": { - "smithy.api#documentation": "

The availability status of the context menu options. If the value of this property is set to ENABLED, dashboard readers can interact with the context menu.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The context menu options for a visual's interactions.

" - } - }, - "com.amazonaws.quicksight#ContributionAnalysisDefault": { - "type": "structure", - "members": { - "MeasureFieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The measure field that is used in the contribution analysis.

", - "smithy.api#required": {} - } - }, - "ContributorDimensions": { - "target": "com.amazonaws.quicksight#ContributorDimensionList", - "traits": { - "smithy.api#documentation": "

The dimensions columns that are used in the contribution analysis,\n usually a list of ColumnIdentifiers.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The contribution analysis visual display for a line, pie, or bar chart.

" - } - }, - "com.amazonaws.quicksight#ContributionAnalysisDefaultList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ContributionAnalysisDefault" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#ContributionAnalysisDirection": { - "type": "enum", - "members": { - "INCREASE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INCREASE" - } - }, - "DECREASE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DECREASE" - } - }, - "NEUTRAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEUTRAL" - } - } - } - }, - "com.amazonaws.quicksight#ContributionAnalysisFactor": { - "type": "structure", - "members": { - "FieldName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The field name of the ContributionAnalysisFactor.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for the ContributionAnalysisFactor.

" - } - }, - "com.amazonaws.quicksight#ContributionAnalysisFactorsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ContributionAnalysisFactor" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#ContributionAnalysisSortType": { - "type": "enum", - "members": { - "ABSOLUTE_DIFFERENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ABSOLUTE_DIFFERENCE" - } - }, - "CONTRIBUTION_PERCENTAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTRIBUTION_PERCENTAGE" - } - }, - "DEVIATION_FROM_EXPECTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEVIATION_FROM_EXPECTED" - } - }, - "PERCENTAGE_DIFFERENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENTAGE_DIFFERENCE" - } - } - } - }, - "com.amazonaws.quicksight#ContributionAnalysisTimeRanges": { - "type": "structure", - "members": { - "StartRange": { - "target": "com.amazonaws.quicksight#TopicIRFilterOption", - "traits": { - "smithy.api#documentation": "

The start range for the ContributionAnalysisTimeRanges.

" - } - }, - "EndRange": { - "target": "com.amazonaws.quicksight#TopicIRFilterOption", - "traits": { - "smithy.api#documentation": "

The end range for the ContributionAnalysisTimeRanges.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for the ContributionAnalysisTimeRanges.

" - } - }, - "com.amazonaws.quicksight#ContributorDimensionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnIdentifier" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 4 - } - } - }, - "com.amazonaws.quicksight#CopySourceArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:[-a-z0-9]*:quicksight:[-a-z0-9]*:[0-9]{12}:datasource/.+$" - } - }, - "com.amazonaws.quicksight#CreateAccountCustomization": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateAccountCustomizationRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateAccountCustomizationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the\n CreateAccountCustomization or UpdateAccountCustomization\n API operation. To further customize Amazon QuickSight by removing Amazon QuickSight\n sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide.\n

\n

You can create customizations for your Amazon Web Services account or, if you specify a namespace, for\n a QuickSight namespace instead. Customizations that apply to a namespace always override\n customizations that apply to an Amazon Web Services account. To find out which customizations apply, use\n the DescribeAccountCustomization API operation.

\n

Before you use the CreateAccountCustomization API operation to add a theme\n as the namespace default, make sure that you first share the theme with the namespace.\n If you don't share it with the namespace, the theme isn't visible to your users\n even if you make it the default theme.\n To check if the theme is shared, view the current permissions by using the\n \n DescribeThemePermissions\n \n API operation.\n To share the theme, grant permissions by using the\n \n UpdateThemePermissions\n \n API operation.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/customizations", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateAccountCustomizationRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight namespace that you want to add customizations to.

", - "smithy.api#httpQuery": "namespace" - } - }, - "AccountCustomization": { - "target": "com.amazonaws.quicksight#AccountCustomization", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add\n these to an Amazon Web Services account and a QuickSight namespace.

\n

For example, you can add a default theme by setting AccountCustomization\n to the midnight theme: \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }. Or, you can add a custom theme by\n specifying \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\"\n }.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

A list of the tags that you want to attach to this resource.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateAccountCustomizationResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.

" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace associated with the customization you're creating.

" - } - }, - "AccountCustomization": { - "target": "com.amazonaws.quicksight#AccountCustomization", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateAccountSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateAccountSubscriptionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateAccountSubscriptionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.

\n

The Amazon Web Services Region for the account is derived from what is configured in the\n CLI or SDK.

\n

Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign\n up for Amazon Web Services in the Amazon QuickSight User\n Guide. The person who signs up for Amazon QuickSight needs to have the\n correct Identity and Access Management (IAM) permissions. For more information,\n see IAM Policy Examples for Amazon QuickSight in the\n Amazon QuickSight User Guide.

\n

If your IAM policy includes both the Subscribe and\n CreateAccountSubscription actions, make sure that both actions are set\n to Allow. If either action is set to Deny, the\n Deny action prevails and your API call fails.

\n

You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to\n Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the\n Amazon QuickSight User Guide.

\n

You can't set default resource access on the new account from the Amazon QuickSight\n API. Instead, add default resource access from the Amazon QuickSight console. For more\n information about setting default resource access to Amazon Web Services services, see\n Setting default resource\n access to Amazon Web Services services in the Amazon QuickSight\n User Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/account/{AwsAccountId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateAccountSubscriptionRequest": { - "type": "structure", - "members": { - "Edition": { - "target": "com.amazonaws.quicksight#Edition", - "traits": { - "smithy.api#documentation": "

The edition of Amazon QuickSight that you want your account to have. Currently, you can\n choose from ENTERPRISE or\n ENTERPRISE_AND_Q.

\n

If you choose ENTERPRISE_AND_Q, the following parameters are\n required:

\n " - } - }, - "AuthenticationMethod": { - "target": "com.amazonaws.quicksight#AuthenticationMethodOption", - "traits": { - "smithy.api#documentation": "

The method that you want to use to authenticate your Amazon QuickSight account.

\n

If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName\n and an AdminGroup associated with your Active Directory.

\n

If you choose IAM_IDENTITY_CENTER, provide an AdminGroup associated with your IAM Identity Center account.

", - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AccountName": { - "target": "com.amazonaws.quicksight#AccountName", - "traits": { - "smithy.api#documentation": "

The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change\n AccountName value after the Amazon QuickSight account is\n created.

", - "smithy.api#required": {} - } - }, - "NotificationEmail": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.

", - "smithy.api#required": {} - } - }, - "ActiveDirectoryName": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

" - } - }, - "Realm": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

" - } - }, - "DirectoryId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the Active Directory that is associated with your Amazon QuickSight account.

" - } - }, - "AdminGroup": { - "target": "com.amazonaws.quicksight#GroupsList", - "traits": { - "smithy.api#documentation": "

The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" - } - }, - "AuthorGroup": { - "target": "com.amazonaws.quicksight#GroupsList", - "traits": { - "smithy.api#documentation": "

The author group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" - } - }, - "ReaderGroup": { - "target": "com.amazonaws.quicksight#GroupsList", - "traits": { - "smithy.api#documentation": "

The reader group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" - } - }, - "AdminProGroup": { - "target": "com.amazonaws.quicksight#GroupsList", - "traits": { - "smithy.api#documentation": "

The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" - } - }, - "AuthorProGroup": { - "target": "com.amazonaws.quicksight#GroupsList", - "traits": { - "smithy.api#documentation": "

The author pro group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" - } - }, - "ReaderProGroup": { - "target": "com.amazonaws.quicksight#GroupsList", - "traits": { - "smithy.api#documentation": "

The reader pro group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" - } - }, - "FirstName": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The first name of the author of the Amazon QuickSight account to use for future\n communications. This field is required if ENTERPPRISE_AND_Q is the selected\n edition of the new Amazon QuickSight account.

" - } - }, - "LastName": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The last name of the author of the Amazon QuickSight account to use for future\n communications. This field is required if ENTERPPRISE_AND_Q is the selected\n edition of the new Amazon QuickSight account.

" - } - }, - "EmailAddress": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The email address of the author of the Amazon QuickSight account to use for future\n communications. This field is required if ENTERPPRISE_AND_Q is the selected\n edition of the new Amazon QuickSight account.

" - } - }, - "ContactNumber": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A 10-digit phone number for the author of the Amazon QuickSight account to use for\n future communications. This field is required if ENTERPPRISE_AND_Q is the\n selected edition of the new Amazon QuickSight account.

" - } - }, - "IAMIdentityCenterInstanceArn": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM Identity Center instance.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateAccountSubscriptionResponse": { - "type": "structure", - "members": { - "SignupResponse": { - "target": "com.amazonaws.quicksight#SignupResponse", - "traits": { - "smithy.api#documentation": "

A SignupResponse object that returns information about a newly created Amazon QuickSight account.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateAnalysis": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateAnalysisRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateAnalysisResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an AnalysisDefinition.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateAnalysisRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account where you are creating an analysis.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the analysis that you're creating. This ID displays in the URL of the\n analysis.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#AnalysisName", - "traits": { - "smithy.api#documentation": "

A descriptive name for the analysis that you're creating. This name displays for the\n analysis in the Amazon QuickSight console.

", - "smithy.api#required": {} - } - }, - "Parameters": { - "target": "com.amazonaws.quicksight#Parameters", - "traits": { - "smithy.api#documentation": "

The parameter names and override values that you want to use. An analysis can have \n any parameter type, and some parameters might accept multiple values.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A structure that describes the principals and the resource-level permissions on an\n analysis. You can use the Permissions structure to grant permissions by\n providing a list of Identity and Access Management (IAM) action information for each\n principal listed by Amazon Resource Name (ARN).

\n

To specify no permissions, omit Permissions.

" - } - }, - "SourceEntity": { - "target": "com.amazonaws.quicksight#AnalysisSourceEntity", - "traits": { - "smithy.api#documentation": "

A source entity to use for the analysis that you're creating. This metadata structure\n contains details that describe a source template and one or more datasets.

\n

Either a SourceEntity or a Definition must be provided in \n order for the request to be valid.

" - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the theme to apply to the analysis that you're creating. To see the theme\n in the Amazon QuickSight console, make sure that you have access to it.

" - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the\n analysis.

" - } - }, - "Definition": { - "target": "com.amazonaws.quicksight#AnalysisDefinition", - "traits": { - "smithy.api#documentation": "

The definition of an analysis.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

\n

Either a SourceEntity or a Definition must be provided in \n order for the request to be valid.

" - } - }, - "ValidationStrategy": { - "target": "com.amazonaws.quicksight#ValidationStrategy", - "traits": { - "smithy.api#documentation": "

The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

" - } - }, - "FolderArns": { - "target": "com.amazonaws.quicksight#FolderArnList", - "traits": { - "smithy.api#documentation": "

When you create the analysis, Amazon QuickSight adds the analysis to these folders.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateAnalysisResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the analysis.

" - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis.

" - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The status of the creation of the analysis.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateColumnsOperation": { - "type": "structure", - "members": { - "Columns": { - "target": "com.amazonaws.quicksight#CalculatedColumnList", - "traits": { - "smithy.api#documentation": "

Calculated columns to create.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A transform operation that creates calculated columns. Columns created in one such\n operation form a lexical closure.

" - } - }, - "com.amazonaws.quicksight#CreateDashboard": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateDashboardRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateDashboardResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the \n \n CreateTemplate\n \n API operation.

\n

A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created\n from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can\n create scheduled email reports from them. If you have the correct permissions, you can\n create a dashboard from a template that exists in a different Amazon Web Services account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateDashboardRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account where you want to create the dashboard.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard, also added to the IAM policy.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DashboardName", - "traits": { - "smithy.api#documentation": "

The display name of the dashboard.

", - "smithy.api#required": {} - } - }, - "Parameters": { - "target": "com.amazonaws.quicksight#Parameters", - "traits": { - "smithy.api#documentation": "

The parameters for the creation of the dashboard, which you want to use to override\n the default settings. A dashboard can have any type of parameters, and some parameters\n might accept multiple values.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A structure that contains the permissions of the dashboard. You can use this structure\n for granting permissions by providing a list of IAM action information for each\n principal ARN.

\n

To specify no permissions, omit the permissions list.

" - } - }, - "SourceEntity": { - "target": "com.amazonaws.quicksight#DashboardSourceEntity", - "traits": { - "smithy.api#documentation": "

The entity that you are using as a source when you create the dashboard. In\n SourceEntity, you specify the type of object you're using as source. You\n can only create a dashboard from a template, so you use a SourceTemplate\n entity. If you need to create a dashboard from an analysis, first convert the analysis\n to a template by using the \n CreateTemplate\n \n API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplateARN can contain any Amazon Web Services account and any\n Amazon QuickSight-supported Amazon Web Services Region.

\n

Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.

\n

Either a SourceEntity or a Definition must be provided in \n order for the request to be valid.

" - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the\n dashboard.

" - } - }, - "VersionDescription": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

A description for the first version of the dashboard being created.

" - } - }, - "DashboardPublishOptions": { - "target": "com.amazonaws.quicksight#DashboardPublishOptions", - "traits": { - "smithy.api#documentation": "

Options for publishing the dashboard when you create it:

\n " - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If\n you add a value for this field, it overrides the value that is used in the source\n entity. The theme ARN must exist in the same Amazon Web Services account where you create the\n dashboard.

" - } - }, - "Definition": { - "target": "com.amazonaws.quicksight#DashboardVersionDefinition", - "traits": { - "smithy.api#documentation": "

The definition of a dashboard.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

\n

Either a SourceEntity or a Definition must be provided in \n order for the request to be valid.

" - } - }, - "ValidationStrategy": { - "target": "com.amazonaws.quicksight#ValidationStrategy", - "traits": { - "smithy.api#documentation": "

The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.

" - } - }, - "FolderArns": { - "target": "com.amazonaws.quicksight#FolderArnList", - "traits": { - "smithy.api#documentation": "

When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

" - } - }, - "LinkSharingConfiguration": { - "target": "com.amazonaws.quicksight#LinkSharingConfiguration", - "traits": { - "smithy.api#documentation": "

A structure that contains the permissions of a shareable link to the dashboard.

" - } - }, - "LinkEntities": { - "target": "com.amazonaws.quicksight#LinkEntityArnList", - "traits": { - "smithy.api#documentation": "

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateDashboardResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the dashboard.

" - } - }, - "VersionArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the dashboard, including the version number of the first version that is\n created.

" - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

" - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The status of the dashboard creation request.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateDataSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateDataSetRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateDataSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/data-sets", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateDataSetRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

The display name for the dataset.

", - "smithy.api#required": {} - } - }, - "PhysicalTableMap": { - "target": "com.amazonaws.quicksight#PhysicalTableMap", - "traits": { - "smithy.api#documentation": "

Declares the physical tables that are available in the underlying data sources.

", - "smithy.api#required": {} - } - }, - "LogicalTableMap": { - "target": "com.amazonaws.quicksight#LogicalTableMap", - "traits": { - "smithy.api#documentation": "

Configures the combination and transformation of the data from the physical tables.

" - } - }, - "ImportMode": { - "target": "com.amazonaws.quicksight#DataSetImportMode", - "traits": { - "smithy.api#documentation": "

Indicates whether you want to import the data into SPICE.

", - "smithy.api#required": {} - } - }, - "ColumnGroups": { - "target": "com.amazonaws.quicksight#ColumnGroupList", - "traits": { - "smithy.api#documentation": "

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

" - } - }, - "FieldFolders": { - "target": "com.amazonaws.quicksight#FieldFolderMap", - "traits": { - "smithy.api#documentation": "

The folder that contains fields and nested subfolders for your dataset.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions on the dataset.

" - } - }, - "RowLevelPermissionDataSet": { - "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", - "traits": { - "smithy.api#documentation": "

The row-level security configuration for the data that you want to create.

" - } - }, - "RowLevelPermissionTagConfiguration": { - "target": "com.amazonaws.quicksight#RowLevelPermissionTagConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

" - } - }, - "ColumnLevelPermissionRules": { - "target": "com.amazonaws.quicksight#ColumnLevelPermissionRuleList", - "traits": { - "smithy.api#documentation": "

A set of one or more definitions of a \n ColumnLevelPermissionRule\n .

" - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

" - } - }, - "DataSetUsageConfiguration": { - "target": "com.amazonaws.quicksight#DataSetUsageConfiguration" - }, - "DatasetParameters": { - "target": "com.amazonaws.quicksight#DatasetParameterList", - "traits": { - "smithy.api#documentation": "

The parameter declarations of the dataset.

" - } - }, - "FolderArns": { - "target": "com.amazonaws.quicksight#FolderArnList", - "traits": { - "smithy.api#documentation": "

When you create the dataset, Amazon QuickSight adds the dataset to these folders.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateDataSetResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "IngestionArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the ingestion, which is triggered as a result of dataset creation if the import\n\t\t\tmode is SPICE.

" - } - }, - "IngestionId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the ingestion, which is triggered as a result of dataset creation if the import\n\t\t\tmode is SPICE.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateDataSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateDataSourceRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateDataSourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#CustomerManagedKeyUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a data source.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/data-sources", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateDataSourceRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

A display name for the data source.

", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.quicksight#DataSourceType", - "traits": { - "smithy.api#documentation": "

The type of the data source. To return a\n\t\t\tlist of all data sources, use ListDataSources.

\n

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

", - "smithy.api#required": {} - } - }, - "DataSourceParameters": { - "target": "com.amazonaws.quicksight#DataSourceParameters", - "traits": { - "smithy.api#documentation": "

The parameters that Amazon QuickSight uses to connect to your underlying source.

" - } - }, - "Credentials": { - "target": "com.amazonaws.quicksight#DataSourceCredentials", - "traits": { - "smithy.api#documentation": "

The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only\n\t\t\tcredentials based on user name and password are supported.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions on the data source.

" - } - }, - "VpcConnectionProperties": { - "target": "com.amazonaws.quicksight#VpcConnectionProperties", - "traits": { - "smithy.api#documentation": "

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to\n\t\t\tyour underlying source.

" - } - }, - "SslProperties": { - "target": "com.amazonaws.quicksight#SslProperties", - "traits": { - "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

" - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

" - } - }, - "FolderArns": { - "target": "com.amazonaws.quicksight#FolderArnList", - "traits": { - "smithy.api#documentation": "

When you create the data source, Amazon QuickSight adds the data source to these folders.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateDataSourceResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The status of creating the data source.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateFolder": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateFolderRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateFolderResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an empty shared folder.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/folders/{FolderId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateFolderMembership": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateFolderMembershipRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateFolderMembershipResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds an asset, such as a dashboard, analysis, or dataset into a folder.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateFolderMembershipRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MemberId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the asset that you want to add to the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MemberType": { - "target": "com.amazonaws.quicksight#MemberType", - "traits": { - "smithy.api#documentation": "

The member type of the asset that you want to add to a folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateFolderMembershipResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

" - } - }, - "FolderMember": { - "target": "com.amazonaws.quicksight#FolderMember", - "traits": { - "smithy.api#documentation": "

Information about the member in the folder.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateFolderRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account where you want to create the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#FolderName", - "traits": { - "smithy.api#documentation": "

The name of the folder.

" - } - }, - "FolderType": { - "target": "com.amazonaws.quicksight#FolderType", - "traits": { - "smithy.api#documentation": "

The type of folder. By default, folderType is SHARED.

" - } - }, - "ParentFolderArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the parent folder.

\n

\n ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A structure that describes the principals and the resource-level permissions of a folder.

\n

To specify no permissions, omit Permissions.

" - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

Tags for the folder.

" - } - }, - "SharingModel": { - "target": "com.amazonaws.quicksight#SharingModel", - "traits": { - "smithy.api#documentation": "

An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateFolderResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the newly created folder.

" - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The folder ID for the newly created folder.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The request ID for the newly created folder.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateGroupRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Use the CreateGroup operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services Support.

\n

The permissions resource is\n\t\t\t\t\tarn:aws:quicksight:::group/default/\n .

\n

The response is a group object.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateGroupMembership": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateGroupMembershipRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateGroupMembershipResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds an Amazon QuickSight user to an Amazon QuickSight group.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateGroupMembershipRequest": { - "type": "structure", - "members": { - "MemberName": { - "target": "com.amazonaws.quicksight#GroupMemberName", - "traits": { - "smithy.api#documentation": "

The name of the user that you want to add to the group membership.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

The name of the group that you want to add the user to.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the \n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that you want the user to be a part of.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateGroupMembershipResponse": { - "type": "structure", - "members": { - "GroupMember": { - "target": "com.amazonaws.quicksight#GroupMember", - "traits": { - "smithy.api#documentation": "

The group member.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateGroupRequest": { - "type": "structure", - "members": { - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

A name for the group that you want to create.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.quicksight#GroupDescription", - "traits": { - "smithy.api#documentation": "

A description for the group that you want to create.

" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that you want the group to be a part of.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The request object for this operation.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateGroupResponse": { - "type": "structure", - "members": { - "Group": { - "target": "com.amazonaws.quicksight#Group", - "traits": { - "smithy.api#documentation": "

The name of the group.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The response object for this operation.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateIAMPolicyAssignment": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateIAMPolicyAssignmentRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateIAMPolicyAssignmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConcurrentUpdatingException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an assignment with one specified IAM policy, identified by its\n\t\t\tAmazon Resource Name (ARN). This policy assignment is attached to the specified groups\n\t\t\tor users of Amazon QuickSight. Assignment names are unique per Amazon Web Services\n\t\t\taccount. To avoid overwriting rules in other namespaces, use assignment names that are\n\t\t\tunique.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateIAMPolicyAssignmentRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "

The name of the assignment, also called a rule.\n\t\t\tThe\n\t\t\tname\n\t\t\tmust be unique within the\n\t\t\tAmazon Web Services account.

", - "smithy.api#required": {} - } - }, - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", - "traits": { - "smithy.api#documentation": "

The status of the assignment. Possible values are as follows:

\n ", - "smithy.api#required": {} - } - }, - "PolicyArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the IAM policy to apply to the Amazon QuickSight users and\n\t\t\tgroups specified in this assignment.

" - } - }, - "Identities": { - "target": "com.amazonaws.quicksight#IdentityMap", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight users, groups, or both that you want to assign the policy\n\t\t\tto.

" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that contains the assignment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateIAMPolicyAssignmentResponse": { - "type": "structure", - "members": { - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "

The name of the assignment.\n\t\t\tThe\n\t\t\tname must be unique within the Amazon Web Services account.

" - } - }, - "AssignmentId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID for the assignment.

" - } - }, - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", - "traits": { - "smithy.api#documentation": "

The status of the assignment. Possible values are as follows:

\n " - } - }, - "PolicyArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the IAM policy that is applied to the Amazon QuickSight\n\t\t\tusers and groups specified in this assignment.

" - } - }, - "Identities": { - "target": "com.amazonaws.quicksight#IdentityMap", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight users, groups, or both that the IAM policy is\n\t\t\tassigned to.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateIngestion": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateIngestionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateIngestionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in\n\t\t\tan Enterprise edition account 32 times in a 24-hour period. You can manually refresh\n\t\t\tdatasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period\n\t\t\tis measured starting 24 hours before the current date and time.

\n

Any ingestions operating on tagged datasets inherit the same tags automatically for use in\n\t\t\taccess control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using\n\t\t\t\ttags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateIngestionRequest": { - "type": "structure", - "members": { - "DataSetId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the dataset used in the ingestion.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "IngestionId": { - "target": "com.amazonaws.quicksight#IngestionId", - "traits": { - "smithy.api#documentation": "

An ID for the ingestion.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "IngestionType": { - "target": "com.amazonaws.quicksight#IngestionType", - "traits": { - "smithy.api#documentation": "

The type of ingestion that you want to create.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateIngestionResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the data ingestion.

" - } - }, - "IngestionId": { - "target": "com.amazonaws.quicksight#IngestionId", - "traits": { - "smithy.api#documentation": "

An ID for the ingestion.

" - } - }, - "IngestionStatus": { - "target": "com.amazonaws.quicksight#IngestionStatus", - "traits": { - "smithy.api#documentation": "

The ingestion status.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateNamespace": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateNamespaceRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateNamespaceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.

\n

A namespace allows you to isolate the Amazon QuickSight users and groups that are registered\n for that namespace. Users that access the namespace can share assets only with other\n users or groups in the same namespace. They can't see users and groups in other\n namespaces. You can create a namespace after your Amazon Web Services account is subscribed to\n Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a\n limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with\n Amazon Web Services Support.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateNamespaceRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The name that you want to use to describe the new namespace.

", - "smithy.api#required": {} - } - }, - "IdentityStore": { - "target": "com.amazonaws.quicksight#IdentityStore", - "traits": { - "smithy.api#documentation": "

Specifies the type of your user identity directory. Currently, this supports users\n with an identity type of QUICKSIGHT.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

The tags that you want to associate with the namespace that you're creating.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateNamespaceResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the Amazon QuickSight namespace you created.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The name of the new namespace that you created.

" - } - }, - "CapacityRegion": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region; that you want to use for the free SPICE capacity for the new namespace.\n This is set to the region that you run CreateNamespace in.

" - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#NamespaceStatus", - "traits": { - "smithy.api#documentation": "

The status of the creation of the namespace. This is an asynchronous process. A status\n of CREATED means that your namespace is ready to use. If an error occurs,\n it indicates if the process is retryable or non-retryable. In\n the case of a non-retryable error, refer to the error message for follow-up\n tasks.

" - } - }, - "IdentityStore": { - "target": "com.amazonaws.quicksight#IdentityStore", - "traits": { - "smithy.api#documentation": "

Specifies the type of your user identity directory. Currently, this supports users\n with an identity type of QUICKSIGHT.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateRefreshSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateRefreshScheduleRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateRefreshScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateRefreshScheduleRequest": { - "type": "structure", - "members": { - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Schedule": { - "target": "com.amazonaws.quicksight#RefreshSchedule", - "traits": { - "smithy.api#documentation": "

The refresh schedule.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateRefreshScheduleResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "ScheduleId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the refresh schedule.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the refresh schedule.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateRoleMembership": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateRoleMembershipRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateRoleMembershipResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Use CreateRoleMembership to add an existing Amazon QuickSight group to an existing role.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members/{MemberName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateRoleMembershipRequest": { - "type": "structure", - "members": { - "MemberName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

The name of the group that you want to add to the role.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that the role belongs to.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Role": { - "target": "com.amazonaws.quicksight#Role", - "traits": { - "smithy.api#documentation": "

The role that you want to add a group to.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateRoleMembershipResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateTemplateRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template. You can use the resulting\n\t\t\ttemplate to create additional dashboards, templates, or analyses.

\n

A template is an entity in Amazon QuickSight that encapsulates the metadata\n\t\t\trequired to create an analysis and that you can use to create s dashboard. A template adds\n\t\t\ta layer of abstraction by using placeholders to replace the dataset associated with the\n\t\t\tanalysis. You can use templates to create dashboards by replacing dataset placeholders\n\t\t\twith datasets that follow the same schema that was used to create the source analysis\n\t\t\tand template.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateTemplateAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateTemplateAliasRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateTemplateAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a template alias for a template.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateTemplateAliasRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template that you creating an alias for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The name that you want to give to the template alias that you're creating. Don't start the\n\t\t\talias name with the $ character. Alias names that start with $\n\t\t\tare reserved by Amazon QuickSight.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the template.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateTemplateAliasResponse": { - "type": "structure", - "members": { - "TemplateAlias": { - "target": "com.amazonaws.quicksight#TemplateAlias", - "traits": { - "smithy.api#documentation": "

Information about the template alias.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateTemplateRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in\n\t\t\teach Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#TemplateName", - "traits": { - "smithy.api#documentation": "

A display name for the template.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions to be set on the template.

" - } - }, - "SourceEntity": { - "target": "com.amazonaws.quicksight#TemplateSourceEntity", - "traits": { - "smithy.api#documentation": "

The entity that you are using as a source when you create the template. In\n\t\t\tSourceEntity, you specify the type of object you're using as source:\n\t\t\tSourceTemplate for a template or SourceAnalysis for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate, specify the ARN of the source template. For\n\t\t\tSourceAnalysis, specify the ARN of the source analysis. The SourceTemplate\n\t\t\tARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

\n

Use the DataSetReferences entity within SourceTemplate or\n\t\t\tSourceAnalysis to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.

\n

Either a SourceEntity or a Definition must be provided in \n\t\t\torder for the request to be valid.

" - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

" - } - }, - "VersionDescription": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

A description of the current template version being created. This API operation creates the\n\t\t\tfirst version of the template. Every time UpdateTemplate is called, a new\n\t\t\tversion is created. Each version of the template maintains a description of the version\n\t\t\tin the VersionDescription field.

" - } - }, - "Definition": { - "target": "com.amazonaws.quicksight#TemplateVersionDefinition", - "traits": { - "smithy.api#documentation": "

The definition of a template.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

\n

Either a SourceEntity or a Definition must be provided in \n\t\t\torder for the request to be valid.

" - } - }, - "ValidationStrategy": { - "target": "com.amazonaws.quicksight#ValidationStrategy", - "traits": { - "smithy.api#documentation": "

TThe option to relax the validation needed to create a template with definition objects. This skips the validation step for specific errors.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateTemplateResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the template.

" - } - }, - "VersionArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the template, including the version information of\n\t\t\tthe first version.

" - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the template.

" - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The template creation status.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateTheme": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateThemeRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateThemeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a theme.

\n

A theme is set of configuration options for color and layout.\n\t\t\tThemes apply to analyses and dashboards. For more information, see Using\n\t\t\tThemes in Amazon QuickSight in the Amazon QuickSight User Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateThemeAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateThemeAliasRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateThemeAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a theme alias for a theme.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateThemeAliasRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme for the new theme alias.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the theme alias.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The name that you want to give to the theme alias that you are creating. The\n\t\t\talias name can't begin with a $. Alias names that start with $\n\t\t\tare reserved by Amazon QuickSight.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the theme.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateThemeAliasResponse": { - "type": "structure", - "members": { - "ThemeAlias": { - "target": "com.amazonaws.quicksight#ThemeAlias", - "traits": { - "smithy.api#documentation": "

Information about the theme alias.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateThemeRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account where you want to store the new theme.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in\n\t\t\teach Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ThemeName", - "traits": { - "smithy.api#documentation": "

A display name for the theme.

", - "smithy.api#required": {} - } - }, - "BaseThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the theme that a custom theme will inherit from. All themes inherit from one of\n\t\t\tthe starting themes defined by Amazon QuickSight. For a list of the starting themes, use\n\t\t\t\tListThemes or choose Themes from\n\t\t\twithin an analysis.

", - "smithy.api#required": {} - } - }, - "VersionDescription": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

A description of the first version of the theme that you're creating. Every time\n\t\t\t\tUpdateTheme is called, a new version is created. Each version of the\n\t\t\ttheme has a description of the version in the VersionDescription\n\t\t\tfield.

" - } - }, - "Configuration": { - "target": "com.amazonaws.quicksight#ThemeConfiguration", - "traits": { - "smithy.api#documentation": "

The theme configuration, which contains the theme display properties.

", - "smithy.api#required": {} - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A valid grouping of resource permissions to apply to the new theme.\n\t\t\t

" - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

A map of the key-value pairs for the resource tag or tags that you want to add to the\n\t\t\tresource.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateThemeResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the theme.

" - } - }, - "VersionArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the new theme.

" - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the theme.

" - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The theme creation status.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateTopic": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateTopicRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateTopicResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new Q topic.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/topics", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateTopicRefreshSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateTopicRefreshScheduleRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateTopicRefreshScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a topic refresh schedule.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateTopicRefreshScheduleRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic\n you're creating a refresh schedule for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DatasetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

", - "smithy.api#required": {} - } - }, - "DatasetName": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of the dataset.

" - } - }, - "RefreshSchedule": { - "target": "com.amazonaws.quicksight#TopicRefreshSchedule", - "traits": { - "smithy.api#documentation": "

The definition of a refresh schedule.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateTopicRefreshScheduleResponse": { - "type": "structure", - "members": { - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "TopicArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "DatasetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateTopicRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that you want to create a topic in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#required": {} - } - }, - "Topic": { - "target": "com.amazonaws.quicksight#TopicDetails", - "traits": { - "smithy.api#documentation": "

The definition of a topic to create.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags that are assigned to\n the dataset.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateTopicResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region\n for each Amazon Web Services account.

" - } - }, - "RefreshArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic refresh.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateTopicReviewedAnswer": { - "type": "structure", - "members": { - "AnswerId": { - "target": "com.amazonaws.quicksight#AnswerId", - "traits": { - "smithy.api#documentation": "

The answer ID for the CreateTopicReviewedAnswer.

", - "smithy.api#required": {} - } - }, - "DatasetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Dataset arn for the CreateTopicReviewedAnswer.

", - "smithy.api#required": {} - } - }, - "Question": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The Question to be created.

", - "smithy.api#required": {} - } - }, - "Mir": { - "target": "com.amazonaws.quicksight#TopicIR", - "traits": { - "smithy.api#documentation": "

The Mir for the CreateTopicReviewedAnswer.

" - } - }, - "PrimaryVisual": { - "target": "com.amazonaws.quicksight#TopicVisual", - "traits": { - "smithy.api#documentation": "

The PrimaryVisual for the CreateTopicReviewedAnswer.

" - } - }, - "Template": { - "target": "com.amazonaws.quicksight#TopicTemplate", - "traits": { - "smithy.api#documentation": "

The template for the CreateTopicReviewedAnswer.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a CreateTopicReviewedAnswer.

" - } - }, - "com.amazonaws.quicksight#CreateTopicReviewedAnswers": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#CreateTopicReviewedAnswer" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#CreateVPCConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateVPCConnectionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateVPCConnectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new VPC connection.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/vpc-connections", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateVPCConnectionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the account where you want to create a new VPC\n\t\t\tconnection.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VPCConnectionId": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceIdRestricted", - "traits": { - "smithy.api#documentation": "

The ID of the VPC connection that\n\t\t\tyou're creating. This ID is a unique identifier for each Amazon Web Services Region in an\n\t\t\t\tAmazon Web Services account.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

The display name for the VPC connection.

", - "smithy.api#required": {} - } - }, - "SubnetIds": { - "target": "com.amazonaws.quicksight#SubnetIdList", - "traits": { - "smithy.api#documentation": "

A list of subnet IDs for the VPC connection.

", - "smithy.api#required": {} - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.quicksight#SecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of security group IDs for the VPC connection.

", - "smithy.api#required": {} - } - }, - "DnsResolvers": { - "target": "com.amazonaws.quicksight#DnsResolverList", - "traits": { - "smithy.api#documentation": "

A list of IP addresses of DNS resolver endpoints for the VPC connection.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.quicksight#RoleArn", - "traits": { - "smithy.api#documentation": "

The IAM role to associate with the VPC connection.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

A map of the key-value pairs for the resource tag or tags assigned to the VPC\n\t\t\tconnection.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateVPCConnectionResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC connection.

" - } - }, - "VPCConnectionId": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceIdRestricted", - "traits": { - "smithy.api#documentation": "

The ID for the VPC connection that\n\t\t\tyou're creating. This ID is unique per Amazon Web Services Region for each Amazon Web Services\n\t\t\taccount.

" - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", - "traits": { - "smithy.api#documentation": "

The status of the creation of the VPC connection.

" - } - }, - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", - "traits": { - "smithy.api#documentation": "

The availability status of the VPC connection.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CredentialPair": { - "type": "structure", - "members": { - "Username": { - "target": "com.amazonaws.quicksight#DbUsername", - "traits": { - "smithy.api#documentation": "

User name.

", - "smithy.api#required": {} - } - }, - "Password": { - "target": "com.amazonaws.quicksight#Password", - "traits": { - "smithy.api#documentation": "

Password.

", - "smithy.api#required": {} - } - }, - "AlternateDataSourceParameters": { - "target": "com.amazonaws.quicksight#DataSourceParametersList", - "traits": { - "smithy.api#documentation": "

A set of alternate data source parameters that you want to share for these\n credentials. The credentials are applied in tandem with the data source parameters when\n you copy a data source by using a create or update request. The API operation compares\n the DataSourceParameters structure that's in the request with the\n structures in the AlternateDataSourceParameters allow list. If the\n structures are an exact match, the request is allowed to use the new data source with\n the existing credentials. If the AlternateDataSourceParameters list is\n null, the DataSourceParameters originally used with these\n Credentials is automatically allowed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The combination of user name and password that are used as credentials.

" - } - }, - "com.amazonaws.quicksight#CrossDatasetTypes": { - "type": "enum", - "members": { - "ALL_DATASETS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL_DATASETS" - } - }, - "SINGLE_DATASET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SINGLE_DATASET" - } - } - } - }, - "com.amazonaws.quicksight#CurrencyCode": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[A-Z]{3}$" - } - }, - "com.amazonaws.quicksight#CurrencyDisplayFormatConfiguration": { - "type": "structure", - "members": { - "Prefix": { - "target": "com.amazonaws.quicksight#Prefix", - "traits": { - "smithy.api#documentation": "

Determines the prefix value of the currency format.

" - } - }, - "Suffix": { - "target": "com.amazonaws.quicksight#Suffix", - "traits": { - "smithy.api#documentation": "

Determines the suffix value of the currency format.

" - } - }, - "SeparatorConfiguration": { - "target": "com.amazonaws.quicksight#NumericSeparatorConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the numeric separator configuration.

" - } - }, - "Symbol": { - "target": "com.amazonaws.quicksight#CurrencyCode", - "traits": { - "smithy.api#documentation": "

Determines the symbol for the currency format.

" - } - }, - "DecimalPlacesConfiguration": { - "target": "com.amazonaws.quicksight#DecimalPlacesConfiguration", - "traits": { - "smithy.api#documentation": "

The option that determines the decimal places configuration.

" - } - }, - "NumberScale": { - "target": "com.amazonaws.quicksight#NumberScale", - "traits": { - "smithy.api#documentation": "

Determines the number scale value for the currency format.

" - } - }, - "NegativeValueConfiguration": { - "target": "com.amazonaws.quicksight#NegativeValueConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the negative value configuration.

" - } - }, - "NullValueFormatConfiguration": { - "target": "com.amazonaws.quicksight#NullValueFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the null value format configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the currency display format configuration.

" - } - }, - "com.amazonaws.quicksight#CustomActionColumnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnIdentifier" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#CustomActionFilterOperation": { - "type": "structure", - "members": { - "SelectedFieldsConfiguration": { - "target": "com.amazonaws.quicksight#FilterOperationSelectedFieldsConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration that chooses the fields to be filtered.

", - "smithy.api#required": {} - } - }, - "TargetVisualsConfiguration": { - "target": "com.amazonaws.quicksight#FilterOperationTargetVisualsConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration that chooses the target visuals to be filtered.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The filter operation that filters data included in a visual or in an entire sheet.

" - } - }, - "com.amazonaws.quicksight#CustomActionNavigationOperation": { - "type": "structure", - "members": { - "LocalNavigationConfiguration": { - "target": "com.amazonaws.quicksight#LocalNavigationConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration that chooses the navigation target.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The navigation operation that navigates between different sheets in the same analysis.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#CustomActionSetParametersOperation": { - "type": "structure", - "members": { - "ParameterValueConfigurations": { - "target": "com.amazonaws.quicksight#SetParameterValueConfigurationList", - "traits": { - "smithy.api#documentation": "

The parameter that determines the value configuration.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The set parameter operation that sets parameters in custom action.

" - } - }, - "com.amazonaws.quicksight#CustomActionURLOperation": { - "type": "structure", - "members": { - "URLTemplate": { - "target": "com.amazonaws.quicksight#URLOperationTemplate", - "traits": { - "smithy.api#documentation": "

THe URL link of the CustomActionURLOperation.

", - "smithy.api#required": {} - } - }, - "URLTarget": { - "target": "com.amazonaws.quicksight#URLTargetConfiguration", - "traits": { - "smithy.api#documentation": "

The target of the CustomActionURLOperation.

\n

Valid values are defined as follows:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The URL operation that opens a link to another webpage.

" - } - }, - "com.amazonaws.quicksight#CustomColor": { - "type": "structure", - "members": { - "FieldValue": { - "target": "com.amazonaws.quicksight#FieldValue", - "traits": { - "smithy.api#documentation": "

The data value that the color is applied to.

" - } - }, - "Color": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color that is applied to the data value.

", - "smithy.api#required": {} - } - }, - "SpecialValue": { - "target": "com.amazonaws.quicksight#SpecialValue", - "traits": { - "smithy.api#documentation": "

The value of a special data value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines the color that's applied to a particular data value in a column.

" - } - }, - "com.amazonaws.quicksight#CustomColorsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#CustomColor" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#CustomContentConfiguration": { - "type": "structure", - "members": { - "ContentUrl": { - "target": "com.amazonaws.quicksight#URLOperationTemplate", - "traits": { - "smithy.api#documentation": "

The input URL that links to the custom content that you want in the custom visual.

" - } - }, - "ContentType": { - "target": "com.amazonaws.quicksight#CustomContentType", - "traits": { - "smithy.api#documentation": "

The content type of the custom content visual. You can use this to have the visual render as an image.

" - } - }, - "ImageScaling": { - "target": "com.amazonaws.quicksight#CustomContentImageScalingConfiguration", - "traits": { - "smithy.api#documentation": "

The sizing options for the size of the custom content visual. This structure is required when the ContentType of the visual is 'IMAGE'.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a CustomContentVisual.

" - } - }, - "com.amazonaws.quicksight#CustomContentImageScalingConfiguration": { - "type": "enum", - "members": { - "FIT_TO_HEIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIT_TO_HEIGHT" - } - }, - "FIT_TO_WIDTH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIT_TO_WIDTH" - } - }, - "DO_NOT_SCALE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DO_NOT_SCALE" - } - }, - "SCALE_TO_VISUAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCALE_TO_VISUAL" - } - } - } - }, - "com.amazonaws.quicksight#CustomContentType": { - "type": "enum", - "members": { - "IMAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMAGE" - } - }, - "OTHER_EMBEDDED_CONTENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OTHER_EMBEDDED_CONTENT" - } - } - } - }, - "com.amazonaws.quicksight#CustomContentVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#CustomContentConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of a CustomContentVisual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "DataSetIdentifier": { - "target": "com.amazonaws.quicksight#DataSetIdentifier", - "traits": { - "smithy.api#documentation": "

The dataset that is used to create the custom content visual. You can't create a visual without a dataset.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A visual that contains custom content.

\n

For more information, see Using custom visual content in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#CustomFilterConfiguration": { - "type": "structure", - "members": { - "MatchOperator": { - "target": "com.amazonaws.quicksight#CategoryFilterMatchOperator", - "traits": { - "smithy.api#documentation": "

The match operator that is used to determine if a filter should be applied.

", - "smithy.api#required": {} - } - }, - "CategoryValue": { - "target": "com.amazonaws.quicksight#CategoryValue", - "traits": { - "smithy.api#documentation": "

The category value for the filter.

\n

This field is mutually exclusive to ParameterName.

" - } - }, - "SelectAllOptions": { - "target": "com.amazonaws.quicksight#CategoryFilterSelectAllOptions", - "traits": { - "smithy.api#documentation": "

Select all of the values. Null is not the assigned value of select all.

\n " - } - }, - "ParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The parameter whose value should be used for the filter value.

\n

This field is mutually exclusive to CategoryValue.

" - } - }, - "NullOption": { - "target": "com.amazonaws.quicksight#FilterNullOption", - "traits": { - "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A custom filter that filters based on a single value. This filter can be partially matched.

" - } - }, - "com.amazonaws.quicksight#CustomFilterListConfiguration": { - "type": "structure", - "members": { - "MatchOperator": { - "target": "com.amazonaws.quicksight#CategoryFilterMatchOperator", - "traits": { - "smithy.api#documentation": "

The match operator that is used to determine if a filter should be applied.

", - "smithy.api#required": {} - } - }, - "CategoryValues": { - "target": "com.amazonaws.quicksight#CategoryValueList", - "traits": { - "smithy.api#documentation": "

The list of category values for the filter.

" - } - }, - "SelectAllOptions": { - "target": "com.amazonaws.quicksight#CategoryFilterSelectAllOptions", - "traits": { - "smithy.api#documentation": "

Select all of the values. Null is not the assigned value of select all.

\n " - } - }, - "NullOption": { - "target": "com.amazonaws.quicksight#FilterNullOption", - "traits": { - "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A list of custom filter values.

" - } - }, - "com.amazonaws.quicksight#CustomLabel": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#CustomNarrativeOptions": { - "type": "structure", - "members": { - "Narrative": { - "target": "com.amazonaws.quicksight#NarrativeString", - "traits": { - "smithy.api#documentation": "

The string input of custom narrative.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The custom narrative options.

" - } - }, - "com.amazonaws.quicksight#CustomParameterValues": { - "type": "structure", - "members": { - "StringValues": { - "target": "com.amazonaws.quicksight#StringDefaultValueList", - "traits": { - "smithy.api#documentation": "

A list of string-type parameter values.

" - } - }, - "IntegerValues": { - "target": "com.amazonaws.quicksight#IntegerDefaultValueList", - "traits": { - "smithy.api#documentation": "

A list of integer-type parameter values.

" - } - }, - "DecimalValues": { - "target": "com.amazonaws.quicksight#DecimalDefaultValueList", - "traits": { - "smithy.api#documentation": "

A list of decimal-type parameter values.

" - } - }, - "DateTimeValues": { - "target": "com.amazonaws.quicksight#DateTimeDefaultValueList", - "traits": { - "smithy.api#documentation": "

A list of datetime-type parameter values.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The customized parameter values.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#CustomSql": { - "type": "structure", - "members": { - "DataSourceArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#CustomSqlName", - "traits": { - "smithy.api#documentation": "

A display name for the SQL query result.

", - "smithy.api#required": {} - } - }, - "SqlQuery": { - "target": "com.amazonaws.quicksight#SqlQuery", - "traits": { - "smithy.api#documentation": "

The SQL query.

", - "smithy.api#required": {} - } - }, - "Columns": { - "target": "com.amazonaws.quicksight#InputColumnList", - "traits": { - "smithy.api#documentation": "

The column schema from the SQL query result set.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A physical table type built from the results of the custom SQL query.

" - } - }, - "com.amazonaws.quicksight#CustomSqlName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#CustomValuesConfiguration": { - "type": "structure", - "members": { - "IncludeNullValue": { - "target": "com.amazonaws.quicksight#BooleanObject", - "traits": { - "smithy.api#documentation": "

Includes the null value in custom action parameter values.

" - } - }, - "CustomValues": { - "target": "com.amazonaws.quicksight#CustomParameterValues", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of custom values for the destination parameter in DestinationParameterValueConfiguration.

" - } - }, - "com.amazonaws.quicksight#CustomerManagedKeyUnavailableException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The customer managed key that is registered to your Amazon QuickSight account is unavailable.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.quicksight#Dashboard": { - "type": "structure", - "members": { - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

Dashboard ID.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DashboardName", - "traits": { - "smithy.api#documentation": "

A display name for the dashboard.

" - } - }, - "Version": { - "target": "com.amazonaws.quicksight#DashboardVersion", - "traits": { - "smithy.api#documentation": "

Version.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that this dashboard was created.

" - } - }, - "LastPublishedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that this dashboard was published.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that this dashboard was updated.

" - } - }, - "LinkEntities": { - "target": "com.amazonaws.quicksight#LinkEntityArnList", - "traits": { - "smithy.api#documentation": "

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Dashboard.

" - } - }, - "com.amazonaws.quicksight#DashboardBehavior": { - "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.quicksight#DashboardError": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.quicksight#DashboardErrorType", - "traits": { - "smithy.api#documentation": "

Type.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Message.

" - } - }, - "ViolatedEntities": { - "target": "com.amazonaws.quicksight#EntityList", - "traits": { - "smithy.api#documentation": "

Lists the violated entities that caused the dashboard error.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Dashboard error.

" - } - }, - "com.amazonaws.quicksight#DashboardErrorList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DashboardError" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.quicksight#DashboardErrorType": { - "type": "enum", - "members": { - "ACCESS_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCESS_DENIED" - } - }, - "SOURCE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOURCE_NOT_FOUND" - } - }, - "DATA_SET_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_SET_NOT_FOUND" - } - }, - "INTERNAL_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_FAILURE" - } - }, - "PARAMETER_VALUE_INCOMPATIBLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARAMETER_VALUE_INCOMPATIBLE" - } - }, - "PARAMETER_TYPE_INVALID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARAMETER_TYPE_INVALID" - } - }, - "PARAMETER_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARAMETER_NOT_FOUND" - } - }, - "COLUMN_TYPE_MISMATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLUMN_TYPE_MISMATCH" - } - }, - "COLUMN_GEOGRAPHIC_ROLE_MISMATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLUMN_GEOGRAPHIC_ROLE_MISMATCH" - } - }, - "COLUMN_REPLACEMENT_MISSING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLUMN_REPLACEMENT_MISSING" - } - } - } - }, - "com.amazonaws.quicksight#DashboardFilterAttribute": { - "type": "enum", - "members": { - "QUICKSIGHT_USER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT_USER" - } - }, - "QUICKSIGHT_VIEWER_OR_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT_VIEWER_OR_OWNER" - } - }, - "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" - } - }, - "QUICKSIGHT_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT_OWNER" - } - }, - "DIRECT_QUICKSIGHT_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_OWNER" - } - }, - "DIRECT_QUICKSIGHT_SOLE_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_SOLE_OWNER" - } - }, - "DASHBOARD_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DASHBOARD_NAME" - } - } - } - }, - "com.amazonaws.quicksight#DashboardName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#DashboardPublishOptions": { - "type": "structure", - "members": { - "AdHocFilteringOption": { - "target": "com.amazonaws.quicksight#AdHocFilteringOption", - "traits": { - "smithy.api#documentation": "

Ad hoc (one-time) filtering option.

" - } - }, - "ExportToCSVOption": { - "target": "com.amazonaws.quicksight#ExportToCSVOption", - "traits": { - "smithy.api#documentation": "

Export to .csv option.

" - } - }, - "SheetControlsOption": { - "target": "com.amazonaws.quicksight#SheetControlsOption", - "traits": { - "smithy.api#documentation": "

Sheet controls option.

" - } - }, - "VisualPublishOptions": { - "target": "com.amazonaws.quicksight#DashboardVisualPublishOptions", - "traits": { - "smithy.api#deprecated": { - "message": "VisualPublishOptions property will reach its end of standard support in a future release. To perform this action, use ExportWithHiddenFields." - }, - "smithy.api#documentation": "

The visual publish options of a visual in a dashboard.

" - } - }, - "SheetLayoutElementMaximizationOption": { - "target": "com.amazonaws.quicksight#SheetLayoutElementMaximizationOption", - "traits": { - "smithy.api#documentation": "

The sheet layout maximization options of a dashbaord.

" - } - }, - "VisualMenuOption": { - "target": "com.amazonaws.quicksight#VisualMenuOption", - "traits": { - "smithy.api#documentation": "

The menu options of a visual in a dashboard.

" - } - }, - "VisualAxisSortOption": { - "target": "com.amazonaws.quicksight#VisualAxisSortOption", - "traits": { - "smithy.api#documentation": "

The axis sort options of a dashboard.

" - } - }, - "ExportWithHiddenFieldsOption": { - "target": "com.amazonaws.quicksight#ExportWithHiddenFieldsOption", - "traits": { - "smithy.api#documentation": "

Determines if hidden fields are exported with a dashboard.

" - } - }, - "DataPointDrillUpDownOption": { - "target": "com.amazonaws.quicksight#DataPointDrillUpDownOption", - "traits": { - "smithy.api#documentation": "

The drill-down options of data points in a dashboard.

" - } - }, - "DataPointMenuLabelOption": { - "target": "com.amazonaws.quicksight#DataPointMenuLabelOption", - "traits": { - "smithy.api#documentation": "

The data point menu label options of a dashboard.

" - } - }, - "DataPointTooltipOption": { - "target": "com.amazonaws.quicksight#DataPointTooltipOption", - "traits": { - "smithy.api#documentation": "

The data point tool tip options of a dashboard.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Dashboard publish options.

" - } - }, - "com.amazonaws.quicksight#DashboardSearchFilter": { - "type": "structure", - "members": { - "Operator": { - "target": "com.amazonaws.quicksight#FilterOperator", - "traits": { - "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\": \"StringEquals\". Valid values are \"StringEquals\" and \"StringLike\".

\n

If you set the operator value to \"StringEquals\", you need to provide an ownership related filter in the \"NAME\" field and the arn of the user or group whose folders you want to search in the \"Value\" field. For example, \"Name\":\"DIRECT_QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

\n

If you set the value to \"StringLike\", you need to provide the name of the folders you are searching for. For example, \"Name\":\"DASHBOARD_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\". The \"StringLike\" operator only supports the NAME value DASHBOARD_NAME.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DashboardFilterAttribute", - "traits": { - "smithy.api#documentation": "

The name of the value that you want to use as a filter, for example, \"Name\":\n \"QUICKSIGHT_OWNER\".

\n

Valid values are defined as follows:

\n " - } - }, - "Value": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The value of the named item, in this case QUICKSIGHT_USER, that you want\n to use as a filter, for example, \"Value\":\n \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A filter that you apply when searching for dashboards.

" - } - }, - "com.amazonaws.quicksight#DashboardSearchFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DashboardSearchFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#DashboardSourceEntity": { - "type": "structure", - "members": { - "SourceTemplate": { - "target": "com.amazonaws.quicksight#DashboardSourceTemplate", - "traits": { - "smithy.api#documentation": "

Source template.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Dashboard source entity.

" - } - }, - "com.amazonaws.quicksight#DashboardSourceTemplate": { - "type": "structure", - "members": { - "DataSetReferences": { - "target": "com.amazonaws.quicksight#DataSetReferenceList", - "traits": { - "smithy.api#documentation": "

Dataset references.

", - "smithy.api#required": {} - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Dashboard source template.

" - } - }, - "com.amazonaws.quicksight#DashboardSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

Dashboard ID.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DashboardName", - "traits": { - "smithy.api#documentation": "

A display name for the dashboard.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that this dashboard was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that this dashboard was updated.

" - } - }, - "PublishedVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

Published version number.

" - } - }, - "LastPublishedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that this dashboard was published.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Dashboard summary.

" - } - }, - "com.amazonaws.quicksight#DashboardSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DashboardSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#DashboardUIState": { - "type": "enum", - "members": { - "EXPANDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXPANDED" - } - }, - "COLLAPSED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLLAPSED" - } - } - } - }, - "com.amazonaws.quicksight#DashboardVersion": { - "type": "structure", - "members": { - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that this dashboard version was created.

" - } - }, - "Errors": { - "target": "com.amazonaws.quicksight#DashboardErrorList", - "traits": { - "smithy.api#documentation": "

Errors associated with this dashboard version.

" - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

Version number for this version of the dashboard.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The HTTP status of the request.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - }, - "SourceEntityArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

Source entity ARN.

" - } - }, - "DataSetArns": { - "target": "com.amazonaws.quicksight#DataSetArnsList", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Numbers (ARNs) for the datasets that are associated with this\n version of the dashboard.

" - } - }, - "Description": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

Description.

" - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the theme associated with a version of the dashboard.

" - } - }, - "Sheets": { - "target": "com.amazonaws.quicksight#SheetList", - "traits": { - "smithy.api#documentation": "

A list of the associated sheets with the unique identifier and name of each sheet.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Dashboard version.

" - } - }, - "com.amazonaws.quicksight#DashboardVersionDefinition": { - "type": "structure", - "members": { - "DataSetIdentifierDeclarations": { - "target": "com.amazonaws.quicksight#DataSetIdentifierDeclarationList", - "traits": { - "smithy.api#documentation": "

An array of dataset identifier declarations. With\n this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.

", - "smithy.api#required": {} - } - }, - "Sheets": { - "target": "com.amazonaws.quicksight#SheetDefinitionList", - "traits": { - "smithy.api#documentation": "

An array of sheet definitions for a dashboard.

" - } - }, - "CalculatedFields": { - "target": "com.amazonaws.quicksight#CalculatedFields", - "traits": { - "smithy.api#documentation": "

An array of calculated field definitions for the dashboard.

" - } - }, - "ParameterDeclarations": { - "target": "com.amazonaws.quicksight#ParameterDeclarationList", - "traits": { - "smithy.api#documentation": "

The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.

\n

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

" - } - }, - "FilterGroups": { - "target": "com.amazonaws.quicksight#FilterGroupList", - "traits": { - "smithy.api#documentation": "

The filter definitions for a dashboard.

\n

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.

" - } - }, - "ColumnConfigurations": { - "target": "com.amazonaws.quicksight#ColumnConfigurationList", - "traits": { - "smithy.api#documentation": "

An array of dashboard-level column configurations. Column configurations\n are used to set the default formatting for a column that\n is used throughout a dashboard.

" - } - }, - "AnalysisDefaults": { - "target": "com.amazonaws.quicksight#AnalysisDefaults" - }, - "Options": { - "target": "com.amazonaws.quicksight#AssetOptions", - "traits": { - "smithy.api#documentation": "

An array of option definitions for a dashboard.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The contents of a dashboard.

" - } - }, - "com.amazonaws.quicksight#DashboardVersionSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that this dashboard version was created.

" - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

Version number.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The HTTP status of the request.

" - } - }, - "SourceEntityArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

Source entity ARN.

" - } - }, - "Description": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

Description.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Dashboard version summary.

" - } - }, - "com.amazonaws.quicksight#DashboardVersionSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DashboardVersionSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#DashboardVisualId": { - "type": "structure", - "members": { - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

", - "smithy.api#required": {} - } - }, - "SheetId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.

", - "smithy.api#required": {} - } - }, - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains the following elements:

\n \n

The DashboardId, SheetId, and VisualId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

" - } - }, - "com.amazonaws.quicksight#DashboardVisualPublishOptions": { - "type": "structure", - "members": { - "ExportHiddenFieldsOption": { - "target": "com.amazonaws.quicksight#ExportHiddenFieldsOption", - "traits": { - "smithy.api#documentation": "

Determines if hidden fields are included in an exported dashboard.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The visual publish options of a visual in a dashboard

" - } - }, - "com.amazonaws.quicksight#DataAggregation": { - "type": "structure", - "members": { - "DatasetRowDateGranularity": { - "target": "com.amazonaws.quicksight#TopicTimeGranularity", - "traits": { - "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" - } - }, - "DefaultDateColumnName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The column name for the default date.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a data aggregation.

" - } - }, - "com.amazonaws.quicksight#DataBarsOptions": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID for the data bars options.

", - "smithy.api#required": {} - } - }, - "PositiveColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color of the positive data bar.

" - } - }, - "NegativeColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color of the negative data bar.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options for data bars.

" - } - }, - "com.amazonaws.quicksight#DataColor": { - "type": "structure", - "members": { - "Color": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color that is applied to the data value.

" - } - }, - "DataValue": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The data value that the color is applied to.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines the color that is applied to a particular data value.

" - } - }, - "com.amazonaws.quicksight#DataColorPalette": { - "type": "structure", - "members": { - "Colors": { - "target": "com.amazonaws.quicksight#ColorList", - "traits": { - "smithy.api#documentation": "

The hexadecimal codes for the colors.

" - } - }, - "MinMaxGradient": { - "target": "com.amazonaws.quicksight#ColorList", - "traits": { - "smithy.api#documentation": "

The minimum and maximum hexadecimal codes that describe a color gradient.

" - } - }, - "EmptyFillColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The hexadecimal code of a color that applies to charts where a lack of data is\n highlighted.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The theme colors that are used for data colors in charts. The colors description is a\n hexadecimal color code that consists of six alphanumerical characters, prefixed with\n #, for example #37BFF5.

" - } - }, - "com.amazonaws.quicksight#DataFieldSeriesItem": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID of the field that you are setting the axis binding to.

", - "smithy.api#required": {} - } - }, - "FieldValue": { - "target": "com.amazonaws.quicksight#SensitiveString", - "traits": { - "smithy.api#documentation": "

The field value of the field that you are setting the axis binding to.

" - } - }, - "AxisBinding": { - "target": "com.amazonaws.quicksight#AxisBinding", - "traits": { - "smithy.api#documentation": "

The axis that you are binding the field to.

", - "smithy.api#required": {} - } - }, - "Settings": { - "target": "com.amazonaws.quicksight#LineChartSeriesSettings", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of line series associated to the field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The data field series item configuration of a line chart.

" - } - }, - "com.amazonaws.quicksight#DataLabelContent": { - "type": "enum", - "members": { - "VALUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VALUE" - } - }, - "PERCENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENT" - } - }, - "VALUE_AND_PERCENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VALUE_AND_PERCENT" - } - } - } - }, - "com.amazonaws.quicksight#DataLabelOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines the visibility of the data labels.

" - } - }, - "CategoryLabelVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines the visibility of the category field labels.

" - } - }, - "MeasureLabelVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines the visibility of the measure field labels.

" - } - }, - "DataLabelTypes": { - "target": "com.amazonaws.quicksight#DataLabelTypes", - "traits": { - "smithy.api#documentation": "

The option that determines the data label type.

" - } - }, - "Position": { - "target": "com.amazonaws.quicksight#DataLabelPosition", - "traits": { - "smithy.api#documentation": "

Determines the position of the data labels.

" - } - }, - "LabelContent": { - "target": "com.amazonaws.quicksight#DataLabelContent", - "traits": { - "smithy.api#documentation": "

Determines the content of the data labels.

" - } - }, - "LabelFontConfiguration": { - "target": "com.amazonaws.quicksight#FontConfiguration", - "traits": { - "smithy.api#documentation": "

Determines the font configuration of the data labels.

" - } - }, - "LabelColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

Determines the color of the data labels.

" - } - }, - "Overlap": { - "target": "com.amazonaws.quicksight#DataLabelOverlap", - "traits": { - "smithy.api#documentation": "

Determines whether overlap is enabled or disabled for the data labels.

" - } - }, - "TotalsVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines the visibility of the total.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the data labels.

" - } - }, - "com.amazonaws.quicksight#DataLabelOverlap": { - "type": "enum", - "members": { - "DISABLE_OVERLAP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLE_OVERLAP" - } - }, - "ENABLE_OVERLAP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLE_OVERLAP" - } - } - } - }, - "com.amazonaws.quicksight#DataLabelPosition": { - "type": "enum", - "members": { - "INSIDE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSIDE" - } - }, - "OUTSIDE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OUTSIDE" - } - }, - "LEFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LEFT" - } - }, - "TOP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TOP" - } - }, - "BOTTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOTTOM" - } - }, - "RIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RIGHT" - } - } - } - }, - "com.amazonaws.quicksight#DataLabelType": { - "type": "structure", - "members": { - "FieldLabelType": { - "target": "com.amazonaws.quicksight#FieldLabelType", - "traits": { - "smithy.api#documentation": "

Determines the label configuration for the entire field.

" - } - }, - "DataPathLabelType": { - "target": "com.amazonaws.quicksight#DataPathLabelType", - "traits": { - "smithy.api#documentation": "

The option that specifies individual data values for labels.

" - } - }, - "RangeEndsLabelType": { - "target": "com.amazonaws.quicksight#RangeEndsLabelType", - "traits": { - "smithy.api#documentation": "

Determines the label configuration for range end value in a visual.

" - } - }, - "MinimumLabelType": { - "target": "com.amazonaws.quicksight#MinimumLabelType", - "traits": { - "smithy.api#documentation": "

Determines the label configuration for the minimum value in a visual.

" - } - }, - "MaximumLabelType": { - "target": "com.amazonaws.quicksight#MaximumLabelType", - "traits": { - "smithy.api#documentation": "

Determines the label configuration for the maximum value in a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The option that determines the data label type.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#DataLabelTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataLabelType" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#DataPathColor": { - "type": "structure", - "members": { - "Element": { - "target": "com.amazonaws.quicksight#DataPathValue", - "traits": { - "smithy.api#documentation": "

The element that the color needs to be applied to.

", - "smithy.api#required": {} - } - }, - "Color": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color that needs to be applied to the element.

", - "smithy.api#required": {} - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The time granularity of the field that the color needs to be applied to.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The color map that determines the color options for a particular element.

" - } - }, - "com.amazonaws.quicksight#DataPathColorList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataPathColor" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5000 - } - } - }, - "com.amazonaws.quicksight#DataPathLabelType": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID of the field that the data label needs to be applied to.

" - } - }, - "FieldValue": { - "target": "com.amazonaws.quicksight#FieldValue", - "traits": { - "smithy.api#documentation": "

The actual value of the field that is labeled.

" - } - }, - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the data label.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The option that specifies individual data values for labels.

" - } - }, - "com.amazonaws.quicksight#DataPathSort": { - "type": "structure", - "members": { - "Direction": { - "target": "com.amazonaws.quicksight#SortDirection", - "traits": { - "smithy.api#documentation": "

Determines the sort direction.

", - "smithy.api#required": {} - } - }, - "SortPaths": { - "target": "com.amazonaws.quicksight#DataPathValueList", - "traits": { - "smithy.api#documentation": "

The list of data paths that need to be sorted.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Allows data paths to be sorted by a specific data value.

" - } - }, - "com.amazonaws.quicksight#DataPathType": { - "type": "structure", - "members": { - "PivotTableDataPathType": { - "target": "com.amazonaws.quicksight#PivotTableDataPathType", - "traits": { - "smithy.api#documentation": "

The type of data path value utilized in a pivot table. Choose one of the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The type of the data path value.

" - } - }, - "com.amazonaws.quicksight#DataPathValue": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID of the field that needs to be sorted.

" - } - }, - "FieldValue": { - "target": "com.amazonaws.quicksight#FieldValue", - "traits": { - "smithy.api#documentation": "

The actual value of the field that needs to be sorted.

" - } - }, - "DataPathType": { - "target": "com.amazonaws.quicksight#DataPathType", - "traits": { - "smithy.api#documentation": "

The type configuration of the field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The data path that needs to be sorted.

" - } - }, - "com.amazonaws.quicksight#DataPathValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataPathValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#DataPointDrillUpDownOption": { - "type": "structure", - "members": { - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#DashboardBehavior", - "traits": { - "smithy.api#documentation": "

The status of the drill down options of data points.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The drill down options for data points in a dashbaord.

" - } - }, - "com.amazonaws.quicksight#DataPointMenuLabelOption": { - "type": "structure", - "members": { - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#DashboardBehavior", - "traits": { - "smithy.api#documentation": "

The status of the data point menu options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The data point menu options of a dashboard.

" - } - }, - "com.amazonaws.quicksight#DataPointTooltipOption": { - "type": "structure", - "members": { - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#DashboardBehavior", - "traits": { - "smithy.api#documentation": "

The status of the data point tool tip options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The data point tooltip options.

" - } - }, - "com.amazonaws.quicksight#DataSet": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

A display name for the dataset.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that this dataset was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that this dataset was updated.

" - } - }, - "PhysicalTableMap": { - "target": "com.amazonaws.quicksight#PhysicalTableMap", - "traits": { - "smithy.api#documentation": "

Declares the physical tables that are available in the underlying data sources.

" - } - }, - "LogicalTableMap": { - "target": "com.amazonaws.quicksight#LogicalTableMap", - "traits": { - "smithy.api#documentation": "

Configures the combination and transformation of the data from the physical\n tables.

" - } - }, - "OutputColumns": { - "target": "com.amazonaws.quicksight#OutputColumnList", - "traits": { - "smithy.api#documentation": "

The list of columns after all transforms. These columns are available in templates,\n analyses, and dashboards.

" - } - }, - "ImportMode": { - "target": "com.amazonaws.quicksight#DataSetImportMode", - "traits": { - "smithy.api#documentation": "

A value that indicates whether you want to import the data into SPICE.

" - } - }, - "ConsumedSpiceCapacityInBytes": { - "target": "com.amazonaws.quicksight#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't\n imported into SPICE.

" - } - }, - "ColumnGroups": { - "target": "com.amazonaws.quicksight#ColumnGroupList", - "traits": { - "smithy.api#documentation": "

Groupings of columns that work together in certain Amazon QuickSight features.\n Currently, only geospatial hierarchy is supported.

" - } - }, - "FieldFolders": { - "target": "com.amazonaws.quicksight#FieldFolderMap", - "traits": { - "smithy.api#documentation": "

The folder that contains fields and nested subfolders for your dataset.

" - } - }, - "RowLevelPermissionDataSet": { - "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", - "traits": { - "smithy.api#documentation": "

The row-level security configuration for the dataset.

" - } - }, - "RowLevelPermissionTagConfiguration": { - "target": "com.amazonaws.quicksight#RowLevelPermissionTagConfiguration", - "traits": { - "smithy.api#documentation": "

The element you can use to define tags for row-level security.

" - } - }, - "ColumnLevelPermissionRules": { - "target": "com.amazonaws.quicksight#ColumnLevelPermissionRuleList", - "traits": { - "smithy.api#documentation": "

A set of one or more definitions of a \n ColumnLevelPermissionRule\n .

" - } - }, - "DataSetUsageConfiguration": { - "target": "com.amazonaws.quicksight#DataSetUsageConfiguration", - "traits": { - "smithy.api#documentation": "

The usage configuration to apply to child datasets that reference this dataset as a source.

" - } - }, - "DatasetParameters": { - "target": "com.amazonaws.quicksight#DatasetParameterList", - "traits": { - "smithy.api#documentation": "

The parameters that are declared in a dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Dataset.

" - } - }, - "com.amazonaws.quicksight#DataSetArnsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Arn" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#DataSetConfiguration": { - "type": "structure", - "members": { - "Placeholder": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

Placeholder.

" - } - }, - "DataSetSchema": { - "target": "com.amazonaws.quicksight#DataSetSchema", - "traits": { - "smithy.api#documentation": "

Dataset schema.

" - } - }, - "ColumnGroupSchemaList": { - "target": "com.amazonaws.quicksight#ColumnGroupSchemaList", - "traits": { - "smithy.api#documentation": "

A structure containing the list of column group schemas.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Dataset configuration.

" - } - }, - "com.amazonaws.quicksight#DataSetConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataSetConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 30 - } - } - }, - "com.amazonaws.quicksight#DataSetFilterAttribute": { - "type": "enum", - "members": { - "QUICKSIGHT_VIEWER_OR_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT_VIEWER_OR_OWNER" - } - }, - "QUICKSIGHT_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT_OWNER" - } - }, - "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" - } - }, - "DIRECT_QUICKSIGHT_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_OWNER" - } - }, - "DIRECT_QUICKSIGHT_SOLE_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_SOLE_OWNER" - } - }, - "DATASET_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATASET_NAME" - } - } - } - }, - "com.amazonaws.quicksight#DataSetIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#DataSetIdentifierDeclaration": { - "type": "structure", - "members": { - "Identifier": { - "target": "com.amazonaws.quicksight#DataSetIdentifier", - "traits": { - "smithy.api#documentation": "

The identifier of the data set, typically the data set's name.

", - "smithy.api#required": {} - } - }, - "DataSetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data set.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A data set.

" - } - }, - "com.amazonaws.quicksight#DataSetIdentifierDeclarationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataSetIdentifierDeclaration" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#DataSetImportMode": { - "type": "enum", - "members": { - "SPICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SPICE" - } - }, - "DIRECT_QUERY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUERY" - } - } - } - }, - "com.amazonaws.quicksight#DataSetName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.quicksight#DataSetReference": { - "type": "structure", - "members": { - "DataSetPlaceholder": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Dataset placeholder.

", - "smithy.api#required": {} - } - }, - "DataSetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

Dataset Amazon Resource Name (ARN).

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Dataset reference.

" - } - }, - "com.amazonaws.quicksight#DataSetReferenceList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataSetReference" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.quicksight#DataSetRefreshProperties": { - "type": "structure", - "members": { - "RefreshConfiguration": { - "target": "com.amazonaws.quicksight#RefreshConfiguration", - "traits": { - "smithy.api#documentation": "

The refresh configuration for a dataset.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The refresh properties of a dataset.

" - } - }, - "com.amazonaws.quicksight#DataSetRegion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.quicksight#DataSetSchema": { - "type": "structure", - "members": { - "ColumnSchemaList": { - "target": "com.amazonaws.quicksight#ColumnSchemaList", - "traits": { - "smithy.api#documentation": "

A structure containing the list of column schemas.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Dataset schema.

" - } - }, - "com.amazonaws.quicksight#DataSetSearchFilter": { - "type": "structure", - "members": { - "Operator": { - "target": "com.amazonaws.quicksight#FilterOperator", - "traits": { - "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\": \"StringEquals\". Valid values are \"StringEquals\" and \"StringLike\".

\n

If you set the operator value to \"StringEquals\", you need to provide an ownership related filter in the \"NAME\" field and the arn of the user or group whose datasets you want to search in the \"Value\" field. For example, \"Name\":\"QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east- 1:1:user/default/UserName1\".

\n

If you set the value to \"StringLike\", you need to provide the name of the datasets you are searching for. For example, \"Name\":\"DATASET_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\". The \"StringLike\" operator only supports the NAME value DATASET_NAME.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DataSetFilterAttribute", - "traits": { - "smithy.api#documentation": "

The name of the value that you want to use as a filter, for example, \"Name\":\n \"QUICKSIGHT_OWNER\".

\n

Valid values are defined as follows:

\n ", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The value of the named item, in this case QUICKSIGHT_OWNER, that you want\n to use as a filter, for example, \"Value\":\n \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A filter that you apply when searching for datasets.

" - } - }, - "com.amazonaws.quicksight#DataSetSearchFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataSetSearchFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#DataSetSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

A display name for the dataset.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that this dataset was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that this dataset was updated.

" - } - }, - "ImportMode": { - "target": "com.amazonaws.quicksight#DataSetImportMode", - "traits": { - "smithy.api#documentation": "

A value that indicates whether you want to import the data into SPICE.

" - } - }, - "RowLevelPermissionDataSet": { - "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", - "traits": { - "smithy.api#documentation": "

The row-level security configuration for the dataset.

" - } - }, - "RowLevelPermissionTagConfigurationApplied": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether or not the row level permission tags are applied.

" - } - }, - "ColumnLevelPermissionRulesApplied": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates if the dataset has column level permission configured.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Dataset summary.

" - } - }, - "com.amazonaws.quicksight#DataSetSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataSetSummary" - } - }, - "com.amazonaws.quicksight#DataSetUsageConfiguration": { - "type": "structure", - "members": { - "DisableUseAsDirectQuerySource": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

An option that controls whether a child dataset of a direct query can use this dataset as a source.

" - } - }, - "DisableUseAsImportedSource": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The usage configuration to apply to child datasets that reference this dataset as a source.

" - } - }, - "com.amazonaws.quicksight#DataSource": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each\n Amazon Web Services account.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

A display name for the data source.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#DataSourceType", - "traits": { - "smithy.api#documentation": "

The type of the data source. This type indicates which database engine the data source\n connects to.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The HTTP status of the request.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that this data source was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that this data source was updated.

" - } - }, - "DataSourceParameters": { - "target": "com.amazonaws.quicksight#DataSourceParameters", - "traits": { - "smithy.api#documentation": "

The parameters that Amazon QuickSight uses to connect to your underlying source. This\n is a variant type structure. For this structure to be valid, only one of the attributes\n can be non-null.

" - } - }, - "AlternateDataSourceParameters": { - "target": "com.amazonaws.quicksight#DataSourceParametersList", - "traits": { - "smithy.api#documentation": "

A set of alternate data source parameters that you want to share for the credentials\n stored with this data source. The credentials are applied in tandem with the data source\n parameters when you copy a data source by using a create or update request. The API\n operation compares the DataSourceParameters structure that's in the request\n with the structures in the AlternateDataSourceParameters allow list. If the\n structures are an exact match, the request is allowed to use the credentials from this\n existing data source. If the AlternateDataSourceParameters list is null,\n the Credentials originally used with this DataSourceParameters\n are automatically allowed.

" - } - }, - "VpcConnectionProperties": { - "target": "com.amazonaws.quicksight#VpcConnectionProperties", - "traits": { - "smithy.api#documentation": "

The VPC connection information. You need to use this parameter only when you want\n Amazon QuickSight to use a VPC connection when connecting to your underlying source.

" - } - }, - "SslProperties": { - "target": "com.amazonaws.quicksight#SslProperties", - "traits": { - "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your\n underlying source.

" - } - }, - "ErrorInfo": { - "target": "com.amazonaws.quicksight#DataSourceErrorInfo", - "traits": { - "smithy.api#documentation": "

Error information from the last update or the creation of the data source.

" - } - }, - "SecretArn": { - "target": "com.amazonaws.quicksight#SecretArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The structure of a data source.

" - } - }, - "com.amazonaws.quicksight#DataSourceCredentials": { - "type": "structure", - "members": { - "CredentialPair": { - "target": "com.amazonaws.quicksight#CredentialPair", - "traits": { - "smithy.api#documentation": "

Credential pair. For more information, see\n \n CredentialPair\n .

" - } - }, - "CopySourceArn": { - "target": "com.amazonaws.quicksight#CopySourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a data source that has the credential pair that you\n want to use. When CopySourceArn is not null, the credential pair from the\n data source in the ARN is used as the credentials for the\n DataSourceCredentials structure.

" - } - }, - "SecretArn": { - "target": "com.amazonaws.quicksight#SecretArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Data source credentials. This is a variant type structure. For this structure to be\n valid, only one of the attributes can be non-null.

", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#DataSourceErrorInfo": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.quicksight#DataSourceErrorInfoType", - "traits": { - "smithy.api#documentation": "

Error type.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

Error message.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Error information for the data source creation or update.

" - } - }, - "com.amazonaws.quicksight#DataSourceErrorInfoType": { - "type": "enum", - "members": { - "ACCESS_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCESS_DENIED" - } - }, - "COPY_SOURCE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COPY_SOURCE_NOT_FOUND" - } - }, - "TIMEOUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TIMEOUT" - } - }, - "ENGINE_VERSION_NOT_SUPPORTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENGINE_VERSION_NOT_SUPPORTED" - } - }, - "UNKNOWN_HOST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNKNOWN_HOST" - } - }, - "GENERIC_SQL_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GENERIC_SQL_FAILURE" - } - }, - "CONFLICT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONFLICT" - } - }, - "UNKNOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNKNOWN" - } - } - } - }, - "com.amazonaws.quicksight#DataSourceFilterAttribute": { - "type": "enum", - "members": { - "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" - } - }, - "DIRECT_QUICKSIGHT_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_OWNER" - } - }, - "DIRECT_QUICKSIGHT_SOLE_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_SOLE_OWNER" - } - }, - "DATASOURCE_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATASOURCE_NAME" - } - } - } - }, - "com.amazonaws.quicksight#DataSourceList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataSource" - } - }, - "com.amazonaws.quicksight#DataSourceParameters": { - "type": "union", - "members": { - "AmazonElasticsearchParameters": { - "target": "com.amazonaws.quicksight#AmazonElasticsearchParameters", - "traits": { - "smithy.api#documentation": "

The parameters for OpenSearch.

" - } - }, - "AthenaParameters": { - "target": "com.amazonaws.quicksight#AthenaParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Amazon Athena.

" - } - }, - "AuroraParameters": { - "target": "com.amazonaws.quicksight#AuroraParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Amazon Aurora MySQL.

" - } - }, - "AuroraPostgreSqlParameters": { - "target": "com.amazonaws.quicksight#AuroraPostgreSqlParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Amazon Aurora.

" - } - }, - "AwsIotAnalyticsParameters": { - "target": "com.amazonaws.quicksight#AwsIotAnalyticsParameters", - "traits": { - "smithy.api#documentation": "

The parameters for IoT Analytics.

" - } - }, - "JiraParameters": { - "target": "com.amazonaws.quicksight#JiraParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Jira.

" - } - }, - "MariaDbParameters": { - "target": "com.amazonaws.quicksight#MariaDbParameters", - "traits": { - "smithy.api#documentation": "

The parameters for MariaDB.

" - } - }, - "MySqlParameters": { - "target": "com.amazonaws.quicksight#MySqlParameters", - "traits": { - "smithy.api#documentation": "

The parameters for MySQL.

" - } - }, - "OracleParameters": { - "target": "com.amazonaws.quicksight#OracleParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Oracle.

" - } - }, - "PostgreSqlParameters": { - "target": "com.amazonaws.quicksight#PostgreSqlParameters", - "traits": { - "smithy.api#documentation": "

The parameters for PostgreSQL.

" - } - }, - "PrestoParameters": { - "target": "com.amazonaws.quicksight#PrestoParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Presto.

" - } - }, - "RdsParameters": { - "target": "com.amazonaws.quicksight#RdsParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Amazon RDS.

" - } - }, - "RedshiftParameters": { - "target": "com.amazonaws.quicksight#RedshiftParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Amazon Redshift.

" - } - }, - "S3Parameters": { - "target": "com.amazonaws.quicksight#S3Parameters", - "traits": { - "smithy.api#documentation": "

The parameters for S3.

" - } - }, - "ServiceNowParameters": { - "target": "com.amazonaws.quicksight#ServiceNowParameters", - "traits": { - "smithy.api#documentation": "

The parameters for ServiceNow.

" - } - }, - "SnowflakeParameters": { - "target": "com.amazonaws.quicksight#SnowflakeParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Snowflake.

" - } - }, - "SparkParameters": { - "target": "com.amazonaws.quicksight#SparkParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Spark.

" - } - }, - "SqlServerParameters": { - "target": "com.amazonaws.quicksight#SqlServerParameters", - "traits": { - "smithy.api#documentation": "

The parameters for SQL Server.

" - } - }, - "TeradataParameters": { - "target": "com.amazonaws.quicksight#TeradataParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Teradata.

" - } - }, - "TwitterParameters": { - "target": "com.amazonaws.quicksight#TwitterParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Twitter.

" - } - }, - "AmazonOpenSearchParameters": { - "target": "com.amazonaws.quicksight#AmazonOpenSearchParameters", - "traits": { - "smithy.api#documentation": "

The parameters for OpenSearch.

" - } - }, - "ExasolParameters": { - "target": "com.amazonaws.quicksight#ExasolParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Exasol.

" - } - }, - "DatabricksParameters": { - "target": "com.amazonaws.quicksight#DatabricksParameters", - "traits": { - "smithy.api#documentation": "

The parameters that are required to connect to a Databricks data source.

" - } - }, - "StarburstParameters": { - "target": "com.amazonaws.quicksight#StarburstParameters", - "traits": { - "smithy.api#documentation": "

The parameters that are required to connect to a Starburst data source.

" - } - }, - "TrinoParameters": { - "target": "com.amazonaws.quicksight#TrinoParameters", - "traits": { - "smithy.api#documentation": "

The parameters that are required to connect to a Trino data source.

" - } - }, - "BigQueryParameters": { - "target": "com.amazonaws.quicksight#BigQueryParameters", - "traits": { - "smithy.api#documentation": "

The parameters that are required to connect to a Google BigQuery data source.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters that Amazon QuickSight uses to connect to your underlying data source.\n This is a variant type structure. For this structure to be valid, only one of the\n attributes can be non-null.

" - } - }, - "com.amazonaws.quicksight#DataSourceParametersList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataSourceParameters" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#DataSourceSearchFilter": { - "type": "structure", - "members": { - "Operator": { - "target": "com.amazonaws.quicksight#FilterOperator", - "traits": { - "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\": \"StringEquals\". Valid values are \"StringEquals\" and \"StringLike\".

\n

If you set the operator value to \"StringEquals\", you need to provide an ownership related filter in the \"NAME\" field and the arn of the user or group whose data sources you want to search in the \"Value\" field. For example, \"Name\":\"DIRECT_QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

\n

If you set the value to \"StringLike\", you need to provide the name of the data sources you are searching for. For example, \"Name\":\"DATASOURCE_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\". The \"StringLike\" operator only supports the NAME value DATASOURCE_NAME.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DataSourceFilterAttribute", - "traits": { - "smithy.api#documentation": "

The name of the value that you want to use as a filter, for example, \"Name\":\n \"DIRECT_QUICKSIGHT_OWNER\".

\n

Valid values are defined as follows:

\n ", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The value of the named item, for example DIRECT_QUICKSIGHT_OWNER, that you want\n to use as a filter, for example, \"Value\":\n \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A filter that you apply when searching for data sources.

" - } - }, - "com.amazonaws.quicksight#DataSourceSearchFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataSourceSearchFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#DataSourceSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The arn of the datasource.

" - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The unique ID of the data source.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the data source.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#DataSourceType", - "traits": { - "smithy.api#documentation": "

The type of the data source.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A DataSourceSummary object that returns a summary of a data source.

" - } - }, - "com.amazonaws.quicksight#DataSourceSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataSourceSummary" - } - }, - "com.amazonaws.quicksight#DataSourceType": { - "type": "enum", - "members": { - "ADOBE_ANALYTICS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ADOBE_ANALYTICS" - } - }, - "AMAZON_ELASTICSEARCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AMAZON_ELASTICSEARCH" - } - }, - "ATHENA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ATHENA" - } - }, - "AURORA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AURORA" - } - }, - "AURORA_POSTGRESQL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AURORA_POSTGRESQL" - } - }, - "AWS_IOT_ANALYTICS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AWS_IOT_ANALYTICS" - } - }, - "GITHUB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GITHUB" - } - }, - "JIRA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JIRA" - } - }, - "MARIADB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MARIADB" - } - }, - "MYSQL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MYSQL" - } - }, - "ORACLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ORACLE" - } - }, - "POSTGRESQL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POSTGRESQL" - } - }, - "PRESTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRESTO" - } - }, - "REDSHIFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REDSHIFT" - } - }, - "S3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3" - } - }, - "SALESFORCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SALESFORCE" - } - }, - "SERVICENOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SERVICENOW" - } - }, - "SNOWFLAKE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SNOWFLAKE" - } - }, - "SPARK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SPARK" - } - }, - "SQLSERVER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SQLSERVER" - } - }, - "TERADATA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TERADATA" - } - }, - "TWITTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TWITTER" - } - }, - "TIMESTREAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TIMESTREAM" - } - }, - "AMAZON_OPENSEARCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AMAZON_OPENSEARCH" - } - }, - "EXASOL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXASOL" - } - }, - "DATABRICKS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATABRICKS" - } - }, - "STARBURST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARBURST" - } - }, - "TRINO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRINO" - } - }, - "BIGQUERY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BIGQUERY" - } - } - } - }, - "com.amazonaws.quicksight#Database": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.quicksight#DatabaseGroup": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#DatabaseGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DatabaseGroup" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#DatabaseUser": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#DatabricksParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

The host name of the Databricks data source.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

The port for the Databricks data source.

", - "smithy.api#required": {} - } - }, - "SqlEndpointPath": { - "target": "com.amazonaws.quicksight#SqlEndpointPath", - "traits": { - "smithy.api#documentation": "

The HTTP path of the Databricks data source.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters that are required to connect to a Databricks data source.

" - } - }, - "com.amazonaws.quicksight#DatasetMetadata": { - "type": "structure", - "members": { - "DatasetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

", - "smithy.api#required": {} - } - }, - "DatasetName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The name of the dataset.

" - } - }, - "DatasetDescription": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The description of the dataset.

" - } - }, - "DataAggregation": { - "target": "com.amazonaws.quicksight#DataAggregation", - "traits": { - "smithy.api#documentation": "

The definition of a data aggregation.

" - } - }, - "Filters": { - "target": "com.amazonaws.quicksight#TopicFilters", - "traits": { - "smithy.api#documentation": "

The list of filter definitions.

" - } - }, - "Columns": { - "target": "com.amazonaws.quicksight#TopicColumns", - "traits": { - "smithy.api#documentation": "

The list of column definitions.

" - } - }, - "CalculatedFields": { - "target": "com.amazonaws.quicksight#TopicCalculatedFields", - "traits": { - "smithy.api#documentation": "

The list of calculated field definitions.

" - } - }, - "NamedEntities": { - "target": "com.amazonaws.quicksight#TopicNamedEntities", - "traits": { - "smithy.api#documentation": "

The list of named entities definitions.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a dataset.

" - } - }, - "com.amazonaws.quicksight#DatasetParameter": { - "type": "structure", - "members": { - "StringDatasetParameter": { - "target": "com.amazonaws.quicksight#StringDatasetParameter", - "traits": { - "smithy.api#documentation": "

A string parameter that is created in the dataset.

" - } - }, - "DecimalDatasetParameter": { - "target": "com.amazonaws.quicksight#DecimalDatasetParameter", - "traits": { - "smithy.api#documentation": "

A decimal parameter that is created in the dataset.

" - } - }, - "IntegerDatasetParameter": { - "target": "com.amazonaws.quicksight#IntegerDatasetParameter", - "traits": { - "smithy.api#documentation": "

An integer parameter that is created in the dataset.

" - } - }, - "DateTimeDatasetParameter": { - "target": "com.amazonaws.quicksight#DateTimeDatasetParameter", - "traits": { - "smithy.api#documentation": "

A date time parameter that is created in the dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.

" - } - }, - "com.amazonaws.quicksight#DatasetParameterId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$" - } - }, - "com.amazonaws.quicksight#DatasetParameterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DatasetParameter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.quicksight#DatasetParameterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]+$" - } - }, - "com.amazonaws.quicksight#DatasetParameterValueType": { - "type": "enum", - "members": { - "MULTI_VALUED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MULTI_VALUED" - } - }, - "SINGLE_VALUED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SINGLE_VALUED" - } - } - }, - "traits": { - "smithy.api#documentation": "

The value type of the parameter. The value type is used to validate the parameter before it is evaluated.

" - } - }, - "com.amazonaws.quicksight#Datasets": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DatasetMetadata" - } - }, - "com.amazonaws.quicksight#DateAggregationFunction": { - "type": "enum", - "members": { - "COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNT" - } - }, - "DISTINCT_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISTINCT_COUNT" - } - }, - "MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MIN" - } - }, - "MAX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX" - } - } - } - }, - "com.amazonaws.quicksight#DateAxisOptions": { - "type": "structure", - "members": { - "MissingDateVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines whether or not missing dates are displayed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine how a date axis is displayed.

" - } - }, - "com.amazonaws.quicksight#DateDimensionField": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The custom field ID.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that is used in the DateDimensionField.

", - "smithy.api#required": {} - } - }, - "DateGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The date granularity of the DateDimensionField. Choose one of the following options:

\n " - } - }, - "HierarchyId": { - "target": "com.amazonaws.quicksight#HierarchyId", - "traits": { - "smithy.api#documentation": "

The custom hierarchy ID.

" - } - }, - "FormatConfiguration": { - "target": "com.amazonaws.quicksight#DateTimeFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The format configuration of the field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The dimension type field with date type columns.

" - } - }, - "com.amazonaws.quicksight#DateMeasureField": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The custom field ID.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that is used in the DateMeasureField.

", - "smithy.api#required": {} - } - }, - "AggregationFunction": { - "target": "com.amazonaws.quicksight#DateAggregationFunction", - "traits": { - "smithy.api#documentation": "

The aggregation function of the measure field.

" - } - }, - "FormatConfiguration": { - "target": "com.amazonaws.quicksight#DateTimeFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The format configuration of the field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The measure type field with date type columns.

" - } - }, - "com.amazonaws.quicksight#DateTimeDatasetParameter": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.quicksight#DatasetParameterId", - "traits": { - "smithy.api#documentation": "

An identifier for the parameter that is created in the dataset.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DatasetParameterName", - "traits": { - "smithy.api#documentation": "

The name of the date time parameter that is created in the dataset.

", - "smithy.api#required": {} - } - }, - "ValueType": { - "target": "com.amazonaws.quicksight#DatasetParameterValueType", - "traits": { - "smithy.api#documentation": "

The value type of the dataset parameter. Valid values are single value or multi value.

", - "smithy.api#required": {} - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The time granularity of the date time parameter.

" - } - }, - "DefaultValues": { - "target": "com.amazonaws.quicksight#DateTimeDatasetParameterDefaultValues", - "traits": { - "smithy.api#documentation": "

A list of default values for a given date time parameter. This structure only accepts static values.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A date time parameter for a dataset.

" - } - }, - "com.amazonaws.quicksight#DateTimeDatasetParameterDefaultValue": { - "type": "timestamp", - "traits": { - "smithy.api#documentation": "

The default value for the date time parameter.

" - } - }, - "com.amazonaws.quicksight#DateTimeDatasetParameterDefaultValues": { - "type": "structure", - "members": { - "StaticValues": { - "target": "com.amazonaws.quicksight#DateTimeDatasetParameterValueList", - "traits": { - "smithy.api#documentation": "

A list of static default values for a given date time parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default values of a date time parameter.

" - } - }, - "com.amazonaws.quicksight#DateTimeDatasetParameterValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DateTimeDatasetParameterDefaultValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.quicksight#DateTimeDefaultValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SensitiveTimestamp" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50000 - } - } - }, - "com.amazonaws.quicksight#DateTimeDefaultValues": { - "type": "structure", - "members": { - "DynamicValue": { - "target": "com.amazonaws.quicksight#DynamicDefaultValue", - "traits": { - "smithy.api#documentation": "

The dynamic value of the DataTimeDefaultValues. Different defaults are displayed according to users, groups, and values mapping.

" - } - }, - "StaticValues": { - "target": "com.amazonaws.quicksight#DateTimeDefaultValueList", - "traits": { - "smithy.api#documentation": "

The static values of the DataTimeDefaultValues.

" - } - }, - "RollingDate": { - "target": "com.amazonaws.quicksight#RollingDateConfiguration", - "traits": { - "smithy.api#documentation": "

The rolling date of the DataTimeDefaultValues. The date is determined from the dataset based on input expression.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default values of the DateTimeParameterDeclaration.

" - } - }, - "com.amazonaws.quicksight#DateTimeFormat": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.quicksight#DateTimeFormatConfiguration": { - "type": "structure", - "members": { - "DateTimeFormat": { - "target": "com.amazonaws.quicksight#DateTimeFormat", - "traits": { - "smithy.api#documentation": "

Determines the DateTime format.

" - } - }, - "NullValueFormatConfiguration": { - "target": "com.amazonaws.quicksight#NullValueFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the null value format configuration.

" - } - }, - "NumericFormatConfiguration": { - "target": "com.amazonaws.quicksight#NumericFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The formatting configuration for numeric DateTime fields.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Formatting configuration for DateTime fields.

" - } - }, - "com.amazonaws.quicksight#DateTimeHierarchy": { - "type": "structure", - "members": { - "HierarchyId": { - "target": "com.amazonaws.quicksight#HierarchyId", - "traits": { - "smithy.api#documentation": "

The hierarchy ID of the DateTime hierarchy.

", - "smithy.api#required": {} - } - }, - "DrillDownFilters": { - "target": "com.amazonaws.quicksight#DrillDownFilterList", - "traits": { - "smithy.api#documentation": "

The option that determines the drill down filters for the\n DateTime hierarchy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The option that determines the hierarchy of any DateTime fields.

" - } - }, - "com.amazonaws.quicksight#DateTimeParameter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A display name for the date-time parameter.

", - "smithy.api#required": {} - } - }, - "Values": { - "target": "com.amazonaws.quicksight#SensitiveTimestampList", - "traits": { - "smithy.api#documentation": "

The values for the date-time parameter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A date-time parameter.

" - } - }, - "com.amazonaws.quicksight#DateTimeParameterDeclaration": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The name of the parameter that is being declared.

", - "smithy.api#required": {} - } - }, - "DefaultValues": { - "target": "com.amazonaws.quicksight#DateTimeDefaultValues", - "traits": { - "smithy.api#documentation": "

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

" - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" - } - }, - "ValueWhenUnset": { - "target": "com.amazonaws.quicksight#DateTimeValueWhenUnsetConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration that defines the default value of a DateTime parameter when a value has not been set.

" - } - }, - "MappedDataSetParameters": { - "target": "com.amazonaws.quicksight#MappedDataSetParameters" - } - }, - "traits": { - "smithy.api#documentation": "

A parameter declaration for the DateTime data type.

" - } - }, - "com.amazonaws.quicksight#DateTimeParameterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DateTimeParameter" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#DateTimePickerControlDisplayOptions": { - "type": "structure", - "members": { - "TitleOptions": { - "target": "com.amazonaws.quicksight#LabelOptions", - "traits": { - "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" - } - }, - "DateTimeFormat": { - "target": "com.amazonaws.quicksight#DateTimeFormat", - "traits": { - "smithy.api#documentation": "

Customize how dates are formatted in controls.

" - } - }, - "InfoIconLabelOptions": { - "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", - "traits": { - "smithy.api#documentation": "

The configuration of info icon label options.

" - } - }, - "HelperTextVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The helper text visibility of the DateTimePickerControlDisplayOptions.

" - } - }, - "DateIconVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The date icon visibility of the DateTimePickerControlDisplayOptions.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "com.amazonaws.quicksight#DateTimeValueWhenUnsetConfiguration": { - "type": "structure", - "members": { - "ValueWhenUnsetOption": { - "target": "com.amazonaws.quicksight#ValueWhenUnsetOption", - "traits": { - "smithy.api#documentation": "

The built-in options for default values. The value can be one of the following:

\n " - } - }, - "CustomValue": { - "target": "com.amazonaws.quicksight#SensitiveTimestamp", - "traits": { - "smithy.api#documentation": "

A custom value that's used when the value of a parameter isn't set.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration that defines the default value of a DateTime parameter when a value has not been set.

" - } - }, - "com.amazonaws.quicksight#DayOfMonth": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 17 - }, - "smithy.api#pattern": "^(?:LAST_DAY_OF_MONTH|1[0-9]|2[0-8]|[12]|[3-9])$" - } - }, - "com.amazonaws.quicksight#DayOfTheWeek": { - "type": "enum", - "members": { - "SUNDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUNDAY" - } - }, - "MONDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MONDAY" - } - }, - "TUESDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TUESDAY" - } - }, - "WEDNESDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WEDNESDAY" - } - }, - "THURSDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THURSDAY" - } - }, - "FRIDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FRIDAY" - } - }, - "SATURDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SATURDAY" - } - } - } - }, - "com.amazonaws.quicksight#DayOfWeek": { - "type": "enum", - "members": { - "SUNDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUNDAY" - } - }, - "MONDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MONDAY" - } - }, - "TUESDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TUESDAY" - } - }, - "WEDNESDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WEDNESDAY" - } - }, - "THURSDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THURSDAY" - } - }, - "FRIDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FRIDAY" - } - }, - "SATURDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SATURDAY" - } - } - } - }, - "com.amazonaws.quicksight#DbUsername": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#DecimalDatasetParameter": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.quicksight#DatasetParameterId", - "traits": { - "smithy.api#documentation": "

An identifier for the decimal parameter created in the dataset.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DatasetParameterName", - "traits": { - "smithy.api#documentation": "

The name of the decimal parameter that is created in the dataset.

", - "smithy.api#required": {} - } - }, - "ValueType": { - "target": "com.amazonaws.quicksight#DatasetParameterValueType", - "traits": { - "smithy.api#documentation": "

The value type of the dataset parameter. Valid values are single value or multi value.

", - "smithy.api#required": {} - } - }, - "DefaultValues": { - "target": "com.amazonaws.quicksight#DecimalDatasetParameterDefaultValues", - "traits": { - "smithy.api#documentation": "

A list of default values for a given decimal parameter. This structure only accepts static values.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A decimal parameter for a dataset.

" - } - }, - "com.amazonaws.quicksight#DecimalDatasetParameterDefaultValue": { - "type": "double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The default value for the decimal parameter.

" - } - }, - "com.amazonaws.quicksight#DecimalDatasetParameterDefaultValues": { - "type": "structure", - "members": { - "StaticValues": { - "target": "com.amazonaws.quicksight#DecimalDatasetParameterValueList", - "traits": { - "smithy.api#documentation": "

A list of static default values for a given decimal parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default values of a decimal parameter.

" - } - }, - "com.amazonaws.quicksight#DecimalDatasetParameterValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DecimalDatasetParameterDefaultValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.quicksight#DecimalDefaultValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SensitiveDoubleObject" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50000 - } - } - }, - "com.amazonaws.quicksight#DecimalDefaultValues": { - "type": "structure", - "members": { - "DynamicValue": { - "target": "com.amazonaws.quicksight#DynamicDefaultValue", - "traits": { - "smithy.api#documentation": "

The dynamic value of the DecimalDefaultValues. Different defaults are displayed according to users, groups, and values mapping.

" - } - }, - "StaticValues": { - "target": "com.amazonaws.quicksight#DecimalDefaultValueList", - "traits": { - "smithy.api#documentation": "

The static values of the DecimalDefaultValues.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default values of the DecimalParameterDeclaration.

" - } - }, - "com.amazonaws.quicksight#DecimalParameter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A display name for the decimal parameter.

", - "smithy.api#required": {} - } - }, - "Values": { - "target": "com.amazonaws.quicksight#SensitiveDoubleList", - "traits": { - "smithy.api#documentation": "

The values for the decimal parameter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A decimal parameter.

" - } - }, - "com.amazonaws.quicksight#DecimalParameterDeclaration": { - "type": "structure", - "members": { - "ParameterValueType": { - "target": "com.amazonaws.quicksight#ParameterValueType", - "traits": { - "smithy.api#documentation": "

The value type determines whether the parameter is a single-value or multi-value parameter.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The name of the parameter that is being declared.

", - "smithy.api#required": {} - } - }, - "DefaultValues": { - "target": "com.amazonaws.quicksight#DecimalDefaultValues", - "traits": { - "smithy.api#documentation": "

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

" - } - }, - "ValueWhenUnset": { - "target": "com.amazonaws.quicksight#DecimalValueWhenUnsetConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration that defines the default value of a Decimal parameter when a value has not been set.

" - } - }, - "MappedDataSetParameters": { - "target": "com.amazonaws.quicksight#MappedDataSetParameters" - } - }, - "traits": { - "smithy.api#documentation": "

A parameter declaration for the Decimal data type.

" - } - }, - "com.amazonaws.quicksight#DecimalParameterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DecimalParameter" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#DecimalPlaces": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#DecimalPlacesConfiguration": { - "type": "structure", - "members": { - "DecimalPlaces": { - "target": "com.amazonaws.quicksight#DecimalPlaces", - "traits": { - "smithy.api#documentation": "

The values of the decimal places.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The option that determines the decimal places configuration.

" - } - }, - "com.amazonaws.quicksight#DecimalValueWhenUnsetConfiguration": { - "type": "structure", - "members": { - "ValueWhenUnsetOption": { - "target": "com.amazonaws.quicksight#ValueWhenUnsetOption", - "traits": { - "smithy.api#documentation": "

The built-in options for default values. The value can be one of the following:

\n " - } - }, - "CustomValue": { - "target": "com.amazonaws.quicksight#SensitiveDouble", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

A custom value that's used when the value of a parameter isn't set.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration that defines the default value of a Decimal parameter when a value has not been set.

" - } - }, - "com.amazonaws.quicksight#DefaultAggregation": { - "type": "enum", - "members": { - "SUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUM" - } - }, - "MAX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX" - } - }, - "MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MIN" - } - }, - "COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNT" - } - }, - "DISTINCT_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISTINCT_COUNT" - } - }, - "AVERAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVERAGE" - } - }, - "MEDIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIAN" - } - }, - "STDEV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEV" - } - }, - "STDEVP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEVP" - } - }, - "VAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VAR" - } - }, - "VARP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VARP" - } - } - } - }, - "com.amazonaws.quicksight#DefaultDateTimePickerControlOptions": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.quicksight#SheetControlDateTimePickerType", - "traits": { - "smithy.api#documentation": "

The date time picker type of the DefaultDateTimePickerControlOptions. Choose one of the following options:

\n " - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#DateTimePickerControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default options that correspond to the filter control type of a DateTimePicker.

" - } - }, - "com.amazonaws.quicksight#DefaultFilterControlConfiguration": { - "type": "structure", - "members": { - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the DefaultFilterControlConfiguration. This title is shared by all controls that are tied to this filter.

", - "smithy.api#required": {} - } - }, - "ControlOptions": { - "target": "com.amazonaws.quicksight#DefaultFilterControlOptions", - "traits": { - "smithy.api#documentation": "

The control option for the DefaultFilterControlConfiguration.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The default configuration for all dependent controls of the filter.

" - } - }, - "com.amazonaws.quicksight#DefaultFilterControlOptions": { - "type": "structure", - "members": { - "DefaultDateTimePickerOptions": { - "target": "com.amazonaws.quicksight#DefaultDateTimePickerControlOptions", - "traits": { - "smithy.api#documentation": "

The default options that correspond to the filter control type of a DateTimePicker.

" - } - }, - "DefaultListOptions": { - "target": "com.amazonaws.quicksight#DefaultFilterListControlOptions", - "traits": { - "smithy.api#documentation": "

The default options that correspond to the List filter control type.

" - } - }, - "DefaultDropdownOptions": { - "target": "com.amazonaws.quicksight#DefaultFilterDropDownControlOptions", - "traits": { - "smithy.api#documentation": "

The default options that correspond to the Dropdown filter control type.

" - } - }, - "DefaultTextFieldOptions": { - "target": "com.amazonaws.quicksight#DefaultTextFieldControlOptions", - "traits": { - "smithy.api#documentation": "

The default options that correspond to the TextField filter control type.

" - } - }, - "DefaultTextAreaOptions": { - "target": "com.amazonaws.quicksight#DefaultTextAreaControlOptions", - "traits": { - "smithy.api#documentation": "

The default options that correspond to the TextArea filter control type.

" - } - }, - "DefaultSliderOptions": { - "target": "com.amazonaws.quicksight#DefaultSliderControlOptions", - "traits": { - "smithy.api#documentation": "

The default options that correspond to the Slider filter control type.

" - } - }, - "DefaultRelativeDateTimeOptions": { - "target": "com.amazonaws.quicksight#DefaultRelativeDateTimeControlOptions", - "traits": { - "smithy.api#documentation": "

The default options that correspond to the RelativeDateTime filter control type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The option that corresponds to the control type of the filter.

" - } - }, - "com.amazonaws.quicksight#DefaultFilterDropDownControlOptions": { - "type": "structure", - "members": { - "DisplayOptions": { - "target": "com.amazonaws.quicksight#DropDownControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#SheetControlListType", - "traits": { - "smithy.api#documentation": "

The type of the FilterDropDownControl. Choose one of the following options:

\n " - } - }, - "SelectableValues": { - "target": "com.amazonaws.quicksight#FilterSelectableValues", - "traits": { - "smithy.api#documentation": "

A list of selectable values that are used in a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default options that correspond to the Dropdown filter control type.

" - } - }, - "com.amazonaws.quicksight#DefaultFilterListControlOptions": { - "type": "structure", - "members": { - "DisplayOptions": { - "target": "com.amazonaws.quicksight#ListControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#SheetControlListType", - "traits": { - "smithy.api#documentation": "

The type of the DefaultFilterListControlOptions. Choose one of the following options:

\n " - } - }, - "SelectableValues": { - "target": "com.amazonaws.quicksight#FilterSelectableValues", - "traits": { - "smithy.api#documentation": "

A list of selectable values that are used in a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default options that correspond to the List filter control type.

" - } - }, - "com.amazonaws.quicksight#DefaultFormatting": { - "type": "structure", - "members": { - "DisplayFormat": { - "target": "com.amazonaws.quicksight#DisplayFormat", - "traits": { - "smithy.api#documentation": "

The display format. Valid values for this structure are AUTO,\n PERCENT, CURRENCY, NUMBER, DATE, and\n STRING.

" - } - }, - "DisplayFormatOptions": { - "target": "com.amazonaws.quicksight#DisplayFormatOptions", - "traits": { - "smithy.api#documentation": "

The additional options for display formatting.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a default formatting definition.

" - } - }, - "com.amazonaws.quicksight#DefaultFreeFormLayoutConfiguration": { - "type": "structure", - "members": { - "CanvasSizeOptions": { - "target": "com.amazonaws.quicksight#FreeFormLayoutCanvasSizeOptions", - "traits": { - "smithy.api#documentation": "

Determines the screen canvas size options for a free-form layout.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the default settings of a free-form layout configuration.

" - } - }, - "com.amazonaws.quicksight#DefaultGridLayoutConfiguration": { - "type": "structure", - "members": { - "CanvasSizeOptions": { - "target": "com.amazonaws.quicksight#GridLayoutCanvasSizeOptions", - "traits": { - "smithy.api#documentation": "

Determines the screen canvas size options for a grid layout.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the default settings for a grid layout configuration.

" - } - }, - "com.amazonaws.quicksight#DefaultInteractiveLayoutConfiguration": { - "type": "structure", - "members": { - "Grid": { - "target": "com.amazonaws.quicksight#DefaultGridLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the default settings for a grid layout configuration.

" - } - }, - "FreeForm": { - "target": "com.amazonaws.quicksight#DefaultFreeFormLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the default settings of a free-form layout configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the default settings for interactive layout configuration.

" - } - }, - "com.amazonaws.quicksight#DefaultNewSheetConfiguration": { - "type": "structure", - "members": { - "InteractiveLayoutConfiguration": { - "target": "com.amazonaws.quicksight#DefaultInteractiveLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the default settings for interactive layout configuration.

" - } - }, - "PaginatedLayoutConfiguration": { - "target": "com.amazonaws.quicksight#DefaultPaginatedLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the default settings for a paginated layout configuration.

" - } - }, - "SheetContentType": { - "target": "com.amazonaws.quicksight#SheetContentType", - "traits": { - "smithy.api#documentation": "

The option that determines the sheet content type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for default new sheet settings.

" - } - }, - "com.amazonaws.quicksight#DefaultPaginatedLayoutConfiguration": { - "type": "structure", - "members": { - "SectionBased": { - "target": "com.amazonaws.quicksight#DefaultSectionBasedLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the default settings for a section-based layout configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the default settings for a paginated layout configuration.

" - } - }, - "com.amazonaws.quicksight#DefaultRelativeDateTimeControlOptions": { - "type": "structure", - "members": { - "DisplayOptions": { - "target": "com.amazonaws.quicksight#RelativeDateTimeControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default options that correspond to the RelativeDateTime filter control type.

" - } - }, - "com.amazonaws.quicksight#DefaultSectionBasedLayoutConfiguration": { - "type": "structure", - "members": { - "CanvasSizeOptions": { - "target": "com.amazonaws.quicksight#SectionBasedLayoutCanvasSizeOptions", - "traits": { - "smithy.api#documentation": "

Determines the screen canvas size options for a section-based layout.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the default settings for a section-based layout configuration.

" - } - }, - "com.amazonaws.quicksight#DefaultSliderControlOptions": { - "type": "structure", - "members": { - "DisplayOptions": { - "target": "com.amazonaws.quicksight#SliderControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#SheetControlSliderType", - "traits": { - "smithy.api#documentation": "

The type of the DefaultSliderControlOptions. Choose one of the following options:

\n " - } - }, - "MaximumValue": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The larger value that is displayed at the right of the slider.

", - "smithy.api#required": {} - } - }, - "MinimumValue": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The smaller value that is displayed at the left of the slider.

", - "smithy.api#required": {} - } - }, - "StepSize": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of increments that the slider bar is divided into.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The default options that correspond to the Slider filter control type.

" - } - }, - "com.amazonaws.quicksight#DefaultTextAreaControlOptions": { - "type": "structure", - "members": { - "Delimiter": { - "target": "com.amazonaws.quicksight#TextAreaControlDelimiter", - "traits": { - "smithy.api#documentation": "

The delimiter that is used to separate the lines in text.

" - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#TextAreaControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default options that correspond to the TextArea filter control type.

" - } - }, - "com.amazonaws.quicksight#DefaultTextFieldControlOptions": { - "type": "structure", - "members": { - "DisplayOptions": { - "target": "com.amazonaws.quicksight#TextFieldControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default options that correspond to the TextField filter control type.

" - } - }, - "com.amazonaws.quicksight#DeleteAccountCustomization": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteAccountCustomizationRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteAccountCustomizationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified\n Amazon Web Services account and Amazon QuickSight namespace.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/customizations", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteAccountCustomizationRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in\n this Amazon Web Services Region.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight namespace that you're deleting the customizations from.

", - "smithy.api#httpQuery": "namespace" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteAccountCustomizationResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteAccountSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteAccountSubscriptionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteAccountSubscriptionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Use the DeleteAccountSubscription operation to delete an Amazon QuickSight account. This operation will result in an error message if you have configured your account termination protection settings to True. To change this setting and delete your account, call the UpdateAccountSettings API and set the value of the TerminationProtectionEnabled parameter to False, then make another call to the DeleteAccountSubscription API.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/account/{AwsAccountId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteAccountSubscriptionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the account that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteAccountSubscriptionResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteAnalysis": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteAnalysisRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteAnalysisResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during\n which you can restore the analysis. If you don't specify a recovery window value, the\n operation defaults to 30 days. Amazon QuickSight attaches a DeletionTime stamp to\n the response that specifies the end of the recovery window. At the end of the recovery\n window, Amazon QuickSight deletes the analysis permanently.

\n

At any time before recovery window ends, you can use the RestoreAnalysis\n API operation to remove the DeletionTime stamp and cancel the deletion of\n the analysis. The analysis remains visible in the API until it's deleted, so you can\n describe it but you can't make a template from it.

\n

An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console.\n To access it in the console, restore it. Deleting an analysis doesn't delete the\n dashboards that you publish from it.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteAnalysisRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account where you want to delete an analysis.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis that you're deleting.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RecoveryWindowInDays": { - "target": "com.amazonaws.quicksight#RecoveryWindowInDays", - "traits": { - "smithy.api#documentation": "

A value that specifies the number of days that Amazon QuickSight waits before it deletes the\n analysis. You can't use this parameter with the ForceDeleteWithoutRecovery\n option in the same API call. The default value is 30.

", - "smithy.api#httpQuery": "recovery-window-in-days" - } - }, - "ForceDeleteWithoutRecovery": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

This option defaults to the value NoForceDeleteWithoutRecovery. To\n immediately delete the analysis, add the ForceDeleteWithoutRecovery option.\n You can't restore an analysis after it's deleted.

", - "smithy.api#httpQuery": "force-delete-without-recovery" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteAnalysisResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deleted analysis.

" - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the deleted analysis.

" - } - }, - "DeletionTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the analysis is scheduled to be deleted.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteDashboard": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteDashboardRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteDashboardResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a dashboard.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteDashboardRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're\n deleting.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the dashboard. If the version number property is provided, only\n the specified version of the dashboard is deleted.

", - "smithy.api#httpQuery": "version-number" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteDashboardResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Secure Socket Layer (SSL) properties that apply for the resource.

" - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dashboard.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteDataSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteDataSetRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteDataSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a dataset.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteDataSetRefreshProperties": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteDataSetRefreshPropertiesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteDataSetRefreshPropertiesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the dataset refresh properties of the dataset.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteDataSetRefreshPropertiesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteDataSetRefreshPropertiesResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteDataSetRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteDataSetResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteDataSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteDataSourceRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteDataSourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the data source permanently. This operation breaks \n\t\t\tall the datasets that reference the deleted data source.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteDataSourceRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteDataSourceResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source that you deleted.

" - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteFolder": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteFolderRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteFolderResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an empty folder.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/folders/{FolderId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteFolderMembership": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteFolderMembershipRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteFolderMembershipResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes an asset, such as a dashboard, analysis, or dataset, from a folder.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteFolderMembershipRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The Folder ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MemberId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the asset that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MemberType": { - "target": "com.amazonaws.quicksight#MemberType", - "traits": { - "smithy.api#documentation": "

The member type of the asset that you want to delete from a folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteFolderMembershipResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteFolderRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteFolderResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name of the deleted folder.

" - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteGroupRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes a user group from Amazon QuickSight.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteGroupMembership": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteGroupMembershipRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteGroupMembershipResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes a user from a group so that the user is no longer a member of the group.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteGroupMembershipRequest": { - "type": "structure", - "members": { - "MemberName": { - "target": "com.amazonaws.quicksight#GroupMemberName", - "traits": { - "smithy.api#documentation": "

The name of the user that you want to delete from the group membership.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

The name of the group that you want to delete the user from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace of the group that you want to remove a user from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteGroupMembershipResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteGroupRequest": { - "type": "structure", - "members": { - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

The name of the group that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace of the group that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteGroupResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteIAMPolicyAssignment": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteIAMPolicyAssignmentRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteIAMPolicyAssignmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConcurrentUpdatingException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an existing IAM policy assignment.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/namespace/{Namespace}/iam-policy-assignments/{AssignmentName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteIAMPolicyAssignmentRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID where you want to delete the IAM\n\t\t\tpolicy assignment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "

The name of the assignment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that contains the assignment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteIAMPolicyAssignmentResponse": { - "type": "structure", - "members": { - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "

The name of the assignment.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteIdentityPropagationConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteIdentityPropagationConfigRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteIdentityPropagationConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application.

\n

This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/identity-propagation-config/{Service}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteIdentityPropagationConfigRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that you want to delete an identity propagation configuration from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Service": { - "target": "com.amazonaws.quicksight#ServiceType", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Web Services service that you want to delete the associated access scopes and authorized targets from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteIdentityPropagationConfigResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteNamespace": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteNamespaceRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteNamespaceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a namespace and the users and groups that are associated with the namespace.\n This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not \n deleted. To delete these assets, you use the API operations for the relevant asset.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteNamespaceRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteNamespaceResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteRefreshSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteRefreshScheduleRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteRefreshScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a refresh schedule from a dataset.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteRefreshScheduleRequest": { - "type": "structure", - "members": { - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ScheduleId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the refresh schedule.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteRefreshScheduleResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "ScheduleId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the refresh schedule.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the refresh schedule.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteRoleCustomPermission": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteRoleCustomPermissionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteRoleCustomPermissionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes custom permissions from the role.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteRoleCustomPermissionRequest": { - "type": "structure", - "members": { - "Role": { - "target": "com.amazonaws.quicksight#Role", - "traits": { - "smithy.api#documentation": "

The role that you want to remove permissions from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n Amazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that includes the role.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteRoleCustomPermissionResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteRoleMembership": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteRoleMembershipRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteRoleMembershipResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes a group from a role.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members/{MemberName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteRoleMembershipRequest": { - "type": "structure", - "members": { - "MemberName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

The name of the group.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Role": { - "target": "com.amazonaws.quicksight#Role", - "traits": { - "smithy.api#documentation": "

The role that you want to remove permissions from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that contains the role.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteRoleMembershipResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteTemplateRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a template.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteTemplateAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteTemplateAliasRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteTemplateAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the item that the specified template alias points to. If you provide a specific\n\t\t\talias, you delete the version of the template that the alias points to.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteTemplateAliasRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the item to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template that the specified alias is for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The name for the template alias. To delete a specific alias, you delete the version that the\n\t\t\talias points to. You can specify the alias name, or specify the latest version of the\n\t\t\ttemplate by providing the keyword $LATEST in the AliasName\n\t\t\tparameter.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteTemplateAliasResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the template associated with the deletion.

" - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The name for the template alias.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template you want to delete.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteTemplateRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template that you're deleting.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the template you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

Specifies the version of the template that you want to delete.\n\t\t\tIf you don't provide a version number, DeleteTemplate deletes all versions of the template.\n\t

", - "smithy.api#httpQuery": "version-number" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteTemplateResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the template.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteTheme": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteThemeRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteThemeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a theme.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteThemeAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteThemeAliasRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteThemeAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the version of the theme that the specified theme alias points to. \n\t\t\tIf you provide a specific alias, you delete the version of the theme \n\t\t\tthat the alias points to.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteThemeAliasRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme alias to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme that the specified alias is for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The unique name for the theme alias to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteThemeAliasResponse": { - "type": "structure", - "members": { - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The name for the theme alias.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme resource using the deleted alias.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the theme associated with the deletion.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteThemeRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme that you're deleting.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the theme that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version of the theme that you want to delete.

\n

\n Note: If you don't provide a version number, you're\n\t\t\tusing this call to DeleteTheme to delete all versions of the theme.

", - "smithy.api#httpQuery": "version-number" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteThemeResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the theme.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteTopic": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteTopicRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteTopicResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a topic.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteTopicRefreshSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteTopicRefreshScheduleRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteTopicRefreshScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a topic refresh schedule.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules/{DatasetId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteTopicRefreshScheduleRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DatasetId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteTopicRefreshScheduleResponse": { - "type": "structure", - "members": { - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "TopicArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "DatasetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteTopicRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic that you want to\n delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteTopicResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteUserRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the Amazon QuickSight user that is associated with the identity of the\n\t\t\tIAM user or role that's making the call. The IAM user\n\t\t\tisn't deleted as a result of this call.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteUserByPrincipalId": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteUserByPrincipalIdRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteUserByPrincipalIdResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a user identified by its principal ID.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/user-principals/{PrincipalId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteUserByPrincipalIdRequest": { - "type": "structure", - "members": { - "PrincipalId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The principal ID of the user.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteUserByPrincipalIdResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteUserRequest": { - "type": "structure", - "members": { - "UserName": { - "target": "com.amazonaws.quicksight#UserName", - "traits": { - "smithy.api#documentation": "

The name of the user that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteUserResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteVPCConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteVPCConnectionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteVPCConnectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a VPC connection.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteVPCConnectionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the account where you want to delete a VPC\n\t\t\tconnection.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VPCConnectionId": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", - "traits": { - "smithy.api#documentation": "

The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an\n\t\t\t\tAmazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteVPCConnectionResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deleted VPC connection.

" - } - }, - "VPCConnectionId": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", - "traits": { - "smithy.api#documentation": "

The ID of the VPC connection that\n\t\t\tyou're creating. This ID is a unique identifier for each Amazon Web Services Region in an\n\t\t\t\tAmazon Web Services account.

" - } - }, - "DeletionStatus": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", - "traits": { - "smithy.api#documentation": "

The deletion status of the VPC connection.

" - } - }, - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", - "traits": { - "smithy.api#documentation": "

The availability status of the VPC connection.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#Delimiter": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#DescribeAccountCustomization": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeAccountCustomizationRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeAccountCustomizationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the customizations associated with the provided Amazon Web Services account and Amazon\n Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which\n customizations to apply by running this API operation with the Resolved flag\n included.

\n

To determine what customizations display when you run this command, it can help to\n visualize the relationship of the entities involved.

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/customizations", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeAccountCustomizationRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations\n for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations\n for.

", - "smithy.api#httpQuery": "namespace" - } - }, - "Resolved": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The Resolved flag works with the other parameters to determine which view\n of Amazon QuickSight customizations is returned. You can add this flag to your command to use\n the same view that Amazon QuickSight uses to identify which customizations to apply to the\n console. Omit this flag, or set it to no-resolved, to reveal customizations\n that are configured at different levels.

", - "smithy.api#httpQuery": "resolved" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeAccountCustomizationResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customization that's associated with this Amazon Web Services account.

" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you're describing.

" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight namespace that you're describing.

" - } - }, - "AccountCustomization": { - "target": "com.amazonaws.quicksight#AccountCustomization", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight customizations that exist in the current Amazon Web Services Region.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeAccountSettings": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeAccountSettingsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeAccountSettingsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the settings that were used when your Amazon QuickSight subscription was first\n created in this Amazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/settings", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeAccountSettingsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the settings that you want to list.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeAccountSettingsResponse": { - "type": "structure", - "members": { - "AccountSettings": { - "target": "com.amazonaws.quicksight#AccountSettings", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight settings for this Amazon Web Services account. This information\n includes the edition of Amazon Amazon QuickSight that you subscribed to (Standard or\n Enterprise) and the notification email for the Amazon QuickSight subscription.

\n

In the QuickSight console, the Amazon QuickSight subscription is sometimes referred to\n as a QuickSight \"account\" even though it's technically not an account by\n itself. Instead, it's a subscription to the Amazon QuickSight service for your\n Amazon Web Services account. The edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region where you use it.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeAccountSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeAccountSubscriptionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeAccountSubscriptionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.

", - "smithy.api#http": { - "method": "GET", - "uri": "/account/{AwsAccountId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeAccountSubscriptionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID associated with your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeAccountSubscriptionResponse": { - "type": "structure", - "members": { - "AccountInfo": { - "target": "com.amazonaws.quicksight#AccountInfo", - "traits": { - "smithy.api#documentation": "

A structure that contains the following elements:

\n " - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeAnalysis": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeAnalysisRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeAnalysisResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides a summary of the metadata for an analysis.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeAnalysisDefinition": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeAnalysisDefinitionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeAnalysisDefinitionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides a detailed description of the definition of an analysis.

\n \n

If you do not need to know details about the content of an Analysis, for instance if you\n are trying to check the status of a recently created or updated Analysis, use the\n \n DescribeAnalysis\n instead.\n

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}/definition", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeAnalysisDefinitionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis. You must be using the\n Amazon Web Services account that the analysis is in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis that you're describing. The ID is part of the URL of the\n analysis.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeAnalysisDefinitionResponse": { - "type": "structure", - "members": { - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis described.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#AnalysisName", - "traits": { - "smithy.api#documentation": "

The descriptive name of the analysis.

" - } - }, - "Errors": { - "target": "com.amazonaws.quicksight#AnalysisErrorList", - "traits": { - "smithy.api#documentation": "

Errors associated with the analysis.

" - } - }, - "ResourceStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

Status associated with the analysis.

\n " - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the theme of the analysis.

" - } - }, - "Definition": { - "target": "com.amazonaws.quicksight#AnalysisDefinition", - "traits": { - "smithy.api#documentation": "

The definition of an analysis.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeAnalysisPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeAnalysisPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeAnalysisPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides the read and write permissions for an analysis.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeAnalysisPermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis whose permissions you're\n describing. You must be using the Amazon Web Services account that the analysis is in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis whose permissions you're describing. The ID is part of the\n analysis URL.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeAnalysisPermissionsResponse": { - "type": "structure", - "members": { - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis whose permissions you're describing.

" - } - }, - "AnalysisArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the analysis whose permissions you're\n describing.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A structure that describes the principals and the resource-level permissions on an\n analysis.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeAnalysisRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis. You must be using the \n Amazon Web Services account that the analysis is in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis that you're describing. The ID is part of the URL of the\n analysis.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeAnalysisResponse": { - "type": "structure", - "members": { - "Analysis": { - "target": "com.amazonaws.quicksight#Analysis", - "traits": { - "smithy.api#documentation": "

A metadata structure that contains summary information for the analysis that you're\n describing.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeAssetBundleExportJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeAssetBundleExportJobRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeAssetBundleExportJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes an existing export job.

\n

Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed.

\n

Job descriptions are available for 14 days after the job starts.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/asset-bundle-export-jobs/{AssetBundleExportJobId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeAssetBundleExportJobRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account the export job is executed in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssetBundleExportJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job that you want described. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeAssetBundleExportJobResponse": { - "type": "structure", - "members": { - "JobStatus": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobStatus", - "traits": { - "smithy.api#documentation": "

Indicates the status of a job through its queuing and execution.

\n

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

" - } - }, - "DownloadUrl": { - "target": "com.amazonaws.quicksight#SensitiveS3Uri", - "traits": { - "smithy.api#documentation": "

The URL to download the exported asset bundle data from.

\n

This URL is available only after the job has succeeded. This URL is valid for 5 minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed.

\n

The downloaded asset bundle is a zip file named assetbundle-{jobId}.qs. The file has a .qs extension.

\n

This URL can't be used in a StartAssetBundleImportJob API call and should only be used for download purposes.

" - } - }, - "Errors": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobErrorList", - "traits": { - "smithy.api#documentation": "

An array of error records that describes any failures that occurred during the export job processing.

\n

Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the export job.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the export job was created.

" - } - }, - "AssetBundleExportJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that the export job was executed in.

" - } - }, - "ResourceArns": { - "target": "com.amazonaws.quicksight#AssetBundleResourceArns", - "traits": { - "smithy.api#documentation": "

A list of resource ARNs that exported with the job.

" - } - }, - "IncludeAllDependencies": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The include dependencies flag.

" - } - }, - "ExportFormat": { - "target": "com.amazonaws.quicksight#AssetBundleExportFormat", - "traits": { - "smithy.api#documentation": "

The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON formatted file can be used in the CloudFormation console and with the CloudFormation APIs.

" - } - }, - "CloudFormationOverridePropertyConfiguration": { - "target": "com.amazonaws.quicksight#AssetBundleCloudFormationOverridePropertyConfiguration", - "traits": { - "smithy.api#documentation": "

The CloudFormation override property configuration for the export job.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the response.

", - "smithy.api#httpResponseCode": {} - } - }, - "IncludePermissions": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The include permissions flag.

" - } - }, - "IncludeTags": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The include tags flag.

" - } - }, - "ValidationStrategy": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobValidationStrategy", - "traits": { - "smithy.api#documentation": "

The validation strategy that is used to export the analysis or dashboard.

" - } - }, - "Warnings": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobWarningList", - "traits": { - "smithy.api#documentation": "

An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.

\n

This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeAssetBundleImportJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeAssetBundleImportJobRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeAssetBundleImportJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes an existing import job.

\n

Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/asset-bundle-import-jobs/{AssetBundleImportJobId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeAssetBundleImportJobRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account the import job was executed in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssetBundleImportJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeAssetBundleImportJobResponse": { - "type": "structure", - "members": { - "JobStatus": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobStatus", - "traits": { - "smithy.api#documentation": "

Indicates the status of a job through its queuing and execution.

\n

Poll the DescribeAssetBundleImport API until JobStatus returns one of the following values:

\n " - } - }, - "Errors": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobErrorList", - "traits": { - "smithy.api#documentation": "

An array of error records that describes any failures that occurred during the export job processing.

\n

Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.

" - } - }, - "RollbackErrors": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobErrorList", - "traits": { - "smithy.api#documentation": "

An array of error records that describes any failures that occurred while an import job was attempting a rollback.

\n

Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the import job.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the import job was created.

" - } - }, - "AssetBundleImportJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.

" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account the import job was executed in.

" - } - }, - "AssetBundleImportSource": { - "target": "com.amazonaws.quicksight#AssetBundleImportSourceDescription", - "traits": { - "smithy.api#documentation": "

The source of the asset bundle zip file that contains the data that is imported by the job.

" - } - }, - "OverrideParameters": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideParameters", - "traits": { - "smithy.api#documentation": "

Optional overrides that are applied to the resource configuration before import.

" - } - }, - "FailureAction": { - "target": "com.amazonaws.quicksight#AssetBundleImportFailureAction", - "traits": { - "smithy.api#documentation": "

The failure action for the import job.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the response.

", - "smithy.api#httpResponseCode": {} - } - }, - "OverridePermissions": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobOverridePermissions", - "traits": { - "smithy.api#documentation": "

Optional permission overrides that are applied to the resource configuration before import.

" - } - }, - "OverrideTags": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideTags", - "traits": { - "smithy.api#documentation": "

Optional tag overrides that are applied to the resource configuration before import.

" - } - }, - "OverrideValidationStrategy": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideValidationStrategy", - "traits": { - "smithy.api#documentation": "

An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.

" - } - }, - "Warnings": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobWarningList", - "traits": { - "smithy.api#documentation": "

An array of warning records that describe all permitted errors that are encountered during the import job.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeDashboard": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDashboardRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDashboardResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides a summary for a dashboard.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDashboardDefinition": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDashboardDefinitionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDashboardDefinitionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides a detailed description of the definition of a dashboard.

\n \n

If you do not need to know details about the content of a dashboard, for instance if you\n are trying to check the status of a recently created or updated dashboard, use the\n \n DescribeDashboard\n instead.\n

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/definition", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDashboardDefinitionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're\n describing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number for the dashboard. If a version number isn't passed, the\n latest published dashboard version is described.

", - "smithy.api#httpQuery": "version-number" - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The alias name.

", - "smithy.api#httpQuery": "alias-name" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDashboardDefinitionResponse": { - "type": "structure", - "members": { - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dashboard described.

" - } - }, - "Errors": { - "target": "com.amazonaws.quicksight#DashboardErrorList", - "traits": { - "smithy.api#documentation": "

Errors associated with this dashboard version.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DashboardName", - "traits": { - "smithy.api#documentation": "

The display name of the dashboard.

" - } - }, - "ResourceStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

Status associated with the dashboard version.

\n " - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the theme of the dashboard.

" - } - }, - "Definition": { - "target": "com.amazonaws.quicksight#DashboardVersionDefinition", - "traits": { - "smithy.api#documentation": "

The definition of a dashboard.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "DashboardPublishOptions": { - "target": "com.amazonaws.quicksight#DashboardPublishOptions", - "traits": { - "smithy.api#documentation": "

Options for publishing the dashboard:

\n " - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeDashboardPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDashboardPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDashboardPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes read and write permissions for a dashboard.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDashboardPermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're describing\n permissions for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard, also added to the IAM policy.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDashboardPermissionsResponse": { - "type": "structure", - "members": { - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

" - } - }, - "DashboardArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dashboard.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A structure that contains the permissions for the dashboard.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "LinkSharingConfiguration": { - "target": "com.amazonaws.quicksight#LinkSharingConfiguration", - "traits": { - "smithy.api#documentation": "

A structure that contains the configuration of a shareable link that grants access to\n the dashboard. Your users can use the link to view and interact with the dashboard, if\n the dashboard has been shared with them. For more information about sharing dashboards,\n see Sharing Dashboards.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeDashboardRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're\n describing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number for the dashboard. If a version number isn't passed, the\n latest published dashboard version is described.

", - "smithy.api#httpQuery": "version-number" - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The alias name.

", - "smithy.api#httpQuery": "alias-name" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDashboardResponse": { - "type": "structure", - "members": { - "Dashboard": { - "target": "com.amazonaws.quicksight#Dashboard", - "traits": { - "smithy.api#documentation": "

Information about the dashboard.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of this request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeDashboardSnapshotJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJobRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes an existing snapshot job.

\n

Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs/{SnapshotJobId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDashboardSnapshotJobRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dashboard that you have started a snapshot job for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SnapshotJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResponse": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

\n The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.\n

" - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dashboard that you have started a snapshot job for.

" - } - }, - "SnapshotJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

" - } - }, - "UserConfiguration": { - "target": "com.amazonaws.quicksight#SnapshotUserConfigurationRedacted", - "traits": { - "smithy.api#documentation": "

The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.

" - } - }, - "SnapshotConfiguration": { - "target": "com.amazonaws.quicksight#SnapshotConfiguration", - "traits": { - "smithy.api#documentation": "

The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

" - } - }, - "JobStatus": { - "target": "com.amazonaws.quicksight#SnapshotJobStatus", - "traits": { - "smithy.api#documentation": "

Indicates the status of a job. The status updates as the job executes. This shows one of the following values.

\n " - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

\n The time that the snapshot job was created.\n

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

\n The time that the snapshot job status was last updated.\n

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Web Services request ID for this operation.\n

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResult": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResultRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResultResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the result of an existing snapshot job that has finished running.

\n

A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call.

\n

If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id has not reached a terminal state..

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs/{SnapshotJobId}/result", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResultRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dashboard that you have started a snapshot job for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SnapshotJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResultResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

" - } - }, - "JobStatus": { - "target": "com.amazonaws.quicksight#SnapshotJobStatus", - "traits": { - "smithy.api#documentation": "

Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that a snapshot job was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that a snapshot job status was last updated.

" - } - }, - "Result": { - "target": "com.amazonaws.quicksight#SnapshotJobResult", - "traits": { - "smithy.api#documentation": "

The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.

" - } - }, - "ErrorInfo": { - "target": "com.amazonaws.quicksight#SnapshotJobErrorInfo", - "traits": { - "smithy.api#documentation": "

Displays information for the error that caused a job to fail.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDataSetRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDataSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDataSetPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDataSetPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDataSetPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the permissions on a dataset.

\n

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDataSetPermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSetPermissionsResponse": { - "type": "structure", - "members": { - "DataSetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions on the dataset.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSetRefreshProperties": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the refresh properties of a dataset.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "DataSetRefreshProperties": { - "target": "com.amazonaws.quicksight#DataSetRefreshProperties", - "traits": { - "smithy.api#documentation": "

The dataset refresh properties.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSetRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSetResponse": { - "type": "structure", - "members": { - "DataSet": { - "target": "com.amazonaws.quicksight#DataSet", - "traits": { - "smithy.api#documentation": "

Information on the dataset.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDataSourceRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDataSourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a data source.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDataSourcePermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDataSourcePermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDataSourcePermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the resource permissions for a data source.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDataSourcePermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSourcePermissionsResponse": { - "type": "structure", - "members": { - "DataSourceArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions on the data source.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSourceRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSourceResponse": { - "type": "structure", - "members": { - "DataSource": { - "target": "com.amazonaws.quicksight#DataSource", - "traits": { - "smithy.api#documentation": "

The information on the data source.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeFolder": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeFolderRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeFolderResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a folder.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/folders/{FolderId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeFolderPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeFolderPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeFolderPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes permissions for a folder.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/permissions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Permissions", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#DescribeFolderPermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace of the folder whose permissions you want described.

", - "smithy.api#httpQuery": "namespace" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token for the next set of results.

", - "smithy.api#httpQuery": "next-token" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeFolderPermissionsResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the folder.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

Information about the permissions on the folder.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The pagination token for the next set of results, or null if there are no more results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeFolderRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeFolderResolvedPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeFolderResolvedPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeFolderResolvedPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/resolved-permissions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Permissions", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#DescribeFolderResolvedPermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace of the folder whose permissions you want described.

", - "smithy.api#httpQuery": "namespace" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token for the next set of results.

", - "smithy.api#httpQuery": "next-token" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeFolderResolvedPermissionsResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the folder.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

Information about the permissions for the folder.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token for the next set of results, or null if there are no more results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeFolderResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "Folder": { - "target": "com.amazonaws.quicksight#Folder", - "traits": { - "smithy.api#documentation": "

Information about the folder.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeGroupRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeGroupMembership": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeGroupMembershipRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeGroupMembershipResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Use the DescribeGroupMembership operation to determine if a user is a\n\t\t\tmember of the specified group. If the user exists and is a member of the specified\n\t\t\tgroup, an associated GroupMember object is returned.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeGroupMembershipRequest": { - "type": "structure", - "members": { - "MemberName": { - "target": "com.amazonaws.quicksight#GroupMemberName", - "traits": { - "smithy.api#documentation": "

The user name of the user that you want to search for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

The name of the group that you want to search.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the \n Amazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that includes the group you are searching within.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeGroupMembershipResponse": { - "type": "structure", - "members": { - "GroupMember": { - "target": "com.amazonaws.quicksight#GroupMember" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeGroupRequest": { - "type": "structure", - "members": { - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

The name of the group that you want to describe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace of the group that you want described.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeGroupResponse": { - "type": "structure", - "members": { - "Group": { - "target": "com.amazonaws.quicksight#Group", - "traits": { - "smithy.api#documentation": "

The name of the group.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeIAMPolicyAssignment": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes an existing IAM policy assignment, as specified by the\n\t\t\tassignment name.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/{AssignmentName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the assignment that you want to\n\t\t\tdescribe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "

The name of the assignment, also called a rule.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that contains the assignment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentResponse": { - "type": "structure", - "members": { - "IAMPolicyAssignment": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignment", - "traits": { - "smithy.api#documentation": "

Information describing the IAM policy assignment.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeIngestion": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeIngestionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeIngestionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a SPICE ingestion.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeIngestionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the dataset used in the ingestion.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "IngestionId": { - "target": "com.amazonaws.quicksight#IngestionId", - "traits": { - "smithy.api#documentation": "

An ID for the ingestion.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeIngestionResponse": { - "type": "structure", - "members": { - "Ingestion": { - "target": "com.amazonaws.quicksight#Ingestion", - "traits": { - "smithy.api#documentation": "

Information about the ingestion.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeIpRestriction": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeIpRestrictionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeIpRestrictionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides a summary and status of IP rules.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/ip-restriction", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeIpRestrictionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the IP rules.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeIpRestrictionResponse": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the IP rules.

" - } - }, - "IpRestrictionRuleMap": { - "target": "com.amazonaws.quicksight#IpRestrictionRuleMap", - "traits": { - "smithy.api#documentation": "

A map that describes the IP rules with CIDR range and description.

" - } - }, - "VpcIdRestrictionRuleMap": { - "target": "com.amazonaws.quicksight#VpcIdRestrictionRuleMap", - "traits": { - "smithy.api#documentation": "

A map of allowed VPC IDs and their rule descriptions.

" - } - }, - "VpcEndpointIdRestrictionRuleMap": { - "target": "com.amazonaws.quicksight#VpcEndpointIdRestrictionRuleMap", - "traits": { - "smithy.api#documentation": "

A map of allowed VPC endpoint IDs and their rule descriptions.

" - } - }, - "Enabled": { - "target": "com.amazonaws.quicksight#NullableBoolean", - "traits": { - "smithy.api#documentation": "

A value that specifies whether IP rules are turned on.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.\n\t\t\t

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeKeyRegistration": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeKeyRegistrationRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeKeyRegistrationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes all customer managed key registrations in a Amazon QuickSight account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/key-registration", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeKeyRegistrationRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the customer managed key registration that you want to describe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DefaultKeyOnly": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Determines whether the request returns the default key only.

", - "smithy.api#httpQuery": "default-key-only" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeKeyRegistrationResponse": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the customer managed key registration specified in the request.

" - } - }, - "KeyRegistration": { - "target": "com.amazonaws.quicksight#KeyRegistration", - "traits": { - "smithy.api#documentation": "

A list of RegisteredCustomerManagedKey objects in a Amazon QuickSight account.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeNamespace": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeNamespaceRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeNamespaceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the current namespace.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeNamespaceRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that you want to describe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeNamespaceResponse": { - "type": "structure", - "members": { - "Namespace": { - "target": "com.amazonaws.quicksight#NamespaceInfoV2", - "traits": { - "smithy.api#documentation": "

The information about the namespace that you're describing. The response includes \n the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. DescribeNamespace also\n works for namespaces that are in the process of being created. For incomplete namespaces,\n this API operation lists the namespace error types and messages associated with the creation process.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeRefreshSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeRefreshScheduleRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeRefreshScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides a summary of a refresh schedule.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeRefreshScheduleRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ScheduleId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the refresh schedule.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeRefreshScheduleResponse": { - "type": "structure", - "members": { - "RefreshSchedule": { - "target": "com.amazonaws.quicksight#RefreshSchedule", - "traits": { - "smithy.api#documentation": "

The refresh schedule.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the refresh schedule.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeRoleCustomPermission": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeRoleCustomPermissionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeRoleCustomPermissionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes all custom permissions that are mapped to a role.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeRoleCustomPermissionRequest": { - "type": "structure", - "members": { - "Role": { - "target": "com.amazonaws.quicksight#Role", - "traits": { - "smithy.api#documentation": "

The name of the role whose permissions you want described.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that contains the role.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeRoleCustomPermissionResponse": { - "type": "structure", - "members": { - "CustomPermissionsName": { - "target": "com.amazonaws.quicksight#RoleName", - "traits": { - "smithy.api#documentation": "

The name of the custom permission that is described.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeTemplateRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a template's metadata.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeTemplateAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeTemplateAliasRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeTemplateAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the template alias for a template.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeTemplateAliasRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template alias that you're\n\t\t\tdescribing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The name of the template alias that you want to describe. If you name a specific alias, you\n\t\t\tdescribe the version that the alias points to. You can specify the latest version of the\n\t\t\ttemplate by providing the keyword $LATEST in the AliasName\n\t\t\tparameter. The keyword $PUBLISHED doesn't apply to templates.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeTemplateAliasResponse": { - "type": "structure", - "members": { - "TemplateAlias": { - "target": "com.amazonaws.quicksight#TemplateAlias", - "traits": { - "smithy.api#documentation": "

Information about the template alias.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeTemplateDefinition": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeTemplateDefinitionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeTemplateDefinitionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides a detailed description of the definition of a template.

\n \n

If you do not need to know details about the content of a template, for instance if you\n\t\t\t\tare trying to check the status of a recently created or updated template, use the\n\t\t\t\t\n DescribeTemplate\n instead.\n\t\t\t

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/definition", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeTemplateDefinitionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template. You must be using the\n\t\t\t Amazon Web Services account that the template is in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the template that you're describing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the template.

", - "smithy.api#httpQuery": "version-number" - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The alias of the template that you want to describe. If you name a specific alias, you\n\t\t\t describe the version that the alias points to. You can specify the latest version of the\n\t\t\t template by providing the keyword $LATEST in the AliasName\n\t\t\t parameter. The keyword $PUBLISHED doesn't apply to templates.

", - "smithy.api#httpQuery": "alias-name" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeTemplateDefinitionResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#TemplateName", - "traits": { - "smithy.api#documentation": "

The descriptive name of the template.

" - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the template described.

" - } - }, - "Errors": { - "target": "com.amazonaws.quicksight#TemplateErrorList", - "traits": { - "smithy.api#documentation": "

Errors associated with the template version.

" - } - }, - "ResourceStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

Status associated with the template.

\n " - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the theme of the template.

" - } - }, - "Definition": { - "target": "com.amazonaws.quicksight#TemplateVersionDefinition", - "traits": { - "smithy.api#documentation": "

The definition of the template.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeTemplatePermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeTemplatePermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeTemplatePermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes read and write permissions on a template.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeTemplatePermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template that you're describing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeTemplatePermissionsResponse": { - "type": "structure", - "members": { - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template.

" - } - }, - "TemplateArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions to be set on the template.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeTemplateRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template that you're describing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

(Optional) The number for the version to describe. If a VersionNumber parameter\n\t\t\tvalue isn't provided, the latest version of the template is described.

", - "smithy.api#httpQuery": "version-number" - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The alias of the template that you want to describe. If you name a specific alias, you\n\t\t\tdescribe the version that the alias points to. You can specify the latest version of the\n\t\t\ttemplate by providing the keyword $LATEST in the AliasName\n\t\t\tparameter. The keyword $PUBLISHED doesn't apply to templates.

", - "smithy.api#httpQuery": "alias-name" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeTemplateResponse": { - "type": "structure", - "members": { - "Template": { - "target": "com.amazonaws.quicksight#Template", - "traits": { - "smithy.api#documentation": "

The template structure for the object you want to describe.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeTheme": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeThemeRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeThemeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a theme.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeThemeAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeThemeAliasRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeThemeAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the alias for a theme.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeThemeAliasRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme alias that you're\n\t\t\tdescribing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The name of the theme alias that you want to describe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeThemeAliasResponse": { - "type": "structure", - "members": { - "ThemeAlias": { - "target": "com.amazonaws.quicksight#ThemeAlias", - "traits": { - "smithy.api#documentation": "

Information about the theme alias.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeThemePermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeThemePermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeThemePermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the read and write permissions for a theme.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeThemePermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme that you're describing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme that you want to describe permissions for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeThemePermissionsResponse": { - "type": "structure", - "members": { - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme.

" - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions set on the theme.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeThemeRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAndAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme that you're describing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number for the version to describe. If a VersionNumber parameter\n\t\t\tvalue isn't provided, the latest version of the theme is described.

", - "smithy.api#httpQuery": "version-number" - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The alias of the theme that you want to describe. If you name a specific alias, you\n\t\t\tdescribe the version that the alias points to. You can specify the latest version of the\n\t\t\ttheme by providing the keyword $LATEST in the AliasName\n\t\t\tparameter. The keyword $PUBLISHED doesn't apply to themes.

", - "smithy.api#httpQuery": "alias-name" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeThemeResponse": { - "type": "structure", - "members": { - "Theme": { - "target": "com.amazonaws.quicksight#Theme", - "traits": { - "smithy.api#documentation": "

The information about the theme that you are describing.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeTopic": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeTopicRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeTopicResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a topic.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeTopicPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeTopicPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeTopicPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the permissions of a topic.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeTopicPermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic that you want\n described.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeTopicPermissionsResponse": { - "type": "structure", - "members": { - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "TopicArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions that are configured to the topic.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeTopicRefresh": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeTopicRefreshRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeTopicRefreshResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the status of a topic refresh.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/refresh/{RefreshId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeTopicRefreshRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic whose refresh you want\n to describe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RefreshId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the refresh, which is performed when the topic is created or updated.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeTopicRefreshResponse": { - "type": "structure", - "members": { - "RefreshDetails": { - "target": "com.amazonaws.quicksight#TopicRefreshDetails", - "traits": { - "smithy.api#documentation": "

Details of the refresh, which is performed when the topic is created or updated.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeTopicRefreshSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeTopicRefreshScheduleRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeTopicRefreshScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a topic refresh schedule.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules/{DatasetId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeTopicRefreshScheduleRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that contains the refresh schedule that you want to describe. This\n ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DatasetId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeTopicRefreshScheduleResponse": { - "type": "structure", - "members": { - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that contains the refresh schedule that you want to describe. This\n ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "TopicArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "DatasetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "RefreshSchedule": { - "target": "com.amazonaws.quicksight#TopicRefreshSchedule", - "traits": { - "smithy.api#documentation": "

The definition of a refresh schedule.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeTopicRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeTopicResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "Topic": { - "target": "com.amazonaws.quicksight#TopicDetails", - "traits": { - "smithy.api#documentation": "

The definition of a topic.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeUserRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a user, given the user name.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeUserRequest": { - "type": "structure", - "members": { - "UserName": { - "target": "com.amazonaws.quicksight#UserName", - "traits": { - "smithy.api#documentation": "

The name of the user that you want to describe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeUserResponse": { - "type": "structure", - "members": { - "User": { - "target": "com.amazonaws.quicksight#User", - "traits": { - "smithy.api#documentation": "

The user name.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeVPCConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeVPCConnectionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeVPCConnectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a VPC connection.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeVPCConnectionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the account that contains the VPC connection that\n\t\t\tyou want described.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VPCConnectionId": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", - "traits": { - "smithy.api#documentation": "

The ID of the VPC connection that\n\t\t\tyou're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeVPCConnectionResponse": { - "type": "structure", - "members": { - "VPCConnection": { - "target": "com.amazonaws.quicksight#VPCConnection", - "traits": { - "smithy.api#documentation": "

A response object that provides information for the specified VPC connection.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DestinationParameterValueConfiguration": { - "type": "structure", - "members": { - "CustomValuesConfiguration": { - "target": "com.amazonaws.quicksight#CustomValuesConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration.

" - } - }, - "SelectAllValueOptions": { - "target": "com.amazonaws.quicksight#SelectAllValueOptions", - "traits": { - "smithy.api#documentation": "

The configuration that selects all options.

" - } - }, - "SourceParameterName": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The source parameter name of the destination parameter.

" - } - }, - "SourceField": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The source field ID of the destination parameter.

" - } - }, - "SourceColumn": { - "target": "com.amazonaws.quicksight#ColumnIdentifier" - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of destination parameter values.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#DimensionField": { - "type": "structure", - "members": { - "NumericalDimensionField": { - "target": "com.amazonaws.quicksight#NumericalDimensionField", - "traits": { - "smithy.api#documentation": "

The dimension type field with numerical type columns.

" - } - }, - "CategoricalDimensionField": { - "target": "com.amazonaws.quicksight#CategoricalDimensionField", - "traits": { - "smithy.api#documentation": "

The dimension type field with categorical type columns.

" - } - }, - "DateDimensionField": { - "target": "com.amazonaws.quicksight#DateDimensionField", - "traits": { - "smithy.api#documentation": "

The dimension type field with date type columns.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The dimension type field.

" - } - }, - "com.amazonaws.quicksight#DimensionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DimensionField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#DisplayFormat": { - "type": "enum", - "members": { - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - }, - "PERCENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENT" - } - }, - "CURRENCY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CURRENCY" - } - }, - "NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NUMBER" - } - }, - "DATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATE" - } - }, - "STRING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STRING" - } - } - } - }, - "com.amazonaws.quicksight#DisplayFormatOptions": { - "type": "structure", - "members": { - "UseBlankCellFormat": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates whether to use blank cell format.

" - } - }, - "BlankCellFormat": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

Determines the blank cell format.

" - } - }, - "DateFormat": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

Determines the DateTime format.

" - } - }, - "DecimalSeparator": { - "target": "com.amazonaws.quicksight#TopicNumericSeparatorSymbol", - "traits": { - "smithy.api#documentation": "

Determines the decimal separator.

" - } - }, - "GroupingSeparator": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

Determines the grouping separator.

" - } - }, - "UseGrouping": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates whether to use grouping.

" - } - }, - "FractionDigits": { - "target": "com.amazonaws.quicksight#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Determines the number of fraction digits.

" - } - }, - "Prefix": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The prefix value for a display format.

" - } - }, - "Suffix": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The suffix value for a display format.

" - } - }, - "UnitScaler": { - "target": "com.amazonaws.quicksight#NumberScale", - "traits": { - "smithy.api#documentation": "

The unit scaler. Valid values for this structure are: NONE,\n AUTO, THOUSANDS, MILLIONS,\n BILLIONS,\n and TRILLIONS.

" - } - }, - "NegativeFormat": { - "target": "com.amazonaws.quicksight#NegativeFormat", - "traits": { - "smithy.api#documentation": "

The negative format.

" - } - }, - "CurrencySymbol": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The currency symbol, such as USD.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents additional options for display formatting.

" - } - }, - "com.amazonaws.quicksight#DnsResolverList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#IPv4Address" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 15 - } - } - }, - "com.amazonaws.quicksight#Domain": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#DomainNotWhitelistedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The domain specified isn't on the allow list. All domains for embedded dashboards must be\n\t\t\tadded to the approved list by an Amazon QuickSight admin.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.quicksight#DonutCenterOptions": { - "type": "structure", - "members": { - "LabelVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines the visibility of the label in a donut chart. In the Amazon QuickSight console, this option is called 'Show total'.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.

" - } - }, - "com.amazonaws.quicksight#DonutOptions": { - "type": "structure", - "members": { - "ArcOptions": { - "target": "com.amazonaws.quicksight#ArcOptions", - "traits": { - "smithy.api#documentation": "

The option for define the arc of the chart shape. Valid values are as follows:

\n " - } - }, - "DonutCenterOptions": { - "target": "com.amazonaws.quicksight#DonutCenterOptions", - "traits": { - "smithy.api#documentation": "

The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options for configuring a donut chart or pie chart.

" - } - }, - "com.amazonaws.quicksight#Double": { - "type": "double", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.quicksight#DrillDownFilter": { - "type": "structure", - "members": { - "NumericEqualityFilter": { - "target": "com.amazonaws.quicksight#NumericEqualityDrillDownFilter", - "traits": { - "smithy.api#documentation": "

The numeric equality type drill down filter. This filter is used for number type columns.

" - } - }, - "CategoryFilter": { - "target": "com.amazonaws.quicksight#CategoryDrillDownFilter", - "traits": { - "smithy.api#documentation": "

The category type drill down filter. This filter is used for string type columns.

" - } - }, - "TimeRangeFilter": { - "target": "com.amazonaws.quicksight#TimeRangeDrillDownFilter", - "traits": { - "smithy.api#documentation": "

The time range drill down filter. This filter is used for date time columns.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The drill down filter for the column hierarchies.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#DrillDownFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DrillDownFilter" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#DropDownControlDisplayOptions": { - "type": "structure", - "members": { - "SelectAllOptions": { - "target": "com.amazonaws.quicksight#ListControlSelectAllOptions", - "traits": { - "smithy.api#documentation": "

The configuration of the Select all options in a\n dropdown control.

" - } - }, - "TitleOptions": { - "target": "com.amazonaws.quicksight#LabelOptions", - "traits": { - "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" - } - }, - "InfoIconLabelOptions": { - "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", - "traits": { - "smithy.api#documentation": "

The configuration of info icon label options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "com.amazonaws.quicksight#DynamicDefaultValue": { - "type": "structure", - "members": { - "UserNameColumn": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that contains the username.

" - } - }, - "GroupNameColumn": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that contains the group name.

" - } - }, - "DefaultValueColumn": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that contains the default value of each user or group.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines different defaults to the users or groups based on mapping.

" - } - }, - "com.amazonaws.quicksight#Edition": { - "type": "enum", - "members": { - "STANDARD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STANDARD" - } - }, - "ENTERPRISE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENTERPRISE" - } - }, - "ENTERPRISE_AND_Q": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENTERPRISE_AND_Q" - } - } - } - }, - "com.amazonaws.quicksight#EmbeddingIdentityType": { - "type": "enum", - "members": { - "IAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM" - } - }, - "QUICKSIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT" - } - }, - "ANONYMOUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ANONYMOUS" - } - } - } - }, - "com.amazonaws.quicksight#EmbeddingUrl": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#EmptyVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", - "smithy.api#required": {} - } - }, - "DataSetIdentifier": { - "target": "com.amazonaws.quicksight#DataSetIdentifier", - "traits": { - "smithy.api#documentation": "

The data set that is used in the empty visual. Every visual requires a dataset to render.

", - "smithy.api#required": {} - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An empty visual.

\n

Empty visuals are used in layouts but have not been configured to show any data. A new visual created in the Amazon QuickSight console is considered an EmptyVisual until a visual type is selected.

" - } - }, - "com.amazonaws.quicksight#Entity": { - "type": "structure", - "members": { - "Path": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The hierarchical path of the entity within the analysis, template, or dashboard definition tree.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object, structure, or sub-structure of an analysis, template, or dashboard.

" - } - }, - "com.amazonaws.quicksight#EntityList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Entity" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#EntryPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.quicksight#EntryPoint": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.quicksight#ErrorInfo": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.quicksight#IngestionErrorType", - "traits": { - "smithy.api#documentation": "

Error type.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

Error message.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Error information for the SPICE ingestion of a dataset.

" - } - }, - "com.amazonaws.quicksight#ExasolParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

The hostname or IP address of the Exasol data source.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

The port for the Exasol data source.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The required parameters for connecting to an Exasol data source.

" - } - }, - "com.amazonaws.quicksight#ExceptionResourceType": { - "type": "enum", - "members": { - "USER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "USER" - } - }, - "GROUP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GROUP" - } - }, - "NAMESPACE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NAMESPACE" - } - }, - "ACCOUNT_SETTINGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCOUNT_SETTINGS" - } - }, - "IAMPOLICY_ASSIGNMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAMPOLICY_ASSIGNMENT" - } - }, - "DATA_SOURCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_SOURCE" - } - }, - "DATA_SET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_SET" - } - }, - "VPC_CONNECTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VPC_CONNECTION" - } - }, - "INGESTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INGESTION" - } - } - } - }, - "com.amazonaws.quicksight#ExcludePeriodConfiguration": { - "type": "structure", - "members": { - "Amount": { - "target": "com.amazonaws.quicksight#Integer", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The amount or number of the exclude period.

", - "smithy.api#required": {} - } - }, - "Granularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The granularity or unit (day, month, year) of the exclude period.

", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.quicksight#WidgetStatus", - "traits": { - "smithy.api#documentation": "

The status of the exclude period. Choose from the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The exclude period of TimeRangeFilter or RelativeDatesFilter.

" - } - }, - "com.amazonaws.quicksight#ExplicitHierarchy": { - "type": "structure", - "members": { - "HierarchyId": { - "target": "com.amazonaws.quicksight#HierarchyId", - "traits": { - "smithy.api#documentation": "

The hierarchy ID of the explicit hierarchy.

", - "smithy.api#required": {} - } - }, - "Columns": { - "target": "com.amazonaws.quicksight#ExplicitHierarchyColumnList", - "traits": { - "smithy.api#documentation": "

The list of columns that define the explicit hierarchy.

", - "smithy.api#required": {} - } - }, - "DrillDownFilters": { - "target": "com.amazonaws.quicksight#DrillDownFilterList", - "traits": { - "smithy.api#documentation": "

The option that determines the drill down filters for the explicit hierarchy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.

" - } - }, - "com.amazonaws.quicksight#ExplicitHierarchyColumnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnIdentifier" - }, - "traits": { - "smithy.api#length": { - "min": 2, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#ExportHiddenFieldsOption": { - "type": "structure", - "members": { - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#DashboardBehavior", - "traits": { - "smithy.api#documentation": "

The status of the export hidden fields options of a dashbaord.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines if hidden fields are included in an exported dashboard.

" - } - }, - "com.amazonaws.quicksight#ExportToCSVOption": { - "type": "structure", - "members": { - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#DashboardBehavior", - "traits": { - "smithy.api#documentation": "

Availability status.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Export to .csv option.

" - } - }, - "com.amazonaws.quicksight#ExportWithHiddenFieldsOption": { - "type": "structure", - "members": { - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#DashboardBehavior", - "traits": { - "smithy.api#documentation": "

The status of the export with hidden fields options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines whether or not hidden fields are visible on exported dashbaords.

" - } - }, - "com.amazonaws.quicksight#Expression": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 4096 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#FailedKeyRegistrationEntries": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FailedKeyRegistrationEntry" - } - }, - "com.amazonaws.quicksight#FailedKeyRegistrationEntry": { - "type": "structure", - "members": { - "KeyArn": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ARN of the KMS key that failed to update.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A message that provides information about why a FailedKeyRegistrationEntry error occurred.

", - "smithy.api#required": {} - } - }, - "StatusCode": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of a FailedKeyRegistrationEntry error.

", - "smithy.api#required": {} - } - }, - "SenderFault": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A boolean that indicates whether a FailedKeyRegistrationEntry resulted from user error. If the value of this property is True, the error was caused by user error. If the value of this property is False, the error occurred on the backend. If your job continues fail and with a False\n SenderFault value, contact Amazon Web Services Support.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An entry that appears when a KeyRegistration update to Amazon QuickSight fails.

" - } - }, - "com.amazonaws.quicksight#FieldBasedTooltip": { - "type": "structure", - "members": { - "AggregationVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of Show aggregations.

" - } - }, - "TooltipTitleType": { - "target": "com.amazonaws.quicksight#TooltipTitleType", - "traits": { - "smithy.api#documentation": "

The type for the >tooltip title. Choose one of the following options:

\n " - } - }, - "TooltipFields": { - "target": "com.amazonaws.quicksight#TooltipItemList", - "traits": { - "smithy.api#documentation": "

The fields configuration in the\n tooltip.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The setup for the detailed tooltip.

" - } - }, - "com.amazonaws.quicksight#FieldFolder": { - "type": "structure", - "members": { - "description": { - "target": "com.amazonaws.quicksight#FieldFolderDescription", - "traits": { - "smithy.api#documentation": "

The description for a field folder.

" - } - }, - "columns": { - "target": "com.amazonaws.quicksight#FolderColumnList", - "traits": { - "smithy.api#documentation": "

A folder has a list of columns. A column can only be in one folder.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A FieldFolder element is a folder that contains fields and nested subfolders.

" - } - }, - "com.amazonaws.quicksight#FieldFolderDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.quicksight#FieldFolderMap": { - "type": "map", - "key": { - "target": "com.amazonaws.quicksight#FieldFolderPath" - }, - "value": { - "target": "com.amazonaws.quicksight#FieldFolder" - } - }, - "com.amazonaws.quicksight#FieldFolderPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.quicksight#FieldId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.quicksight#FieldLabelType": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

Indicates the field that is targeted by the field\n label.

" - } - }, - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the field label.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field label type.

" - } - }, - "com.amazonaws.quicksight#FieldOrderList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FieldId" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#FieldSeriesItem": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID of the field for which you are setting the axis binding.

", - "smithy.api#required": {} - } - }, - "AxisBinding": { - "target": "com.amazonaws.quicksight#AxisBinding", - "traits": { - "smithy.api#documentation": "

The axis that you are binding the field to.

", - "smithy.api#required": {} - } - }, - "Settings": { - "target": "com.amazonaws.quicksight#LineChartSeriesSettings", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of line series associated to the field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field series item configuration of a line chart.

" - } - }, - "com.amazonaws.quicksight#FieldSort": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The sort configuration target field.

", - "smithy.api#required": {} - } - }, - "Direction": { - "target": "com.amazonaws.quicksight#SortDirection", - "traits": { - "smithy.api#documentation": "

The sort direction. Choose one of the following\n options:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration for a field in a\n field well.

" - } - }, - "com.amazonaws.quicksight#FieldSortOptions": { - "type": "structure", - "members": { - "FieldSort": { - "target": "com.amazonaws.quicksight#FieldSort", - "traits": { - "smithy.api#documentation": "

The sort configuration for a field in a field well.

" - } - }, - "ColumnSort": { - "target": "com.amazonaws.quicksight#ColumnSort", - "traits": { - "smithy.api#documentation": "

The sort configuration for a column that is not used in a field well.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field sort options in a chart configuration.

" - } - }, - "com.amazonaws.quicksight#FieldSortOptionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FieldSortOptions" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#FieldTooltipItem": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The unique ID of the field that is targeted by the tooltip.

", - "smithy.api#required": {} - } - }, - "Label": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The label of the tooltip item.

" - } - }, - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the tooltip item.

" - } - }, - "TooltipTarget": { - "target": "com.amazonaws.quicksight#TooltipTarget", - "traits": { - "smithy.api#documentation": "

Determines the target of the field tooltip item in a combo chart visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The tooltip item for the fields.

" - } - }, - "com.amazonaws.quicksight#FieldValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2048 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#FileFormat": { - "type": "enum", - "members": { - "CSV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CSV" - } - }, - "TSV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TSV" - } - }, - "CLF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLF" - } - }, - "ELF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ELF" - } - }, - "XLSX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "XLSX" - } - }, - "JSON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JSON" - } - } - } - }, - "com.amazonaws.quicksight#FilledMapAggregatedFieldWells": { - "type": "structure", - "members": { - "Geospatial": { - "target": "com.amazonaws.quicksight#FilledMapDimensionFieldList", - "traits": { - "smithy.api#documentation": "

The aggregated location field well of the filled map. Values are grouped by location fields.

" - } - }, - "Values": { - "target": "com.amazonaws.quicksight#FilledMapMeasureFieldList", - "traits": { - "smithy.api#documentation": "

The aggregated color field well of a filled map. Values are aggregated based on location fields.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The aggregated field well of the filled map.

" - } - }, - "com.amazonaws.quicksight#FilledMapConditionalFormatting": { - "type": "structure", - "members": { - "ConditionalFormattingOptions": { - "target": "com.amazonaws.quicksight#FilledMapConditionalFormattingOptionList", - "traits": { - "smithy.api#documentation": "

Conditional formatting options of a FilledMapVisual.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting of a FilledMapVisual.

" - } - }, - "com.amazonaws.quicksight#FilledMapConditionalFormattingOption": { - "type": "structure", - "members": { - "Shape": { - "target": "com.amazonaws.quicksight#FilledMapShapeConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The conditional formatting that determines the shape of the filled map.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Conditional formatting options of a FilledMapVisual.

" - } - }, - "com.amazonaws.quicksight#FilledMapConditionalFormattingOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FilledMapConditionalFormattingOption" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#FilledMapConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#FilledMapFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#FilledMapSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a FilledMapVisual.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "

The legend display setup of the visual.

" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The tooltip display setup of the visual.

" - } - }, - "WindowOptions": { - "target": "com.amazonaws.quicksight#GeospatialWindowOptions", - "traits": { - "smithy.api#documentation": "

The window options of the filled map visual.

" - } - }, - "MapStyleOptions": { - "target": "com.amazonaws.quicksight#GeospatialMapStyleOptions", - "traits": { - "smithy.api#documentation": "

The map style options of the filled map visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for a FilledMapVisual.

" - } - }, - "com.amazonaws.quicksight#FilledMapDimensionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DimensionField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#FilledMapFieldWells": { - "type": "structure", - "members": { - "FilledMapAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#FilledMapAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field well of the filled map.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field wells of a FilledMapVisual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#FilledMapMeasureFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MeasureField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#FilledMapShapeConditionalFormatting": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID of the filled map shape.

", - "smithy.api#required": {} - } - }, - "Format": { - "target": "com.amazonaws.quicksight#ShapeConditionalFormat", - "traits": { - "smithy.api#documentation": "

The conditional formatting that determines the background color of a filled map's shape.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting that determines the shape of the filled map.

" - } - }, - "com.amazonaws.quicksight#FilledMapSortConfiguration": { - "type": "structure", - "members": { - "CategorySort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the location fields.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a FilledMapVisual.

" - } - }, - "com.amazonaws.quicksight#FilledMapVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#FilledMapConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the visual.

" - } - }, - "ConditionalFormatting": { - "target": "com.amazonaws.quicksight#FilledMapConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The conditional formatting of a FilledMapVisual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A filled map.

\n

For more information, see Creating filled maps in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#Filter": { - "type": "structure", - "members": { - "CategoryFilter": { - "target": "com.amazonaws.quicksight#CategoryFilter", - "traits": { - "smithy.api#documentation": "

A CategoryFilter filters text values.

\n

For more information, see Adding text filters in the Amazon QuickSight User Guide.

" - } - }, - "NumericRangeFilter": { - "target": "com.amazonaws.quicksight#NumericRangeFilter", - "traits": { - "smithy.api#documentation": "

A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.

" - } - }, - "NumericEqualityFilter": { - "target": "com.amazonaws.quicksight#NumericEqualityFilter", - "traits": { - "smithy.api#documentation": "

A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.

" - } - }, - "TimeEqualityFilter": { - "target": "com.amazonaws.quicksight#TimeEqualityFilter", - "traits": { - "smithy.api#documentation": "

A TimeEqualityFilter filters date-time values that equal or do not equal\n a given date/time value.

" - } - }, - "TimeRangeFilter": { - "target": "com.amazonaws.quicksight#TimeRangeFilter", - "traits": { - "smithy.api#documentation": "

A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.

" - } - }, - "RelativeDatesFilter": { - "target": "com.amazonaws.quicksight#RelativeDatesFilter", - "traits": { - "smithy.api#documentation": "

A RelativeDatesFilter filters date values that are relative to a given date.

" - } - }, - "TopBottomFilter": { - "target": "com.amazonaws.quicksight#TopBottomFilter", - "traits": { - "smithy.api#documentation": "

A TopBottomFilter filters data to the top or bottom values for a given column.

" - } - }, - "NestedFilter": { - "target": "com.amazonaws.quicksight#NestedFilter", - "traits": { - "smithy.api#documentation": "

A NestedFilter filters data with a subset of data that is defined by the nested inner filter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

With a Filter, you can remove portions of data from a particular visual or view.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#FilterAggMetrics": { - "type": "structure", - "members": { - "MetricOperand": { - "target": "com.amazonaws.quicksight#Identifier", - "traits": { - "smithy.api#documentation": "

The metric operand of the FilterAggMetrics.

" - } - }, - "Function": { - "target": "com.amazonaws.quicksight#AggType", - "traits": { - "smithy.api#documentation": "

The function for the FilterAggMetrics.

" - } - }, - "SortDirection": { - "target": "com.amazonaws.quicksight#TopicSortDirection", - "traits": { - "smithy.api#documentation": "

The sort direction for FilterAggMetrics.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for the FilterAggMetrics.

" - } - }, - "com.amazonaws.quicksight#FilterAggMetricsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FilterAggMetrics" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#FilterClass": { - "type": "enum", - "members": { - "ENFORCED_VALUE_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENFORCED_VALUE_FILTER" - } - }, - "CONDITIONAL_VALUE_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONDITIONAL_VALUE_FILTER" - } - }, - "NAMED_VALUE_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NAMED_VALUE_FILTER" - } - } - } - }, - "com.amazonaws.quicksight#FilterControl": { - "type": "structure", - "members": { - "DateTimePicker": { - "target": "com.amazonaws.quicksight#FilterDateTimePickerControl", - "traits": { - "smithy.api#documentation": "

A control from a date filter that is used to specify date and time.

" - } - }, - "List": { - "target": "com.amazonaws.quicksight#FilterListControl", - "traits": { - "smithy.api#documentation": "

A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.

" - } - }, - "Dropdown": { - "target": "com.amazonaws.quicksight#FilterDropDownControl", - "traits": { - "smithy.api#documentation": "

A control to display a dropdown list with buttons that are used to select a single value.

" - } - }, - "TextField": { - "target": "com.amazonaws.quicksight#FilterTextFieldControl", - "traits": { - "smithy.api#documentation": "

A control to display a text box that is used to enter a single entry.

" - } - }, - "TextArea": { - "target": "com.amazonaws.quicksight#FilterTextAreaControl", - "traits": { - "smithy.api#documentation": "

A control to display a text box that is used to enter multiple entries.

" - } - }, - "Slider": { - "target": "com.amazonaws.quicksight#FilterSliderControl", - "traits": { - "smithy.api#documentation": "

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

" - } - }, - "RelativeDateTime": { - "target": "com.amazonaws.quicksight#FilterRelativeDateTimeControl", - "traits": { - "smithy.api#documentation": "

A control from a date filter that is used to specify the relative date.

" - } - }, - "CrossSheet": { - "target": "com.amazonaws.quicksight#FilterCrossSheetControl", - "traits": { - "smithy.api#documentation": "

A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The control of a filter that is used to interact with a dashboard or an analysis.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#FilterControlList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FilterControl" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#FilterCrossSheetControl": { - "type": "structure", - "members": { - "FilterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the FilterCrossSheetControl.

", - "smithy.api#required": {} - } - }, - "SourceFilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The source filter ID of the FilterCrossSheetControl.

", - "smithy.api#required": {} - } - }, - "CascadingControlConfiguration": { - "target": "com.amazonaws.quicksight#CascadingControlConfiguration", - "traits": { - "smithy.api#documentation": "

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet

" - } - }, - "com.amazonaws.quicksight#FilterDateTimePickerControl": { - "type": "structure", - "members": { - "FilterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the FilterDateTimePickerControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the FilterDateTimePickerControl.

", - "smithy.api#required": {} - } - }, - "SourceFilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The source filter ID of the FilterDateTimePickerControl.

", - "smithy.api#required": {} - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#DateTimePickerControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#SheetControlDateTimePickerType", - "traits": { - "smithy.api#documentation": "

The type of the FilterDropDownControl. Choose one of the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

A control from a date filter that is used to specify date and time.

" - } - }, - "com.amazonaws.quicksight#FilterDropDownControl": { - "type": "structure", - "members": { - "FilterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the FilterDropDownControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the FilterDropDownControl.

", - "smithy.api#required": {} - } - }, - "SourceFilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The source filter ID of the FilterDropDownControl.

", - "smithy.api#required": {} - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#DropDownControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of the FilterDropDownControl.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#SheetControlListType", - "traits": { - "smithy.api#documentation": "

The type of the FilterDropDownControl. Choose one of the following options:

\n " - } - }, - "SelectableValues": { - "target": "com.amazonaws.quicksight#FilterSelectableValues", - "traits": { - "smithy.api#documentation": "

A list of selectable values that are used in a control.

" - } - }, - "CascadingControlConfiguration": { - "target": "com.amazonaws.quicksight#CascadingControlConfiguration", - "traits": { - "smithy.api#documentation": "

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control to display a dropdown list with buttons that are used to select a single value.

" - } - }, - "com.amazonaws.quicksight#FilterGroup": { - "type": "structure", - "members": { - "FilterGroupId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.quicksight#FilterList", - "traits": { - "smithy.api#documentation": "

The list of filters that are present in a FilterGroup.

", - "smithy.api#required": {} - } - }, - "ScopeConfiguration": { - "target": "com.amazonaws.quicksight#FilterScopeConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration that specifies what scope to apply to a FilterGroup.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.quicksight#WidgetStatus", - "traits": { - "smithy.api#documentation": "

The status of the FilterGroup.

" - } - }, - "CrossDataset": { - "target": "com.amazonaws.quicksight#CrossDatasetTypes", - "traits": { - "smithy.api#documentation": "

The filter new feature which can apply filter group to all data sets. Choose one of the following options:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A grouping of individual filters. Filter groups are applied to the same group of visuals.

\n

For more information, see Adding filter conditions (group filters) with AND and OR operators in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#FilterGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FilterGroup" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2000 - } - } - }, - "com.amazonaws.quicksight#FilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Filter" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#FilterListConfiguration": { - "type": "structure", - "members": { - "MatchOperator": { - "target": "com.amazonaws.quicksight#CategoryFilterMatchOperator", - "traits": { - "smithy.api#documentation": "

The match operator that is used to determine if a filter should be applied.

", - "smithy.api#required": {} - } - }, - "CategoryValues": { - "target": "com.amazonaws.quicksight#CategoryValueList", - "traits": { - "smithy.api#documentation": "

The list of category values for the filter.

" - } - }, - "SelectAllOptions": { - "target": "com.amazonaws.quicksight#CategoryFilterSelectAllOptions", - "traits": { - "smithy.api#documentation": "

Select all of the values. Null is not the assigned value of select all.

\n " - } - }, - "NullOption": { - "target": "com.amazonaws.quicksight#FilterNullOption", - "traits": { - "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

A list of filter configurations.

" - } - }, - "com.amazonaws.quicksight#FilterListControl": { - "type": "structure", - "members": { - "FilterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the FilterListControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the FilterListControl.

", - "smithy.api#required": {} - } - }, - "SourceFilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The source filter ID of the FilterListControl.

", - "smithy.api#required": {} - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#ListControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#SheetControlListType", - "traits": { - "smithy.api#documentation": "

The type of the FilterListControl. Choose one of the following options:

\n " - } - }, - "SelectableValues": { - "target": "com.amazonaws.quicksight#FilterSelectableValues", - "traits": { - "smithy.api#documentation": "

A list of selectable values that are used in a control.

" - } - }, - "CascadingControlConfiguration": { - "target": "com.amazonaws.quicksight#CascadingControlConfiguration", - "traits": { - "smithy.api#documentation": "

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.

" - } - }, - "com.amazonaws.quicksight#FilterNullOption": { - "type": "enum", - "members": { - "ALL_VALUES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL_VALUES" - } - }, - "NULLS_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NULLS_ONLY" - } - }, - "NON_NULLS_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NON_NULLS_ONLY" - } - } - } - }, - "com.amazonaws.quicksight#FilterOperation": { - "type": "structure", - "members": { - "ConditionExpression": { - "target": "com.amazonaws.quicksight#Expression", - "traits": { - "smithy.api#documentation": "

An expression that must evaluate to a Boolean value. Rows for which the expression\n evaluates to true are kept in the dataset.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A transform operation that filters rows based on a condition.

" - } - }, - "com.amazonaws.quicksight#FilterOperationSelectedFieldsConfiguration": { - "type": "structure", - "members": { - "SelectedFields": { - "target": "com.amazonaws.quicksight#SelectedFieldList", - "traits": { - "smithy.api#documentation": "

Chooses the fields that are filtered in CustomActionFilterOperation.

" - } - }, - "SelectedFieldOptions": { - "target": "com.amazonaws.quicksight#SelectedFieldOptions", - "traits": { - "smithy.api#documentation": "

A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation.

\n

Valid values are defined as follows:

\n " - } - }, - "SelectedColumns": { - "target": "com.amazonaws.quicksight#CustomActionColumnList", - "traits": { - "smithy.api#documentation": "

The selected columns of a dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of selected fields in theCustomActionFilterOperation.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#FilterOperationTargetVisualsConfiguration": { - "type": "structure", - "members": { - "SameSheetTargetVisualConfiguration": { - "target": "com.amazonaws.quicksight#SameSheetTargetVisualConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of the same-sheet target visuals that you want to be filtered.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of target visuals that you want to be filtered.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#FilterOperator": { - "type": "enum", - "members": { - "StringEquals": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StringEquals" - } - }, - "StringLike": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StringLike" - } - } - } - }, - "com.amazonaws.quicksight#FilterRelativeDateTimeControl": { - "type": "structure", - "members": { - "FilterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the FilterTextAreaControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the FilterTextAreaControl.

", - "smithy.api#required": {} - } - }, - "SourceFilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The source filter ID of the FilterTextAreaControl.

", - "smithy.api#required": {} - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#RelativeDateTimeControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control from a date filter that is used to specify the relative date.

" - } - }, - "com.amazonaws.quicksight#FilterScopeConfiguration": { - "type": "structure", - "members": { - "SelectedSheets": { - "target": "com.amazonaws.quicksight#SelectedSheetsFilterScopeConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration for applying a filter to specific sheets.

" - } - }, - "AllSheets": { - "target": "com.amazonaws.quicksight#AllSheetsFilterScopeConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration that applies a filter to all sheets. When you choose AllSheets as the value for a FilterScopeConfiguration, this filter is applied to all visuals of all sheets in an Analysis, Dashboard, or Template. The AllSheetsFilterScopeConfiguration is chosen.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The scope configuration for a FilterGroup.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#FilterSelectableValues": { - "type": "structure", - "members": { - "Values": { - "target": "com.amazonaws.quicksight#ParameterSelectableValueList", - "traits": { - "smithy.api#documentation": "

The values that are used in the FilterSelectableValues.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A list of selectable values that are used in a control.

" - } - }, - "com.amazonaws.quicksight#FilterSliderControl": { - "type": "structure", - "members": { - "FilterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the FilterSliderControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the FilterSliderControl.

", - "smithy.api#required": {} - } - }, - "SourceFilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The source filter ID of the FilterSliderControl.

", - "smithy.api#required": {} - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#SliderControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#SheetControlSliderType", - "traits": { - "smithy.api#documentation": "

The type of the FilterSliderControl. Choose one of the following options:

\n " - } - }, - "MaximumValue": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The larger value that is displayed at the right of the slider.

", - "smithy.api#required": {} - } - }, - "MinimumValue": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The smaller value that is displayed at the left of the slider.

", - "smithy.api#required": {} - } - }, - "StepSize": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of increments that the slider bar is divided into.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

" - } - }, - "com.amazonaws.quicksight#FilterTextAreaControl": { - "type": "structure", - "members": { - "FilterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the FilterTextAreaControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the FilterTextAreaControl.

", - "smithy.api#required": {} - } - }, - "SourceFilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The source filter ID of the FilterTextAreaControl.

", - "smithy.api#required": {} - } - }, - "Delimiter": { - "target": "com.amazonaws.quicksight#TextAreaControlDelimiter", - "traits": { - "smithy.api#documentation": "

The delimiter that is used to separate the lines in text.

" - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#TextAreaControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control to display a text box that is used to enter multiple entries.

" - } - }, - "com.amazonaws.quicksight#FilterTextFieldControl": { - "type": "structure", - "members": { - "FilterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the FilterTextFieldControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the FilterTextFieldControl.

", - "smithy.api#required": {} - } - }, - "SourceFilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The source filter ID of the FilterTextFieldControl.

", - "smithy.api#required": {} - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#TextFieldControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control to display a text box that is used to enter a single entry.

" - } - }, - "com.amazonaws.quicksight#FilterVisualScope": { - "type": "enum", - "members": { - "ALL_VISUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL_VISUALS" - } - }, - "SELECTED_VISUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SELECTED_VISUALS" - } - } - } - }, - "com.amazonaws.quicksight#FilteredVisualsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#Folder": { - "type": "structure", - "members": { - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the folder.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#FolderName", - "traits": { - "smithy.api#documentation": "

A display name for the folder.

" - } - }, - "FolderType": { - "target": "com.amazonaws.quicksight#FolderType", - "traits": { - "smithy.api#documentation": "

The type of folder it is.

" - } - }, - "FolderPath": { - "target": "com.amazonaws.quicksight#Path", - "traits": { - "smithy.api#documentation": "

An array of ancestor ARN strings for the folder.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the folder was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the folder was last updated.

" - } - }, - "SharingModel": { - "target": "com.amazonaws.quicksight#SharingModel", - "traits": { - "smithy.api#documentation": "

The sharing scope of the folder.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A folder in Amazon QuickSight.

" - } - }, - "com.amazonaws.quicksight#FolderArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Arn" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#FolderColumnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#String" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5000 - } - } - }, - "com.amazonaws.quicksight#FolderFilterAttribute": { - "type": "enum", - "members": { - "PARENT_FOLDER_ARN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARENT_FOLDER_ARN" - } - }, - "DIRECT_QUICKSIGHT_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_OWNER" - } - }, - "DIRECT_QUICKSIGHT_SOLE_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_SOLE_OWNER" - } - }, - "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" - } - }, - "QUICKSIGHT_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT_OWNER" - } - }, - "QUICKSIGHT_VIEWER_OR_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT_VIEWER_OR_OWNER" - } - }, - "FOLDER_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FOLDER_NAME" - } - } - } - }, - "com.amazonaws.quicksight#FolderMember": { - "type": "structure", - "members": { - "MemberId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of an asset in the folder.

" - } - }, - "MemberType": { - "target": "com.amazonaws.quicksight#MemberType", - "traits": { - "smithy.api#documentation": "

The type of asset that it is.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An asset in a Amazon QuickSight folder, such as a dashboard, analysis, or dataset.

" - } - }, - "com.amazonaws.quicksight#FolderMemberList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MemberIdArnPair" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#FolderName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#FolderSearchFilter": { - "type": "structure", - "members": { - "Operator": { - "target": "com.amazonaws.quicksight#FilterOperator", - "traits": { - "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\": \"StringEquals\". Valid values are \"StringEquals\" and \"StringLike\".

\n

If you set the operator value to \"StringEquals\", you need to provide an ownership related filter in the \"NAME\" field and the arn of the user or group whose folders you want to search in the \"Value\" field. For example, \"Name\":\"DIRECT_QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

\n

If you set the value to \"StringLike\", you need to provide the name of the folders you are searching for. For example, \"Name\":\"FOLDER_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\". The \"StringLike\" operator only supports the NAME value FOLDER_NAME.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#FolderFilterAttribute", - "traits": { - "smithy.api#documentation": "

The name of a value that you want to use in the filter. For example, \"Name\": \"QUICKSIGHT_OWNER\".

\n

Valid values are defined as follows:

\n " - } - }, - "Value": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The value of the named item (in this example, PARENT_FOLDER_ARN), that you want to use as a filter. For example, \"Value\": \"arn:aws:quicksight:us-east-1:1:folder/folderId\".

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A filter to use to search an Amazon QuickSight folder.

" - } - }, - "com.amazonaws.quicksight#FolderSearchFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FolderSearchFilter" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#FolderSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the folder.

" - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#FolderName", - "traits": { - "smithy.api#documentation": "

The display name of the folder.

" - } - }, - "FolderType": { - "target": "com.amazonaws.quicksight#FolderType", - "traits": { - "smithy.api#documentation": "

The type of folder.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the folder was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the folder was last updated.

" - } - }, - "SharingModel": { - "target": "com.amazonaws.quicksight#SharingModel", - "traits": { - "smithy.api#documentation": "

The sharing scope of the folder.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A summary of information about an existing Amazon QuickSight folder.

" - } - }, - "com.amazonaws.quicksight#FolderSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FolderSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#FolderType": { - "type": "enum", - "members": { - "SHARED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SHARED" - } - }, - "RESTRICTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESTRICTED" - } - } - } - }, - "com.amazonaws.quicksight#Font": { - "type": "structure", - "members": { - "FontFamily": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

Determines the font family settings.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines the font settings.

" - } - }, - "com.amazonaws.quicksight#FontConfiguration": { - "type": "structure", - "members": { - "FontSize": { - "target": "com.amazonaws.quicksight#FontSize", - "traits": { - "smithy.api#documentation": "

The option that determines the text display size.

" - } - }, - "FontDecoration": { - "target": "com.amazonaws.quicksight#FontDecoration", - "traits": { - "smithy.api#documentation": "

Determines the appearance of decorative lines on the text.

" - } - }, - "FontColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

Determines the color of the text.

" - } - }, - "FontWeight": { - "target": "com.amazonaws.quicksight#FontWeight", - "traits": { - "smithy.api#documentation": "

The option that determines the text display weight, or boldness.

" - } - }, - "FontStyle": { - "target": "com.amazonaws.quicksight#FontStyle", - "traits": { - "smithy.api#documentation": "

Determines the text display face that is inherited by the given font family.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configures the display properties of the given text.

" - } - }, - "com.amazonaws.quicksight#FontDecoration": { - "type": "enum", - "members": { - "UNDERLINE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNDERLINE" - } - }, - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - } - } - }, - "com.amazonaws.quicksight#FontList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Font" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.quicksight#FontSize": { - "type": "structure", - "members": { - "Relative": { - "target": "com.amazonaws.quicksight#RelativeFontSize", - "traits": { - "smithy.api#documentation": "

The lexical name for the text size, proportional to its surrounding context.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The option that determines the text display size.

" - } - }, - "com.amazonaws.quicksight#FontStyle": { - "type": "enum", - "members": { - "NORMAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NORMAL" - } - }, - "ITALIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ITALIC" - } - } - } - }, - "com.amazonaws.quicksight#FontWeight": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#FontWeightName", - "traits": { - "smithy.api#documentation": "

The lexical name for the level of boldness of the text display.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The option that determines the text display weight, or boldness.

" - } - }, - "com.amazonaws.quicksight#FontWeightName": { - "type": "enum", - "members": { - "NORMAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NORMAL" - } - }, - "BOLD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOLD" - } - } - } - }, - "com.amazonaws.quicksight#ForecastComputation": { - "type": "structure", - "members": { - "ComputationId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for a computation.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of a computation.

" - } - }, - "Time": { - "target": "com.amazonaws.quicksight#DimensionField", - "traits": { - "smithy.api#documentation": "

The time field that is used in a computation.

" - } - }, - "Value": { - "target": "com.amazonaws.quicksight#MeasureField", - "traits": { - "smithy.api#documentation": "

The value field that is used in a computation.

" - } - }, - "PeriodsForward": { - "target": "com.amazonaws.quicksight#PeriodsForward", - "traits": { - "smithy.api#documentation": "

The periods forward setup of a forecast computation.

" - } - }, - "PeriodsBackward": { - "target": "com.amazonaws.quicksight#PeriodsBackward", - "traits": { - "smithy.api#documentation": "

The periods backward setup of a forecast computation.

" - } - }, - "UpperBoundary": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The upper boundary setup of a forecast computation.

" - } - }, - "LowerBoundary": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The lower boundary setup of a forecast computation.

" - } - }, - "PredictionInterval": { - "target": "com.amazonaws.quicksight#PredictionInterval", - "traits": { - "smithy.api#documentation": "

The prediction interval setup of a forecast computation.

" - } - }, - "Seasonality": { - "target": "com.amazonaws.quicksight#ForecastComputationSeasonality", - "traits": { - "smithy.api#documentation": "

The seasonality setup of a forecast computation. Choose one of the following options:

\n " - } - }, - "CustomSeasonalityValue": { - "target": "com.amazonaws.quicksight#ForecastComputationCustomSeasonalityValue", - "traits": { - "smithy.api#documentation": "

The custom seasonality value setup of a forecast computation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The forecast computation configuration.

" - } - }, - "com.amazonaws.quicksight#ForecastComputationCustomSeasonalityValue": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 180 - } - } - }, - "com.amazonaws.quicksight#ForecastComputationSeasonality": { - "type": "enum", - "members": { - "AUTOMATIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTOMATIC" - } - }, - "CUSTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM" - } - } - } - }, - "com.amazonaws.quicksight#ForecastConfiguration": { - "type": "structure", - "members": { - "ForecastProperties": { - "target": "com.amazonaws.quicksight#TimeBasedForecastProperties", - "traits": { - "smithy.api#documentation": "

The forecast properties setup of a forecast in the line\n chart.

" - } - }, - "Scenario": { - "target": "com.amazonaws.quicksight#ForecastScenario", - "traits": { - "smithy.api#documentation": "

The forecast scenario of a forecast in the line chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The forecast configuration that is used in a line chart's display properties.

" - } - }, - "com.amazonaws.quicksight#ForecastConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ForecastConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#ForecastScenario": { - "type": "structure", - "members": { - "WhatIfPointScenario": { - "target": "com.amazonaws.quicksight#WhatIfPointScenario", - "traits": { - "smithy.api#documentation": "

The what-if analysis forecast setup with the target date.

" - } - }, - "WhatIfRangeScenario": { - "target": "com.amazonaws.quicksight#WhatIfRangeScenario", - "traits": { - "smithy.api#documentation": "

The what-if analysis forecast setup with the date range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The forecast scenario of a forecast in the line chart.

" - } - }, - "com.amazonaws.quicksight#FormatConfiguration": { - "type": "structure", - "members": { - "StringFormatConfiguration": { - "target": "com.amazonaws.quicksight#StringFormatConfiguration", - "traits": { - "smithy.api#documentation": "

Formatting configuration for string fields.

" - } - }, - "NumberFormatConfiguration": { - "target": "com.amazonaws.quicksight#NumberFormatConfiguration", - "traits": { - "smithy.api#documentation": "

Formatting configuration for number fields.

" - } - }, - "DateTimeFormatConfiguration": { - "target": "com.amazonaws.quicksight#DateTimeFormatConfiguration", - "traits": { - "smithy.api#documentation": "

Formatting configuration for DateTime fields.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The formatting configuration for all types of field.

" - } - }, - "com.amazonaws.quicksight#FreeFormLayoutCanvasSizeOptions": { - "type": "structure", - "members": { - "ScreenCanvasSizeOptions": { - "target": "com.amazonaws.quicksight#FreeFormLayoutScreenCanvasSizeOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the sizing of the canvas used in a free-form layout.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration options for the canvas of a free-form layout.

" - } - }, - "com.amazonaws.quicksight#FreeFormLayoutConfiguration": { - "type": "structure", - "members": { - "Elements": { - "target": "com.amazonaws.quicksight#FreeFromLayoutElementList", - "traits": { - "smithy.api#documentation": "

The elements that are included in a free-form layout.

", - "smithy.api#required": {} - } - }, - "CanvasSizeOptions": { - "target": "com.amazonaws.quicksight#FreeFormLayoutCanvasSizeOptions" - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a free-form layout.

" - } - }, - "com.amazonaws.quicksight#FreeFormLayoutElement": { - "type": "structure", - "members": { - "ElementId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

A unique identifier for an element within a free-form layout.

", - "smithy.api#required": {} - } - }, - "ElementType": { - "target": "com.amazonaws.quicksight#LayoutElementType", - "traits": { - "smithy.api#documentation": "

The type of element.

", - "smithy.api#required": {} - } - }, - "XAxisLocation": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The x-axis coordinate of the element.

", - "smithy.api#required": {} - } - }, - "YAxisLocation": { - "target": "com.amazonaws.quicksight#UnlimitedPixelLength", - "traits": { - "smithy.api#documentation": "

The y-axis coordinate of the element.

", - "smithy.api#required": {} - } - }, - "Width": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The width of an element within a free-form layout.

", - "smithy.api#required": {} - } - }, - "Height": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The height of an element within a free-form layout.

", - "smithy.api#required": {} - } - }, - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of an element within a free-form layout.

" - } - }, - "RenderingRules": { - "target": "com.amazonaws.quicksight#SheetElementRenderingRuleList", - "traits": { - "smithy.api#documentation": "

The rendering rules that determine when an element should be displayed within a free-form layout.

" - } - }, - "BorderStyle": { - "target": "com.amazonaws.quicksight#FreeFormLayoutElementBorderStyle", - "traits": { - "smithy.api#documentation": "

The border style configuration of a free-form layout element.

" - } - }, - "SelectedBorderStyle": { - "target": "com.amazonaws.quicksight#FreeFormLayoutElementBorderStyle", - "traits": { - "smithy.api#documentation": "

The border style configuration of a free-form layout element. This border style is used when the element is selected.

" - } - }, - "BackgroundStyle": { - "target": "com.amazonaws.quicksight#FreeFormLayoutElementBackgroundStyle", - "traits": { - "smithy.api#documentation": "

The background style configuration of a free-form layout element.

" - } - }, - "LoadingAnimation": { - "target": "com.amazonaws.quicksight#LoadingAnimation", - "traits": { - "smithy.api#documentation": "

The loading animation configuration of a free-form layout element.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An element within a free-form layout.

" - } - }, - "com.amazonaws.quicksight#FreeFormLayoutElementBackgroundStyle": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The background visibility of a free-form layout element.

" - } - }, - "Color": { - "target": "com.amazonaws.quicksight#HexColorWithTransparency", - "traits": { - "smithy.api#documentation": "

The background color of a free-form layout element.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The background style configuration of a free-form layout element.

" - } - }, - "com.amazonaws.quicksight#FreeFormLayoutElementBorderStyle": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The border visibility of a free-form layout element.

" - } - }, - "Color": { - "target": "com.amazonaws.quicksight#HexColorWithTransparency", - "traits": { - "smithy.api#documentation": "

The border color of a free-form layout element.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The background style configuration of a free-form layout element.

" - } - }, - "com.amazonaws.quicksight#FreeFormLayoutScreenCanvasSizeOptions": { - "type": "structure", - "members": { - "OptimizedViewPortWidth": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The width that the view port will be optimized for when the layout renders.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the sizing of the canvas used in a free-form layout.

" - } - }, - "com.amazonaws.quicksight#FreeFormSectionLayoutConfiguration": { - "type": "structure", - "members": { - "Elements": { - "target": "com.amazonaws.quicksight#FreeFromLayoutElementList", - "traits": { - "smithy.api#documentation": "

The elements that are included in the free-form layout.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The free-form layout configuration of a section.

" - } - }, - "com.amazonaws.quicksight#FreeFromLayoutElementList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FreeFormLayoutElement" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 430 - } - } - }, - "com.amazonaws.quicksight#FunnelChartAggregatedFieldWells": { - "type": "structure", - "members": { - "Category": { - "target": "com.amazonaws.quicksight#FunnelChartDimensionFieldList", - "traits": { - "smithy.api#documentation": "

The category field wells of a funnel chart. Values are grouped by category fields.

" - } - }, - "Values": { - "target": "com.amazonaws.quicksight#FunnelChartMeasureFieldList", - "traits": { - "smithy.api#documentation": "

The value field wells of a funnel chart. Values are aggregated based on categories.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a FunnelChartVisual.

" - } - }, - "com.amazonaws.quicksight#FunnelChartConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#FunnelChartFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a FunnelChartVisual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#FunnelChartSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a FunnelChartVisual.

" - } - }, - "CategoryLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options of the categories that are displayed in a FunnelChartVisual.

" - } - }, - "ValueLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options for the values that are displayed in a FunnelChartVisual.

" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The tooltip configuration of a FunnelChartVisual.

" - } - }, - "DataLabelOptions": { - "target": "com.amazonaws.quicksight#FunnelChartDataLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the data labels.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "

The visual palette configuration of a FunnelChartVisual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a FunnelChartVisual.

" - } - }, - "com.amazonaws.quicksight#FunnelChartDataLabelOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility option that determines if data labels are displayed.

" - } - }, - "CategoryLabelVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the category labels within the data labels.

" - } - }, - "MeasureLabelVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the measure labels within the data labels.

" - } - }, - "Position": { - "target": "com.amazonaws.quicksight#DataLabelPosition", - "traits": { - "smithy.api#documentation": "

Determines the positioning of the data label relative to a section of the funnel.

" - } - }, - "LabelFontConfiguration": { - "target": "com.amazonaws.quicksight#FontConfiguration", - "traits": { - "smithy.api#documentation": "

The font configuration for the data labels.

\n

Only the FontSize attribute of the font configuration is used for data labels.

" - } - }, - "LabelColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color of the data label text.

" - } - }, - "MeasureDataLabelStyle": { - "target": "com.amazonaws.quicksight#FunnelChartMeasureDataLabelStyle", - "traits": { - "smithy.api#documentation": "

Determines the style of the metric labels.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the data labels.

" - } - }, - "com.amazonaws.quicksight#FunnelChartDimensionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DimensionField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#FunnelChartFieldWells": { - "type": "structure", - "members": { - "FunnelChartAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#FunnelChartAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a FunnelChartVisual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a FunnelChartVisual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#FunnelChartMeasureDataLabelStyle": { - "type": "enum", - "members": { - "VALUE_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VALUE_ONLY" - } - }, - "PERCENTAGE_BY_FIRST_STAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENTAGE_BY_FIRST_STAGE" - } - }, - "PERCENTAGE_BY_PREVIOUS_STAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENTAGE_BY_PREVIOUS_STAGE" - } - }, - "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE" - } - }, - "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE" - } - } - } - }, - "com.amazonaws.quicksight#FunnelChartMeasureFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MeasureField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#FunnelChartSortConfiguration": { - "type": "structure", - "members": { - "CategorySort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the category fields.

" - } - }, - "CategoryItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of categories displayed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a FunnelChartVisual.

" - } - }, - "com.amazonaws.quicksight#FunnelChartVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#FunnelChartConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of a FunnelChartVisual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A funnel chart.

\n

For more information, see Using funnel charts in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#GaugeChartArcConditionalFormatting": { - "type": "structure", - "members": { - "ForegroundColor": { - "target": "com.amazonaws.quicksight#ConditionalFormattingColor", - "traits": { - "smithy.api#documentation": "

The conditional formatting of the arc foreground color.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the arc of a GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#GaugeChartColorConfiguration": { - "type": "structure", - "members": { - "ForegroundColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The foreground color configuration of a GaugeChartVisual.

" - } - }, - "BackgroundColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The background color configuration of a GaugeChartVisual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The color configuration of a GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#GaugeChartConditionalFormatting": { - "type": "structure", - "members": { - "ConditionalFormattingOptions": { - "target": "com.amazonaws.quicksight#GaugeChartConditionalFormattingOptionList", - "traits": { - "smithy.api#documentation": "

Conditional formatting options of a GaugeChartVisual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting of a GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#GaugeChartConditionalFormattingOption": { - "type": "structure", - "members": { - "PrimaryValue": { - "target": "com.amazonaws.quicksight#GaugeChartPrimaryValueConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The conditional formatting for the primary value of a GaugeChartVisual.

" - } - }, - "Arc": { - "target": "com.amazonaws.quicksight#GaugeChartArcConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the arc of a GaugeChartVisual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Conditional formatting options of a GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#GaugeChartConditionalFormattingOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#GaugeChartConditionalFormattingOption" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#GaugeChartConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#GaugeChartFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a GaugeChartVisual.

" - } - }, - "GaugeChartOptions": { - "target": "com.amazonaws.quicksight#GaugeChartOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the GaugeChartVisual.

" - } - }, - "DataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The data label configuration of a GaugeChartVisual.

" - } - }, - "TooltipOptions": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The tooltip configuration of a GaugeChartVisual.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "

The visual palette configuration of a GaugeChartVisual.

" - } - }, - "ColorConfiguration": { - "target": "com.amazonaws.quicksight#GaugeChartColorConfiguration", - "traits": { - "smithy.api#documentation": "

The color configuration of a GaugeChartVisual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#GaugeChartFieldWells": { - "type": "structure", - "members": { - "Values": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The value field wells of a GaugeChartVisual.

" - } - }, - "TargetValues": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The target value field wells of a GaugeChartVisual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#GaugeChartOptions": { - "type": "structure", - "members": { - "PrimaryValueDisplayType": { - "target": "com.amazonaws.quicksight#PrimaryValueDisplayType", - "traits": { - "smithy.api#documentation": "

The options that determine the primary value display type.

" - } - }, - "Comparison": { - "target": "com.amazonaws.quicksight#ComparisonConfiguration", - "traits": { - "smithy.api#documentation": "

The comparison configuration of a GaugeChartVisual.

" - } - }, - "ArcAxis": { - "target": "com.amazonaws.quicksight#ArcAxisConfiguration", - "traits": { - "smithy.api#documentation": "

The arc axis configuration of a GaugeChartVisual.

" - } - }, - "Arc": { - "target": "com.amazonaws.quicksight#ArcConfiguration", - "traits": { - "smithy.api#documentation": "

The arc configuration of a GaugeChartVisual.

" - } - }, - "PrimaryValueFontConfiguration": { - "target": "com.amazonaws.quicksight#FontConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the primary value font configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#GaugeChartPrimaryValueConditionalFormatting": { - "type": "structure", - "members": { - "TextColor": { - "target": "com.amazonaws.quicksight#ConditionalFormattingColor", - "traits": { - "smithy.api#documentation": "

The conditional formatting of the primary value text color.

" - } - }, - "Icon": { - "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", - "traits": { - "smithy.api#documentation": "

The conditional formatting of the primary value icon.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting for the primary value of a GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#GaugeChartVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#GaugeChartConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of a GaugeChartVisual.

" - } - }, - "ConditionalFormatting": { - "target": "com.amazonaws.quicksight#GaugeChartConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The conditional formatting of a GaugeChartVisual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A gauge chart.

\n

For more information, see Using gauge charts in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUserRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#SessionLifetimeInMinutesInvalidException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedPricingPlanException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.

\n

The following rules apply to the generated URL:

\n \n

For more information, see Embedded Analytics in the Amazon QuickSight User\n Guide.

\n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/embed-url/anonymous-user", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUserRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SessionLifetimeInMinutes": { - "target": "com.amazonaws.quicksight#SessionLifetimeInMinutes", - "traits": { - "smithy.api#documentation": "

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.

", - "smithy.api#required": {} - } - }, - "SessionTags": { - "target": "com.amazonaws.quicksight#SessionTagList", - "traits": { - "smithy.api#documentation": "

The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

\n

These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.

" - } - }, - "AuthorizedResourceArns": { - "target": "com.amazonaws.quicksight#ArnList", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user\n is authorized to access during the lifetime of the session.

\n

If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the\n account that you want the user to be able to view.

\n

If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to.

\n

Currently, you can pass up to 25 theme ARNs in each API call.

", - "smithy.api#required": {} - } - }, - "ExperienceConfiguration": { - "target": "com.amazonaws.quicksight#AnonymousUserEmbeddingExperienceConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of the experience that you are embedding.

", - "smithy.api#required": {} - } - }, - "AllowedDomains": { - "target": "com.amazonaws.quicksight#StringList", - "traits": { - "smithy.api#documentation": "

The domains that you want to add to the allow list for access to the generated URL that\n is then embedded. This optional parameter overrides the static domains that are\n configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it\n allows only the domains that you include in this parameter. You can list up to three\n domains or subdomains in each API call.

\n

To include all subdomains under a specific domain to the allow list, use *.\n For example, https://*.sapp.amazon.com includes all subdomains under\n https://sapp.amazon.com.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUserResponse": { - "type": "structure", - "members": { - "EmbedUrl": { - "target": "com.amazonaws.quicksight#EmbeddingUrl", - "traits": { - "smithy.api#documentation": "

The embed URL for the dashboard.

", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {}, - "smithy.api#required": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

", - "smithy.api#required": {} - } - }, - "AnonymousUserArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#QuickSightUserNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#SessionLifetimeInMinutesInvalidException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedPricingPlanException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. \n Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.

\n

The following rules apply to the generated URL:

\n \n

For more information, see Embedded Analytics in the Amazon QuickSight User\n Guide.

\n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/embed-url/registered-user", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SessionLifetimeInMinutes": { - "target": "com.amazonaws.quicksight#SessionLifetimeInMinutes", - "traits": { - "smithy.api#documentation": "

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

" - } - }, - "UserArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name for the registered user.

", - "smithy.api#required": {} - } - }, - "ExperienceConfiguration": { - "target": "com.amazonaws.quicksight#RegisteredUserEmbeddingExperienceConfiguration", - "traits": { - "smithy.api#documentation": "

The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire Amazon QuickSight console.

", - "smithy.api#required": {} - } - }, - "AllowedDomains": { - "target": "com.amazonaws.quicksight#StringList", - "traits": { - "smithy.api#documentation": "

The domains that you want to add to the allow list for access to the generated URL that \n is then embedded. This optional parameter overrides the static domains that are \n configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it \n allows only the domains that you include in this parameter. You can list up to three \n domains or subdomains in each API call.

\n

To include all subdomains under a specific domain to the allow list, use *.\n For example, https://*.sapp.amazon.com includes all subdomains under\n https://sapp.amazon.com.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserResponse": { - "type": "structure", - "members": { - "EmbedUrl": { - "target": "com.amazonaws.quicksight#EmbeddingUrl", - "traits": { - "smithy.api#documentation": "

The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, Generative Q&A experience, or console.

", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {}, - "smithy.api#required": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#GeoSpatialColumnGroup": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#ColumnGroupName", - "traits": { - "smithy.api#documentation": "

A display name for the hierarchy.

", - "smithy.api#required": {} - } - }, - "CountryCode": { - "target": "com.amazonaws.quicksight#GeoSpatialCountryCode", - "traits": { - "smithy.api#documentation": "

Country code.

" - } - }, - "Columns": { - "target": "com.amazonaws.quicksight#ColumnList", - "traits": { - "smithy.api#documentation": "

Columns in this hierarchy.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Geospatial column group that denotes a hierarchy.

" - } - }, - "com.amazonaws.quicksight#GeoSpatialCountryCode": { - "type": "enum", - "members": { - "US": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "US" - } - } - } - }, - "com.amazonaws.quicksight#GeoSpatialDataRole": { - "type": "enum", - "members": { - "COUNTRY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNTRY" - } - }, - "STATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STATE" - } - }, - "COUNTY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNTY" - } - }, - "CITY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CITY" - } - }, - "POSTCODE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POSTCODE" - } - }, - "LONGITUDE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LONGITUDE" - } - }, - "LATITUDE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LATITUDE" - } - } - } - }, - "com.amazonaws.quicksight#GeospatialCoordinateBounds": { - "type": "structure", - "members": { - "North": { - "target": "com.amazonaws.quicksight#Latitude", - "traits": { - "smithy.api#documentation": "

The latitude of the north bound of the geospatial coordinate bounds.

", - "smithy.api#required": {} - } - }, - "South": { - "target": "com.amazonaws.quicksight#Latitude", - "traits": { - "smithy.api#documentation": "

The latitude of the south bound of the geospatial coordinate bounds.

", - "smithy.api#required": {} - } - }, - "West": { - "target": "com.amazonaws.quicksight#Longitude", - "traits": { - "smithy.api#documentation": "

The longitude of the west bound of the geospatial coordinate bounds.

", - "smithy.api#required": {} - } - }, - "East": { - "target": "com.amazonaws.quicksight#Longitude", - "traits": { - "smithy.api#documentation": "

The longitude of the east bound of the geospatial coordinate bounds.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The bound\n options (north, south, west, east) of the geospatial window options.

" - } - }, - "com.amazonaws.quicksight#GeospatialHeatmapColorScale": { - "type": "structure", - "members": { - "Colors": { - "target": "com.amazonaws.quicksight#GeospatialHeatmapDataColorList", - "traits": { - "smithy.api#documentation": "

The list of colors to be used in heatmap point style.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The color scale specification for the heatmap point style.

" - } - }, - "com.amazonaws.quicksight#GeospatialHeatmapConfiguration": { - "type": "structure", - "members": { - "HeatmapColor": { - "target": "com.amazonaws.quicksight#GeospatialHeatmapColorScale", - "traits": { - "smithy.api#documentation": "

The color scale specification for the heatmap point style.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The heatmap configuration of the geospatial point style.

" - } - }, - "com.amazonaws.quicksight#GeospatialHeatmapDataColor": { - "type": "structure", - "members": { - "Color": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The hex color to be used in the heatmap point style.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The color to be used in the heatmap point style.

" - } - }, - "com.amazonaws.quicksight#GeospatialHeatmapDataColorList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#GeospatialHeatmapDataColor" - }, - "traits": { - "smithy.api#length": { - "min": 2, - "max": 2 - } - } - }, - "com.amazonaws.quicksight#GeospatialMapAggregatedFieldWells": { - "type": "structure", - "members": { - "Geospatial": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The geospatial field wells of a geospatial map. Values are grouped by geospatial fields.

" - } - }, - "Values": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The size field wells of a geospatial map. Values are aggregated based on geospatial fields.

" - } - }, - "Colors": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The color field wells of a geospatial map.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The aggregated field wells for a geospatial map.

" - } - }, - "com.amazonaws.quicksight#GeospatialMapConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#GeospatialMapFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "

The legend display setup of the visual.

" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The tooltip display setup of the visual.

" - } - }, - "WindowOptions": { - "target": "com.amazonaws.quicksight#GeospatialWindowOptions", - "traits": { - "smithy.api#documentation": "

The window options of the geospatial map.

" - } - }, - "MapStyleOptions": { - "target": "com.amazonaws.quicksight#GeospatialMapStyleOptions", - "traits": { - "smithy.api#documentation": "

The map style options of the geospatial map.

" - } - }, - "PointStyleOptions": { - "target": "com.amazonaws.quicksight#GeospatialPointStyleOptions", - "traits": { - "smithy.api#documentation": "

The point style options of the geospatial map.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette" - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a GeospatialMapVisual.

" - } - }, - "com.amazonaws.quicksight#GeospatialMapFieldWells": { - "type": "structure", - "members": { - "GeospatialMapAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#GeospatialMapAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field well for a geospatial map.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field wells of a GeospatialMapVisual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#GeospatialMapStyleOptions": { - "type": "structure", - "members": { - "BaseMapStyle": { - "target": "com.amazonaws.quicksight#BaseMapStyleType", - "traits": { - "smithy.api#documentation": "

The base map style of the geospatial map.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The map style options of the geospatial map.

" - } - }, - "com.amazonaws.quicksight#GeospatialMapVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#GeospatialMapConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A geospatial map or a points on map visual.

\n

For more information, see Creating point maps in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#GeospatialPointStyleOptions": { - "type": "structure", - "members": { - "SelectedPointStyle": { - "target": "com.amazonaws.quicksight#GeospatialSelectedPointStyle", - "traits": { - "smithy.api#documentation": "

The selected point styles (point, cluster) of the geospatial map.

" - } - }, - "ClusterMarkerConfiguration": { - "target": "com.amazonaws.quicksight#ClusterMarkerConfiguration", - "traits": { - "smithy.api#documentation": "

The cluster marker configuration of the geospatial point style.

" - } - }, - "HeatmapConfiguration": { - "target": "com.amazonaws.quicksight#GeospatialHeatmapConfiguration", - "traits": { - "smithy.api#documentation": "

The heatmap configuration of the geospatial point style.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The point style of the geospatial map.

" - } - }, - "com.amazonaws.quicksight#GeospatialSelectedPointStyle": { - "type": "enum", - "members": { - "POINT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POINT" - } - }, - "CLUSTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLUSTER" - } - }, - "HEATMAP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HEATMAP" - } - } - } - }, - "com.amazonaws.quicksight#GeospatialWindowOptions": { - "type": "structure", - "members": { - "Bounds": { - "target": "com.amazonaws.quicksight#GeospatialCoordinateBounds", - "traits": { - "smithy.api#documentation": "

The bounds options (north, south, west, east) of the geospatial window options.

" - } - }, - "MapZoomMode": { - "target": "com.amazonaws.quicksight#MapZoomMode", - "traits": { - "smithy.api#documentation": "

The map zoom modes (manual, auto) of the geospatial window options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The window options of the geospatial map visual.

" - } - }, - "com.amazonaws.quicksight#GetDashboardEmbedUrl": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#GetDashboardEmbedUrlRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#GetDashboardEmbedUrlResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#DomainNotWhitelistedException" - }, - { - "target": "com.amazonaws.quicksight#IdentityTypeNotSupportedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#QuickSightUserNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#SessionLifetimeInMinutesInvalidException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedPricingPlanException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions.

\n

Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the generated URL:

\n \n

For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User\n Guide.

\n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/embed-url", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#GetDashboardEmbedUrlRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard, also added to the Identity and Access Management (IAM)\n policy.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "IdentityType": { - "target": "com.amazonaws.quicksight#EmbeddingIdentityType", - "traits": { - "smithy.api#documentation": "

The authentication method that the user uses to sign in.

", - "smithy.api#httpQuery": "creds-type", - "smithy.api#required": {} - } - }, - "SessionLifetimeInMinutes": { - "target": "com.amazonaws.quicksight#SessionLifetimeInMinutes", - "traits": { - "smithy.api#documentation": "

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

", - "smithy.api#httpQuery": "session-lifetime" - } - }, - "UndoRedoDisabled": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables\n\t\t\tthe undo/redo button.

", - "smithy.api#httpQuery": "undo-redo-disabled" - } - }, - "ResetDisabled": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the\n\t\t\treset button.

", - "smithy.api#httpQuery": "reset-disabled" - } - }, - "StatePersistenceEnabled": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Adds persistence of state for the user session in an embedded dashboard. Persistence\n applies to the sheet and the parameter settings. These are control settings that the\n dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is\n set to TRUE, the settings are the same when the subscriber reopens the same\n dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is\n set to FALSE, the state of the user session is not persisted. The default is\n FALSE.

", - "smithy.api#httpQuery": "state-persistence-enabled" - } - }, - "UserArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.\n\t\t\tYou can use this for any Amazon QuickSight users in your account (readers, authors, or\n\t\t\tadmins) authenticated as one of the following:

\n \n

Omit this parameter for users in the third group – IAM users and IAM\n role-based sessions.

", - "smithy.api#httpQuery": "user-arn" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight namespace that contains the dashboard IDs in this request.\n \t If you're not using a custom namespace, set Namespace = default.

", - "smithy.api#httpQuery": "namespace" - } - }, - "AdditionalDashboardIds": { - "target": "com.amazonaws.quicksight#AdditionalDashboardIdList", - "traits": { - "smithy.api#documentation": "

A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set \"--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS\", the session can access all three dashboards.

", - "smithy.api#httpQuery": "additional-dashboard-ids" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#GetDashboardEmbedUrlResponse": { - "type": "structure", - "members": { - "EmbedUrl": { - "target": "com.amazonaws.quicksight#EmbeddingUrl", - "traits": { - "smithy.api#documentation": "

A single-use URL that you can put into your server-side webpage to embed your\n\t\t\tdashboard. This URL is valid for 5 minutes. The API operation provides the URL with an\n\t\t\tauth_code value that enables one (and only one) sign-on to a user session\n\t\t\tthat is valid for 10 hours.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Output returned from the GetDashboardEmbedUrl operation.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#GetSessionEmbedUrl": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#GetSessionEmbedUrlRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#GetSessionEmbedUrlResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#QuickSightUserNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#SessionLifetimeInMinutesInvalidException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Generates a session URL and authorization code that you can use to embed the Amazon\n Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where\n you want to provide an authoring portal that allows users to create data sources,\n datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console\n need belong to the author or admin security cohort. If you want to restrict permissions\n to some of these features, add a custom permissions profile to the user with the\n \n UpdateUser\n API operation. Use \n RegisterUser\n \n API operation to add a new user with a custom permission profile attached. For more\n information, see the following sections in the Amazon QuickSight User\n Guide:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/session-embed-url", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#GetSessionEmbedUrlRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "EntryPoint": { - "target": "com.amazonaws.quicksight#EntryPoint", - "traits": { - "smithy.api#documentation": "

The URL you use to access the embedded session. The entry point URL is constrained to\n the following paths:

\n ", - "smithy.api#httpQuery": "entry-point" - } - }, - "SessionLifetimeInMinutes": { - "target": "com.amazonaws.quicksight#SessionLifetimeInMinutes", - "traits": { - "smithy.api#documentation": "

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

", - "smithy.api#httpQuery": "session-lifetime" - } - }, - "UserArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.\n\t\t\tYou can use this for any type of Amazon QuickSight users in your account (readers, authors, or\n\t\t\tadmins). They need to be authenticated as one of the following:

\n
    \n
  1. \n

    Active Directory (AD) users or group members

    \n
    2. \n
  2. \n

    Invited nonfederated users

    \n
    3. \n
  3. \n

    IAM users and IAM role-based sessions authenticated\n through Federated Single Sign-On using SAML, OpenID Connect, or IAM\n federation

    \n
    4. \n
\n

Omit this parameter for users in the third group, IAM users and IAM role-based\n sessions.

", - "smithy.api#httpQuery": "user-arn" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#GetSessionEmbedUrlResponse": { - "type": "structure", - "members": { - "EmbedUrl": { - "target": "com.amazonaws.quicksight#EmbeddingUrl", - "traits": { - "smithy.api#documentation": "

A single-use URL that you can put into your server-side web page to embed your\n\t\t\tAmazon QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an\n\t\t\tauth_code value that enables one (and only one) sign-on to a user session\n\t\t\tthat is valid for 10 hours.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#GlobalTableBorderOptions": { - "type": "structure", - "members": { - "UniformBorder": { - "target": "com.amazonaws.quicksight#TableBorderOptions", - "traits": { - "smithy.api#documentation": "

Determines the options for uniform border.

" - } - }, - "SideSpecificBorder": { - "target": "com.amazonaws.quicksight#TableSideBorderOptions", - "traits": { - "smithy.api#documentation": "

Determines the options for side specific border.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines the border options for a table visual.

" - } - }, - "com.amazonaws.quicksight#GradientColor": { - "type": "structure", - "members": { - "Stops": { - "target": "com.amazonaws.quicksight#GradientStopList", - "traits": { - "smithy.api#documentation": "

The list of gradient color stops.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines the gradient color settings.

" - } - }, - "com.amazonaws.quicksight#GradientStop": { - "type": "structure", - "members": { - "GradientOffset": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Determines gradient offset value.

", - "smithy.api#required": {} - } - }, - "DataValue": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

Determines the data value.

" - } - }, - "Color": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

Determines the color.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines the gradient stop configuration.

" - } - }, - "com.amazonaws.quicksight#GradientStopList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#GradientStop" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#GridLayoutCanvasSizeOptions": { - "type": "structure", - "members": { - "ScreenCanvasSizeOptions": { - "target": "com.amazonaws.quicksight#GridLayoutScreenCanvasSizeOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the sizing of the canvas used in a grid layout.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration options for the canvas of a grid layout.

" - } - }, - "com.amazonaws.quicksight#GridLayoutConfiguration": { - "type": "structure", - "members": { - "Elements": { - "target": "com.amazonaws.quicksight#GridLayoutElementList", - "traits": { - "smithy.api#documentation": "

The elements that are included in a grid layout.

", - "smithy.api#required": {} - } - }, - "CanvasSizeOptions": { - "target": "com.amazonaws.quicksight#GridLayoutCanvasSizeOptions" - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for a grid layout. Also called a tiled layout.

\n

Visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size.

" - } - }, - "com.amazonaws.quicksight#GridLayoutElement": { - "type": "structure", - "members": { - "ElementId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

A unique identifier for an element within a grid layout.

", - "smithy.api#required": {} - } - }, - "ElementType": { - "target": "com.amazonaws.quicksight#LayoutElementType", - "traits": { - "smithy.api#documentation": "

The type of element.

", - "smithy.api#required": {} - } - }, - "ColumnIndex": { - "target": "com.amazonaws.quicksight#GridLayoutElementColumnIndex", - "traits": { - "smithy.api#documentation": "

The column index for the upper left corner of an element.

" - } - }, - "ColumnSpan": { - "target": "com.amazonaws.quicksight#GridLayoutElementColumnSpan", - "traits": { - "smithy.api#documentation": "

The width of a grid element expressed as a number of grid columns.

", - "smithy.api#required": {} - } - }, - "RowIndex": { - "target": "com.amazonaws.quicksight#GridLayoutElementRowIndex", - "traits": { - "smithy.api#documentation": "

The row index for the upper left corner of an element.

" - } - }, - "RowSpan": { - "target": "com.amazonaws.quicksight#GridLayoutElementRowSpan", - "traits": { - "smithy.api#documentation": "

The height of a grid element expressed as a number of grid rows.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An element within a grid layout.

" - } - }, - "com.amazonaws.quicksight#GridLayoutElementColumnIndex": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 35 - } - } - }, - "com.amazonaws.quicksight#GridLayoutElementColumnSpan": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 36 - } - } - }, - "com.amazonaws.quicksight#GridLayoutElementList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#GridLayoutElement" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 430 - } - } - }, - "com.amazonaws.quicksight#GridLayoutElementRowIndex": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 9009 - } - } - }, - "com.amazonaws.quicksight#GridLayoutElementRowSpan": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 21 - } - } - }, - "com.amazonaws.quicksight#GridLayoutScreenCanvasSizeOptions": { - "type": "structure", - "members": { - "ResizeOption": { - "target": "com.amazonaws.quicksight#ResizeOption", - "traits": { - "smithy.api#documentation": "

This value determines the layout behavior when the viewport is resized.

\n ", - "smithy.api#required": {} - } - }, - "OptimizedViewPortWidth": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The width that the view port will be optimized for when the layout renders.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the sizing of the canvas used in a grid layout.

" - } - }, - "com.amazonaws.quicksight#Group": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the group.

" - } - }, - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

The name of the group.

" - } - }, - "Description": { - "target": "com.amazonaws.quicksight#GroupDescription", - "traits": { - "smithy.api#documentation": "

The group description.

" - } - }, - "PrincipalId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The principal ID of the group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A group in Amazon QuickSight consists of a set of users. You can\n use groups to make it easier to manage access and security.

" - } - }, - "com.amazonaws.quicksight#GroupDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.quicksight#GroupFilterAttribute": { - "type": "enum", - "members": { - "GROUP_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GROUP_NAME" - } - } - } - }, - "com.amazonaws.quicksight#GroupFilterOperator": { - "type": "enum", - "members": { - "StartsWith": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StartsWith" - } - } - } - }, - "com.amazonaws.quicksight#GroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Group" - } - }, - "com.amazonaws.quicksight#GroupMember": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the group member (user).

" - } - }, - "MemberName": { - "target": "com.amazonaws.quicksight#GroupMemberName", - "traits": { - "smithy.api#documentation": "

The name of the group member (user).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A member of an Amazon QuickSight group. Currently, group members must be users. Groups\n can't be members of another group. .

" - } - }, - "com.amazonaws.quicksight#GroupMemberList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#GroupMember" - } - }, - "com.amazonaws.quicksight#GroupMemberName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" - } - }, - "com.amazonaws.quicksight#GroupName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - }, - "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" - } - }, - "com.amazonaws.quicksight#GroupSearchFilter": { - "type": "structure", - "members": { - "Operator": { - "target": "com.amazonaws.quicksight#GroupFilterOperator", - "traits": { - "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\":\n \"StartsWith\". Currently, the only supported operator is\n StartsWith.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#GroupFilterAttribute", - "traits": { - "smithy.api#documentation": "

The name of the value that you want to use as a filter, for example \"Name\":\n \"GROUP_NAME\". Currently, the only supported name is\n GROUP_NAME.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The value of the named item, in this case GROUP_NAME, that you want to use as a filter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A GroupSearchFilter object that you want to apply to your search.

" - } - }, - "com.amazonaws.quicksight#GroupSearchFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#GroupSearchFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#GroupsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#String" - } - }, - "com.amazonaws.quicksight#GrowthRateComputation": { - "type": "structure", - "members": { - "ComputationId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for a computation.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of a computation.

" - } - }, - "Time": { - "target": "com.amazonaws.quicksight#DimensionField", - "traits": { - "smithy.api#documentation": "

The time field that is used in a computation.

" - } - }, - "Value": { - "target": "com.amazonaws.quicksight#MeasureField", - "traits": { - "smithy.api#documentation": "

The value field that is used in a computation.

" - } - }, - "PeriodSize": { - "target": "com.amazonaws.quicksight#GrowthRatePeriodSize", - "traits": { - "smithy.api#documentation": "

The period size setup of a growth rate computation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The growth rate computation configuration.

" - } - }, - "com.amazonaws.quicksight#GrowthRatePeriodSize": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 2, - "max": 52 - } - } - }, - "com.amazonaws.quicksight#GutterStyle": { - "type": "structure", - "members": { - "Show": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

This Boolean value controls whether to display a gutter space between sheet tiles.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options for gutter spacing between tiles on a sheet.

" - } - }, - "com.amazonaws.quicksight#HeaderFooterSectionConfiguration": { - "type": "structure", - "members": { - "SectionId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the header or footer section.

", - "smithy.api#required": {} - } - }, - "Layout": { - "target": "com.amazonaws.quicksight#SectionLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

The layout configuration of the header or footer section.

", - "smithy.api#required": {} - } - }, - "Style": { - "target": "com.amazonaws.quicksight#SectionStyle", - "traits": { - "smithy.api#documentation": "

The style options of a header or footer section.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a header or footer section.

" - } - }, - "com.amazonaws.quicksight#HeaderFooterSectionConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#HeaderFooterSectionConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#HeatMapAggregatedFieldWells": { - "type": "structure", - "members": { - "Rows": { - "target": "com.amazonaws.quicksight#HeatMapDimensionFieldList", - "traits": { - "smithy.api#documentation": "

The rows field well of a heat map.

" - } - }, - "Columns": { - "target": "com.amazonaws.quicksight#HeatMapDimensionFieldList", - "traits": { - "smithy.api#documentation": "

The columns field well of a heat map.

" - } - }, - "Values": { - "target": "com.amazonaws.quicksight#HeatMapMeasureFieldList", - "traits": { - "smithy.api#documentation": "

The values field well of a heat map.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a heat map.

" - } - }, - "com.amazonaws.quicksight#HeatMapConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#HeatMapFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#HeatMapSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a heat map.

" - } - }, - "RowLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options of the row that is displayed in a heat map.

" - } - }, - "ColumnLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options of the column that is displayed in a heat map.

" - } - }, - "ColorScale": { - "target": "com.amazonaws.quicksight#ColorScale", - "traits": { - "smithy.api#documentation": "

The color options (gradient color, point of divergence) in a heat map.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "

The legend display setup of the visual.

" - } - }, - "DataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The tooltip display setup of the visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a heat map.

" - } - }, - "com.amazonaws.quicksight#HeatMapDimensionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DimensionField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#HeatMapFieldWells": { - "type": "structure", - "members": { - "HeatMapAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#HeatMapAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a heat map.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a heat map.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#HeatMapMeasureFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MeasureField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#HeatMapSortConfiguration": { - "type": "structure", - "members": { - "HeatMapRowSort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The field sort configuration of the rows fields.

" - } - }, - "HeatMapColumnSort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The column sort configuration for heat map for columns that aren't a part of a field well.

" - } - }, - "HeatMapRowItemsLimitConfiguration": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of rows that are displayed in a heat map.

" - } - }, - "HeatMapColumnItemsLimitConfiguration": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of columns that are displayed in a heat map.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a heat map.

" - } - }, - "com.amazonaws.quicksight#HeatMapVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#HeatMapConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of a heat map.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A heat map.

\n

For more information, see Using heat maps in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#HexColor": { - "type": "string", - "traits": { - "smithy.api#pattern": "^#[A-F0-9]{6}$" - } - }, - "com.amazonaws.quicksight#HexColorWithTransparency": { - "type": "string", - "traits": { - "smithy.api#pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$" - } - }, - "com.amazonaws.quicksight#HierarchyId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.quicksight#HistogramAggregatedFieldWells": { - "type": "structure", - "members": { - "Values": { - "target": "com.amazonaws.quicksight#HistogramMeasureFieldList", - "traits": { - "smithy.api#documentation": "

The value field wells of a histogram. Values are aggregated by COUNT or DISTINCT_COUNT.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a histogram.

" - } - }, - "com.amazonaws.quicksight#HistogramBinOptions": { - "type": "structure", - "members": { - "SelectedBinType": { - "target": "com.amazonaws.quicksight#HistogramBinType", - "traits": { - "smithy.api#documentation": "

The options that determine the selected bin type.

" - } - }, - "BinCount": { - "target": "com.amazonaws.quicksight#BinCountOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the bin count of a histogram.

" - } - }, - "BinWidth": { - "target": "com.amazonaws.quicksight#BinWidthOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the bin width of a histogram.

" - } - }, - "StartValue": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The options that determine the bin start value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of histogram bins.

" - } - }, - "com.amazonaws.quicksight#HistogramBinType": { - "type": "enum", - "members": { - "BIN_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BIN_COUNT" - } - }, - "BIN_WIDTH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BIN_WIDTH" - } - } - } - }, - "com.amazonaws.quicksight#HistogramConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#HistogramFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a histogram.

" - } - }, - "XAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the x-axis.

" - } - }, - "XAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the x-axis label.

" - } - }, - "YAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the y-axis.

" - } - }, - "BinOptions": { - "target": "com.amazonaws.quicksight#HistogramBinOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of histogram bins.

" - } - }, - "DataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The data label configuration of a histogram.

" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The tooltip configuration of a histogram.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "

The visual palette configuration of a histogram.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for a HistogramVisual.

" - } - }, - "com.amazonaws.quicksight#HistogramFieldWells": { - "type": "structure", - "members": { - "HistogramAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#HistogramAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a histogram.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a histogram.

" - } - }, - "com.amazonaws.quicksight#HistogramMeasureFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MeasureField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#HistogramVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#HistogramConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration for a HistogramVisual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A histogram.

\n

For more information, see Using histograms in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#HorizontalTextAlignment": { - "type": "enum", - "members": { - "LEFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LEFT" - } - }, - "CENTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CENTER" - } - }, - "RIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RIGHT" - } - }, - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - } - } - }, - "com.amazonaws.quicksight#Host": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.quicksight#IAMPolicyAssignment": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

" - } - }, - "AssignmentId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

Assignment ID.

" - } - }, - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "

Assignment name.

" - } - }, - "PolicyArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM policy.

" - } - }, - "Identities": { - "target": "com.amazonaws.quicksight#IdentityMap", - "traits": { - "smithy.api#documentation": "

Identities.

" - } - }, - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", - "traits": { - "smithy.api#documentation": "

Assignment status.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An Identity and Access Management (IAM) policy assignment.

" - } - }, - "com.amazonaws.quicksight#IAMPolicyAssignmentName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - }, - "smithy.api#pattern": "^(?=^.{2,256}$)(?!.*\\s)[0-9a-zA-Z-_.:=+@]*$" - } - }, - "com.amazonaws.quicksight#IAMPolicyAssignmentSummary": { - "type": "structure", - "members": { - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "

Assignment name.

" - } - }, - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", - "traits": { - "smithy.api#documentation": "

Assignment status.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

IAM policy assignment summary.

" - } - }, - "com.amazonaws.quicksight#IAMPolicyAssignmentSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentSummary" - } - }, - "com.amazonaws.quicksight#IPv4Address": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 7, - "max": 15 - } - } - }, - "com.amazonaws.quicksight#Icon": { - "type": "enum", - "members": { - "CARET_UP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CARET_UP" - } - }, - "CARET_DOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CARET_DOWN" - } - }, - "PLUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PLUS" - } - }, - "MINUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MINUS" - } - }, - "ARROW_UP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARROW_UP" - } - }, - "ARROW_DOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARROW_DOWN" - } - }, - "ARROW_LEFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARROW_LEFT" - } - }, - "ARROW_UP_LEFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARROW_UP_LEFT" - } - }, - "ARROW_DOWN_LEFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARROW_DOWN_LEFT" - } - }, - "ARROW_RIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARROW_RIGHT" - } - }, - "ARROW_UP_RIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARROW_UP_RIGHT" - } - }, - "ARROW_DOWN_RIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARROW_DOWN_RIGHT" - } - }, - "FACE_UP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FACE_UP" - } - }, - "FACE_DOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FACE_DOWN" - } - }, - "FACE_FLAT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FACE_FLAT" - } - }, - "ONE_BAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ONE_BAR" - } - }, - "TWO_BAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TWO_BAR" - } - }, - "THREE_BAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THREE_BAR" - } - }, - "CIRCLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CIRCLE" - } - }, - "TRIANGLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRIANGLE" - } - }, - "SQUARE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SQUARE" - } - }, - "FLAG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FLAG" - } - }, - "THUMBS_UP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THUMBS_UP" - } - }, - "THUMBS_DOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THUMBS_DOWN" - } - }, - "CHECKMARK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CHECKMARK" - } - }, - "X": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "X" - } - } - } - }, - "com.amazonaws.quicksight#Identifier": { - "type": "structure", - "members": { - "Identity": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The identity of the identifier.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for the identifier.

" - } - }, - "com.amazonaws.quicksight#IdentityCenterConfiguration": { - "type": "structure", - "members": { - "EnableIdentityPropagation": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

A Boolean option that controls whether Trusted Identity Propagation should be used.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for an IAM Identity Center configuration.

" - } - }, - "com.amazonaws.quicksight#IdentityMap": { - "type": "map", - "key": { - "target": "com.amazonaws.quicksight#String" - }, - "value": { - "target": "com.amazonaws.quicksight#IdentityNameList" - } - }, - "com.amazonaws.quicksight#IdentityName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - }, - "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" - } - }, - "com.amazonaws.quicksight#IdentityNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#IdentityName" - } - }, - "com.amazonaws.quicksight#IdentityStore": { - "type": "enum", - "members": { - "QUICKSIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT" - } - } - } - }, - "com.amazonaws.quicksight#IdentityType": { - "type": "enum", - "members": { - "IAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM" - } - }, - "QUICKSIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT" - } - }, - "IAM_IDENTITY_CENTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM_IDENTITY_CENTER" - } - } - } - }, - "com.amazonaws.quicksight#IdentityTypeNotSupportedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The identity type specified isn't supported. Supported identity types include\n\t\t\t\tIAM and QUICKSIGHT.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.quicksight#IncrementalRefresh": { - "type": "structure", - "members": { - "LookbackWindow": { - "target": "com.amazonaws.quicksight#LookbackWindow", - "traits": { - "smithy.api#documentation": "

The lookback window setup for an incremental refresh configuration.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The incremental refresh configuration for a dataset.

" - } - }, - "com.amazonaws.quicksight#Ingestion": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", - "smithy.api#required": {} - } - }, - "IngestionId": { - "target": "com.amazonaws.quicksight#IngestionId", - "traits": { - "smithy.api#documentation": "

Ingestion ID.

" - } - }, - "IngestionStatus": { - "target": "com.amazonaws.quicksight#IngestionStatus", - "traits": { - "smithy.api#documentation": "

Ingestion status.

", - "smithy.api#required": {} - } - }, - "ErrorInfo": { - "target": "com.amazonaws.quicksight#ErrorInfo", - "traits": { - "smithy.api#documentation": "

Error information for this ingestion.

" - } - }, - "RowInfo": { - "target": "com.amazonaws.quicksight#RowInfo" - }, - "QueueInfo": { - "target": "com.amazonaws.quicksight#QueueInfo" - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that this ingestion started.

", - "smithy.api#required": {} - } - }, - "IngestionTimeInSeconds": { - "target": "com.amazonaws.quicksight#Long", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The time that this ingestion took, measured in seconds.

" - } - }, - "IngestionSizeInBytes": { - "target": "com.amazonaws.quicksight#Long", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The size of the data ingested, in bytes.

" - } - }, - "RequestSource": { - "target": "com.amazonaws.quicksight#IngestionRequestSource", - "traits": { - "smithy.api#documentation": "

Event source for this ingestion.

" - } - }, - "RequestType": { - "target": "com.amazonaws.quicksight#IngestionRequestType", - "traits": { - "smithy.api#documentation": "

Type of this ingestion.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the SPICE ingestion for a dataset.

" - } - }, - "com.amazonaws.quicksight#IngestionErrorType": { - "type": "enum", - "members": { - "FAILURE_TO_ASSUME_ROLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILURE_TO_ASSUME_ROLE" - } - }, - "INGESTION_SUPERSEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INGESTION_SUPERSEDED" - } - }, - "INGESTION_CANCELED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INGESTION_CANCELED" - } - }, - "DATA_SET_DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_SET_DELETED" - } - }, - "DATA_SET_NOT_SPICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_SET_NOT_SPICE" - } - }, - "S3_UPLOADED_FILE_DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3_UPLOADED_FILE_DELETED" - } - }, - "S3_MANIFEST_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3_MANIFEST_ERROR" - } - }, - "DATA_TOLERANCE_EXCEPTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_TOLERANCE_EXCEPTION" - } - }, - "SPICE_TABLE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SPICE_TABLE_NOT_FOUND" - } - }, - "DATA_SET_SIZE_LIMIT_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_SET_SIZE_LIMIT_EXCEEDED" - } - }, - "ROW_SIZE_LIMIT_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROW_SIZE_LIMIT_EXCEEDED" - } - }, - "ACCOUNT_CAPACITY_LIMIT_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCOUNT_CAPACITY_LIMIT_EXCEEDED" - } - }, - "CUSTOMER_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOMER_ERROR" - } - }, - "DATA_SOURCE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_SOURCE_NOT_FOUND" - } - }, - "IAM_ROLE_NOT_AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM_ROLE_NOT_AVAILABLE" - } - }, - "CONNECTION_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONNECTION_FAILURE" - } - }, - "SQL_TABLE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SQL_TABLE_NOT_FOUND" - } - }, - "PERMISSION_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERMISSION_DENIED" - } - }, - "SSL_CERTIFICATE_VALIDATION_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SSL_CERTIFICATE_VALIDATION_FAILURE" - } - }, - "OAUTH_TOKEN_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OAUTH_TOKEN_FAILURE" - } - }, - "SOURCE_API_LIMIT_EXCEEDED_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOURCE_API_LIMIT_EXCEEDED_FAILURE" - } - }, - "PASSWORD_AUTHENTICATION_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PASSWORD_AUTHENTICATION_FAILURE" - } - }, - "SQL_SCHEMA_MISMATCH_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SQL_SCHEMA_MISMATCH_ERROR" - } - }, - "INVALID_DATE_FORMAT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INVALID_DATE_FORMAT" - } - }, - "INVALID_DATAPREP_SYNTAX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INVALID_DATAPREP_SYNTAX" - } - }, - "SOURCE_RESOURCE_LIMIT_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOURCE_RESOURCE_LIMIT_EXCEEDED" - } - }, - "SQL_INVALID_PARAMETER_VALUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SQL_INVALID_PARAMETER_VALUE" - } - }, - "QUERY_TIMEOUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUERY_TIMEOUT" - } - }, - "SQL_NUMERIC_OVERFLOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SQL_NUMERIC_OVERFLOW" - } - }, - "UNRESOLVABLE_HOST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNRESOLVABLE_HOST" - } - }, - "UNROUTABLE_HOST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNROUTABLE_HOST" - } - }, - "SQL_EXCEPTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SQL_EXCEPTION" - } - }, - "S3_FILE_INACCESSIBLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3_FILE_INACCESSIBLE" - } - }, - "IOT_FILE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IOT_FILE_NOT_FOUND" - } - }, - "IOT_DATA_SET_FILE_EMPTY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IOT_DATA_SET_FILE_EMPTY" - } - }, - "INVALID_DATA_SOURCE_CONFIG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INVALID_DATA_SOURCE_CONFIG" - } - }, - "DATA_SOURCE_AUTH_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_SOURCE_AUTH_FAILED" - } - }, - "DATA_SOURCE_CONNECTION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_SOURCE_CONNECTION_FAILED" - } - }, - "FAILURE_TO_PROCESS_JSON_FILE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILURE_TO_PROCESS_JSON_FILE" - } - }, - "INTERNAL_SERVICE_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_SERVICE_ERROR" - } - }, - "REFRESH_SUPPRESSED_BY_EDIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REFRESH_SUPPRESSED_BY_EDIT" - } - }, - "PERMISSION_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERMISSION_NOT_FOUND" - } - }, - "ELASTICSEARCH_CURSOR_NOT_ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ELASTICSEARCH_CURSOR_NOT_ENABLED" - } - }, - "CURSOR_NOT_ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CURSOR_NOT_ENABLED" - } - }, - "DUPLICATE_COLUMN_NAMES_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DUPLICATE_COLUMN_NAMES_FOUND" - } - } - } - }, - "com.amazonaws.quicksight#IngestionId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-_]+$" - } - }, - "com.amazonaws.quicksight#IngestionMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#IngestionRequestSource": { - "type": "enum", - "members": { - "MANUAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MANUAL" - } - }, - "SCHEDULED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCHEDULED" - } - } - } - }, - "com.amazonaws.quicksight#IngestionRequestType": { - "type": "enum", - "members": { - "INITIAL_INGESTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INITIAL_INGESTION" - } - }, - "EDIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EDIT" - } - }, - "INCREMENTAL_REFRESH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INCREMENTAL_REFRESH" - } - }, - "FULL_REFRESH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FULL_REFRESH" - } - } - }, - "traits": { - "smithy.api#documentation": "This defines the type of ingestion request. This is returned as part of create ingestion response." - } - }, - "com.amazonaws.quicksight#IngestionStatus": { - "type": "enum", - "members": { - "INITIALIZED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INITIALIZED" - } - }, - "QUEUED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUEUED" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLED" - } - } - } - }, - "com.amazonaws.quicksight#IngestionType": { - "type": "enum", - "members": { - "INCREMENTAL_REFRESH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INCREMENTAL_REFRESH" - } - }, - "FULL_REFRESH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FULL_REFRESH" - } - } - }, - "traits": { - "smithy.api#documentation": "This defines the type of ingestion user wants to trigger. This is part of create ingestion request." - } - }, - "com.amazonaws.quicksight#Ingestions": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Ingestion" - } - }, - "com.amazonaws.quicksight#InnerFilter": { - "type": "structure", - "members": { - "CategoryInnerFilter": { - "target": "com.amazonaws.quicksight#CategoryInnerFilter", - "traits": { - "smithy.api#documentation": "

A CategoryInnerFilter filters text values for the NestedFilter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The InnerFilter defines the subset of data to be used with the NestedFilter.

" - } - }, - "com.amazonaws.quicksight#InputColumn": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#ColumnName", - "traits": { - "smithy.api#documentation": "

The name of this column in the underlying data source.

", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.quicksight#InputColumnDataType", - "traits": { - "smithy.api#documentation": "

The data type of the column.

", - "smithy.api#required": {} - } - }, - "SubType": { - "target": "com.amazonaws.quicksight#ColumnDataSubType", - "traits": { - "smithy.api#documentation": "

The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata for a column that is used as the input of a transform operation.

" - } - }, - "com.amazonaws.quicksight#InputColumnDataType": { - "type": "enum", - "members": { - "STRING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STRING" - } - }, - "INTEGER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTEGER" - } - }, - "DECIMAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DECIMAL" - } - }, - "DATETIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATETIME" - } - }, - "BIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BIT" - } - }, - "BOOLEAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOOLEAN" - } - }, - "JSON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JSON" - } - } - } - }, - "com.amazonaws.quicksight#InputColumnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#InputColumn" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#InsightConfiguration": { - "type": "structure", - "members": { - "Computations": { - "target": "com.amazonaws.quicksight#ComputationList", - "traits": { - "smithy.api#documentation": "

The computations configurations of the insight visual

" - } - }, - "CustomNarrative": { - "target": "com.amazonaws.quicksight#CustomNarrativeOptions", - "traits": { - "smithy.api#documentation": "

The custom narrative of the insight visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of an insight visual.

" - } - }, - "com.amazonaws.quicksight#InsightVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "InsightConfiguration": { - "target": "com.amazonaws.quicksight#InsightConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of an insight visual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "DataSetIdentifier": { - "target": "com.amazonaws.quicksight#DataSetIdentifier", - "traits": { - "smithy.api#documentation": "

The dataset that is used in the insight visual.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An insight visual.

\n

For more information, see Working with insights in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#InstanceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#Integer": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.quicksight#IntegerDatasetParameter": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.quicksight#DatasetParameterId", - "traits": { - "smithy.api#documentation": "

An identifier for the integer parameter created in the dataset.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DatasetParameterName", - "traits": { - "smithy.api#documentation": "

The name of the integer parameter that is created in the dataset.

", - "smithy.api#required": {} - } - }, - "ValueType": { - "target": "com.amazonaws.quicksight#DatasetParameterValueType", - "traits": { - "smithy.api#documentation": "

The value type of the dataset parameter. Valid values are single value or multi value.

", - "smithy.api#required": {} - } - }, - "DefaultValues": { - "target": "com.amazonaws.quicksight#IntegerDatasetParameterDefaultValues", - "traits": { - "smithy.api#documentation": "

A list of default values for a given integer parameter. This structure only accepts static values.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An integer parameter for a dataset.

" - } - }, - "com.amazonaws.quicksight#IntegerDatasetParameterDefaultValue": { - "type": "long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The default value for the integer parameter.

" - } - }, - "com.amazonaws.quicksight#IntegerDatasetParameterDefaultValues": { - "type": "structure", - "members": { - "StaticValues": { - "target": "com.amazonaws.quicksight#IntegerDatasetParameterValueList", - "traits": { - "smithy.api#documentation": "

A list of static default values for a given integer parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default values of an integer parameter.

" - } - }, - "com.amazonaws.quicksight#IntegerDatasetParameterValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#IntegerDatasetParameterDefaultValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.quicksight#IntegerDefaultValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SensitiveLongObject" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50000 - } - } - }, - "com.amazonaws.quicksight#IntegerDefaultValues": { - "type": "structure", - "members": { - "DynamicValue": { - "target": "com.amazonaws.quicksight#DynamicDefaultValue", - "traits": { - "smithy.api#documentation": "

The dynamic value of the IntegerDefaultValues. Different defaults are displayed according to users, groups, and values mapping.

" - } - }, - "StaticValues": { - "target": "com.amazonaws.quicksight#IntegerDefaultValueList", - "traits": { - "smithy.api#documentation": "

The static values of the IntegerDefaultValues.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default values of the IntegerParameterDeclaration.

" - } - }, - "com.amazonaws.quicksight#IntegerParameter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the integer parameter.

", - "smithy.api#required": {} - } - }, - "Values": { - "target": "com.amazonaws.quicksight#SensitiveLongList", - "traits": { - "smithy.api#documentation": "

The values for the integer parameter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An integer parameter.

" - } - }, - "com.amazonaws.quicksight#IntegerParameterDeclaration": { - "type": "structure", - "members": { - "ParameterValueType": { - "target": "com.amazonaws.quicksight#ParameterValueType", - "traits": { - "smithy.api#documentation": "

The value type determines whether the parameter is a single-value or multi-value parameter.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The name of the parameter that is being declared.

", - "smithy.api#required": {} - } - }, - "DefaultValues": { - "target": "com.amazonaws.quicksight#IntegerDefaultValues", - "traits": { - "smithy.api#documentation": "

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

" - } - }, - "ValueWhenUnset": { - "target": "com.amazonaws.quicksight#IntegerValueWhenUnsetConfiguration", - "traits": { - "smithy.api#documentation": "

A parameter declaration for the Integer data type.

" - } - }, - "MappedDataSetParameters": { - "target": "com.amazonaws.quicksight#MappedDataSetParameters" - } - }, - "traits": { - "smithy.api#documentation": "

A parameter declaration for the Integer data type.

" - } - }, - "com.amazonaws.quicksight#IntegerParameterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#IntegerParameter" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#IntegerValueWhenUnsetConfiguration": { - "type": "structure", - "members": { - "ValueWhenUnsetOption": { - "target": "com.amazonaws.quicksight#ValueWhenUnsetOption", - "traits": { - "smithy.api#documentation": "

The built-in options for default values. The value can be one of the following:

\n " - } - }, - "CustomValue": { - "target": "com.amazonaws.quicksight#SensitiveLong", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

A custom value that's used when the value of a parameter isn't set.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A parameter declaration for the Integer data type.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#InternalFailureException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An internal failure occurred.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.quicksight#InvalidNextTokenException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The NextToken value isn't valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.quicksight#InvalidParameterValueException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

One or more parameters has a value that isn't valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.quicksight#InvalidRequestException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.quicksight#InvalidTopicReviewedAnswer": { - "type": "structure", - "members": { - "AnswerId": { - "target": "com.amazonaws.quicksight#AnswerId", - "traits": { - "smithy.api#documentation": "

The answer ID for the InvalidTopicReviewedAnswer.

" - } - }, - "Error": { - "target": "com.amazonaws.quicksight#ReviewedAnswerErrorCode", - "traits": { - "smithy.api#documentation": "

The error that is returned for the InvalidTopicReviewedAnswer.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a InvalidTopicReviewedAnswer.

" - } - }, - "com.amazonaws.quicksight#InvalidTopicReviewedAnswers": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#InvalidTopicReviewedAnswer" - } - }, - "com.amazonaws.quicksight#IpRestrictionRuleDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 150 - } - } - }, - "com.amazonaws.quicksight#IpRestrictionRuleMap": { - "type": "map", - "key": { - "target": "com.amazonaws.quicksight#CIDR" - }, - "value": { - "target": "com.amazonaws.quicksight#IpRestrictionRuleDescription" - } - }, - "com.amazonaws.quicksight#ItemsLimitConfiguration": { - "type": "structure", - "members": { - "ItemsLimit": { - "target": "com.amazonaws.quicksight#Long", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The limit on how many items of a field are showed in the chart. For\n example, the number of slices that are displayed in a pie chart.

" - } - }, - "OtherCategories": { - "target": "com.amazonaws.quicksight#OtherCategories", - "traits": { - "smithy.api#documentation": "

The Show\n other of an axis in the chart. Choose one of the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The limit configuration of the visual display for an axis.

" - } - }, - "com.amazonaws.quicksight#JiraParameters": { - "type": "structure", - "members": { - "SiteBaseUrl": { - "target": "com.amazonaws.quicksight#SiteBaseUrl", - "traits": { - "smithy.api#documentation": "

The base URL of the Jira site.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for Jira.

" - } - }, - "com.amazonaws.quicksight#JoinInstruction": { - "type": "structure", - "members": { - "LeftOperand": { - "target": "com.amazonaws.quicksight#LogicalTableId", - "traits": { - "smithy.api#documentation": "

The operand on the left side of a join.

", - "smithy.api#required": {} - } - }, - "RightOperand": { - "target": "com.amazonaws.quicksight#LogicalTableId", - "traits": { - "smithy.api#documentation": "

The operand on the right side of a join.

", - "smithy.api#required": {} - } - }, - "LeftJoinKeyProperties": { - "target": "com.amazonaws.quicksight#JoinKeyProperties", - "traits": { - "smithy.api#documentation": "

Join key properties of the left operand.

" - } - }, - "RightJoinKeyProperties": { - "target": "com.amazonaws.quicksight#JoinKeyProperties", - "traits": { - "smithy.api#documentation": "

Join key properties of the right operand.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#JoinType", - "traits": { - "smithy.api#documentation": "

The type of join that it is.

", - "smithy.api#required": {} - } - }, - "OnClause": { - "target": "com.amazonaws.quicksight#OnClause", - "traits": { - "smithy.api#documentation": "

The join instructions provided in the ON clause of a join.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The instructions associated with a join.

" - } - }, - "com.amazonaws.quicksight#JoinKeyProperties": { - "type": "structure", - "members": { - "UniqueKey": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

A value that indicates that a row in a table is uniquely identified by the columns in\n a join key. This is used by Amazon QuickSight to optimize query performance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Properties associated with the columns participating in a join.

" - } - }, - "com.amazonaws.quicksight#JoinType": { - "type": "enum", - "members": { - "INNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INNER" - } - }, - "OUTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OUTER" - } - }, - "LEFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LEFT" - } - }, - "RIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RIGHT" - } - } - } - }, - "com.amazonaws.quicksight#KPIActualValueConditionalFormatting": { - "type": "structure", - "members": { - "TextColor": { - "target": "com.amazonaws.quicksight#ConditionalFormattingColor", - "traits": { - "smithy.api#documentation": "

The conditional formatting of the actual value's text color.

" - } - }, - "Icon": { - "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", - "traits": { - "smithy.api#documentation": "

The conditional formatting of the actual value's icon.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting for the actual value of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPIComparisonValueConditionalFormatting": { - "type": "structure", - "members": { - "TextColor": { - "target": "com.amazonaws.quicksight#ConditionalFormattingColor", - "traits": { - "smithy.api#documentation": "

The conditional formatting of the comparison value's text color.

" - } - }, - "Icon": { - "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", - "traits": { - "smithy.api#documentation": "

The conditional formatting of the comparison value's icon.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting for the comparison value of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPIConditionalFormatting": { - "type": "structure", - "members": { - "ConditionalFormattingOptions": { - "target": "com.amazonaws.quicksight#KPIConditionalFormattingOptionList", - "traits": { - "smithy.api#documentation": "

The conditional formatting options of a KPI visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPIConditionalFormattingOption": { - "type": "structure", - "members": { - "PrimaryValue": { - "target": "com.amazonaws.quicksight#KPIPrimaryValueConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The conditional formatting for the primary value of a KPI visual.

" - } - }, - "ProgressBar": { - "target": "com.amazonaws.quicksight#KPIProgressBarConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The conditional formatting for the progress bar of a KPI visual.

" - } - }, - "ActualValue": { - "target": "com.amazonaws.quicksight#KPIActualValueConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The conditional formatting for the actual value of a KPI visual.

" - } - }, - "ComparisonValue": { - "target": "com.amazonaws.quicksight#KPIComparisonValueConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The conditional formatting for the comparison value of a KPI visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting options of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPIConditionalFormattingOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#KPIConditionalFormattingOption" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#KPIConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#KPIFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a KPI visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#KPISortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a KPI visual.

" - } - }, - "KPIOptions": { - "target": "com.amazonaws.quicksight#KPIOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of a KPI visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPIFieldWells": { - "type": "structure", - "members": { - "Values": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The value field wells of a KPI visual.

" - } - }, - "TargetValues": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The target value field wells of a KPI visual.

" - } - }, - "TrendGroups": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The trend group field wells of a KPI visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPIOptions": { - "type": "structure", - "members": { - "ProgressBar": { - "target": "com.amazonaws.quicksight#ProgressBarOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the progress bar of a KPI visual.

" - } - }, - "TrendArrows": { - "target": "com.amazonaws.quicksight#TrendArrowOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of trend arrows in a KPI visual.

" - } - }, - "SecondaryValue": { - "target": "com.amazonaws.quicksight#SecondaryValueOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the secondary value of a KPI visual.

" - } - }, - "Comparison": { - "target": "com.amazonaws.quicksight#ComparisonConfiguration", - "traits": { - "smithy.api#documentation": "

The comparison configuration of a KPI visual.

" - } - }, - "PrimaryValueDisplayType": { - "target": "com.amazonaws.quicksight#PrimaryValueDisplayType", - "traits": { - "smithy.api#documentation": "

The options that determine the primary value display type.

" - } - }, - "PrimaryValueFontConfiguration": { - "target": "com.amazonaws.quicksight#FontConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the primary value font configuration.

" - } - }, - "SecondaryValueFontConfiguration": { - "target": "com.amazonaws.quicksight#FontConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the secondary value font configuration.

" - } - }, - "Sparkline": { - "target": "com.amazonaws.quicksight#KPISparklineOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

" - } - }, - "VisualLayoutOptions": { - "target": "com.amazonaws.quicksight#KPIVisualLayoutOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the layout a KPI visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPIPrimaryValueConditionalFormatting": { - "type": "structure", - "members": { - "TextColor": { - "target": "com.amazonaws.quicksight#ConditionalFormattingColor", - "traits": { - "smithy.api#documentation": "

The conditional formatting of the primary value's text color.

" - } - }, - "Icon": { - "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", - "traits": { - "smithy.api#documentation": "

The conditional formatting of the primary value's icon.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting for the primary value of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPIProgressBarConditionalFormatting": { - "type": "structure", - "members": { - "ForegroundColor": { - "target": "com.amazonaws.quicksight#ConditionalFormattingColor", - "traits": { - "smithy.api#documentation": "

The conditional formatting of the progress bar's foreground color.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting for the progress bar of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPISortConfiguration": { - "type": "structure", - "members": { - "TrendGroupSort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the trend group fields.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPISparklineOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the sparkline.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#KPISparklineType", - "traits": { - "smithy.api#documentation": "

The type of the sparkline.

", - "smithy.api#required": {} - } - }, - "Color": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color of the sparkline.

" - } - }, - "TooltipVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The tooltip visibility of the sparkline.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPISparklineType": { - "type": "enum", - "members": { - "LINE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LINE" - } - }, - "AREA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AREA" - } - } - } - }, - "com.amazonaws.quicksight#KPIVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#KPIConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of a KPI visual.

" - } - }, - "ConditionalFormatting": { - "target": "com.amazonaws.quicksight#KPIConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The conditional formatting of a KPI visual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A key performance indicator (KPI).

\n

For more information, see Using KPIs in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#KPIVisualLayoutOptions": { - "type": "structure", - "members": { - "StandardLayout": { - "target": "com.amazonaws.quicksight#KPIVisualStandardLayout", - "traits": { - "smithy.api#documentation": "

The standard layout of the KPI visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the layout a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPIVisualStandardLayout": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.quicksight#KPIVisualStandardLayoutType", - "traits": { - "smithy.api#documentation": "

The standard layout type.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The standard layout of the KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPIVisualStandardLayoutType": { - "type": "enum", - "members": { - "CLASSIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLASSIC" - } - }, - "VERTICAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VERTICAL" - } - } - } - }, - "com.amazonaws.quicksight#KeyRegistration": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#RegisteredCustomerManagedKey" - } - }, - "com.amazonaws.quicksight#LabelOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines whether or not the label is visible.

" - } - }, - "FontConfiguration": { - "target": "com.amazonaws.quicksight#FontConfiguration", - "traits": { - "smithy.api#documentation": "

The font configuration of the label.

" - } - }, - "CustomLabel": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The text for the label.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The share label options for the labels.

" - } - }, - "com.amazonaws.quicksight#Latitude": { - "type": "double", - "traits": { - "smithy.api#range": { - "min": -90, - "max": 90 - } - } - }, - "com.amazonaws.quicksight#Layout": { - "type": "structure", - "members": { - "Configuration": { - "target": "com.amazonaws.quicksight#LayoutConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration that determines what the type of layout for a sheet.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A Layout defines the placement of elements within a sheet.

\n

For more information, see Types of layout in the Amazon QuickSight User Guide.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#LayoutConfiguration": { - "type": "structure", - "members": { - "GridLayout": { - "target": "com.amazonaws.quicksight#GridLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

A type of layout that can be used on a sheet. In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: FIXED or RESPONSIVE.

" - } - }, - "FreeFormLayout": { - "target": "com.amazonaws.quicksight#FreeFormLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.

" - } - }, - "SectionBasedLayout": { - "target": "com.amazonaws.quicksight#SectionBasedLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

A section based layout organizes visuals into multiple sections and has customized header, footer and page break.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration that determines what the type of layout will be used on a sheet.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#LayoutElementType": { - "type": "enum", - "members": { - "VISUAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VISUAL" - } - }, - "FILTER_CONTROL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FILTER_CONTROL" - } - }, - "PARAMETER_CONTROL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARAMETER_CONTROL" - } - }, - "TEXT_BOX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TEXT_BOX" - } - } - } - }, - "com.amazonaws.quicksight#LayoutList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Layout" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#LegendOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines whether or not the legend is visible.

" - } - }, - "Title": { - "target": "com.amazonaws.quicksight#LabelOptions", - "traits": { - "smithy.api#documentation": "

The custom title for the legend.

" - } - }, - "Position": { - "target": "com.amazonaws.quicksight#LegendPosition", - "traits": { - "smithy.api#documentation": "

The positions for the legend. Choose one of the following\n options:

\n " - } - }, - "Width": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The width of the legend. If this value is omitted, a default width is used when rendering.

" - } - }, - "Height": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The height of the legend. If this value is omitted, a default height is used when\n rendering.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options for the legend setup of a visual.

" - } - }, - "com.amazonaws.quicksight#LegendPosition": { - "type": "enum", - "members": { - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - }, - "RIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RIGHT" - } - }, - "BOTTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOTTOM" - } - }, - "TOP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TOP" - } - } - } - }, - "com.amazonaws.quicksight#Length": { - "type": "string", - "traits": { - "smithy.api#documentation": "String based length that is composed of value and unit" - } - }, - "com.amazonaws.quicksight#LimitExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "ResourceType": { - "target": "com.amazonaws.quicksight#ExceptionResourceType", - "traits": { - "smithy.api#documentation": "

Limit exceeded.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A limit is exceeded.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.quicksight#LimitedString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.quicksight#LineChartAggregatedFieldWells": { - "type": "structure", - "members": { - "Category": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The category field wells of a line chart. Values are grouped by category fields.

" - } - }, - "Values": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The value field wells of a line chart. Values are aggregated based on categories.

" - } - }, - "Colors": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The color field wells of a line chart. Values are grouped by category fields.

" - } - }, - "SmallMultiples": { - "target": "com.amazonaws.quicksight#SmallMultiplesDimensionFieldList", - "traits": { - "smithy.api#documentation": "

The small multiples field well of a line chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a line chart.

" - } - }, - "com.amazonaws.quicksight#LineChartConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#LineChartFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a line chart.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#LineChartSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a line chart.

" - } - }, - "ForecastConfigurations": { - "target": "com.amazonaws.quicksight#ForecastConfigurationList", - "traits": { - "smithy.api#documentation": "

The forecast configuration of a line chart.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#LineChartType", - "traits": { - "smithy.api#documentation": "

Determines the type of the line chart.

" - } - }, - "SmallMultiplesOptions": { - "target": "com.amazonaws.quicksight#SmallMultiplesOptions", - "traits": { - "smithy.api#documentation": "

The small multiples setup for the visual.

" - } - }, - "XAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the x-axis.

" - } - }, - "XAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the x-axis label.

" - } - }, - "PrimaryYAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#LineSeriesAxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The series axis configuration of a line chart.

" - } - }, - "PrimaryYAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the y-axis label.

" - } - }, - "SecondaryYAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#LineSeriesAxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The series axis configuration of a line chart.

" - } - }, - "SecondaryYAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the secondary y-axis label.

" - } - }, - "SingleAxisOptions": { - "target": "com.amazonaws.quicksight#SingleAxisOptions" - }, - "DefaultSeriesSettings": { - "target": "com.amazonaws.quicksight#LineChartDefaultSeriesSettings", - "traits": { - "smithy.api#documentation": "

The options that determine the default presentation of all line series in LineChartVisual.

" - } - }, - "Series": { - "target": "com.amazonaws.quicksight#SeriesItemList", - "traits": { - "smithy.api#documentation": "

The series item configuration of a line chart.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "

The legend configuration of a line chart.

" - } - }, - "DataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The data label configuration of a line chart.

" - } - }, - "ReferenceLines": { - "target": "com.amazonaws.quicksight#ReferenceLineList", - "traits": { - "smithy.api#documentation": "

The reference lines configuration of a line chart.

" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The tooltip configuration of a line chart.

" - } - }, - "ContributionAnalysisDefaults": { - "target": "com.amazonaws.quicksight#ContributionAnalysisDefaultList", - "traits": { - "smithy.api#documentation": "

The default configuration of a line chart's contribution analysis.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "

The visual palette configuration of a line chart.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a line chart.

" - } - }, - "com.amazonaws.quicksight#LineChartDefaultSeriesSettings": { - "type": "structure", - "members": { - "AxisBinding": { - "target": "com.amazonaws.quicksight#AxisBinding", - "traits": { - "smithy.api#documentation": "

The axis to which you are binding all line series to.

" - } - }, - "LineStyleSettings": { - "target": "com.amazonaws.quicksight#LineChartLineStyleSettings", - "traits": { - "smithy.api#documentation": "

Line styles options for all line series in the visual.

" - } - }, - "MarkerStyleSettings": { - "target": "com.amazonaws.quicksight#LineChartMarkerStyleSettings", - "traits": { - "smithy.api#documentation": "

Marker styles options for all line series in the visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the default presentation of all line series in LineChartVisual.

" - } - }, - "com.amazonaws.quicksight#LineChartFieldWells": { - "type": "structure", - "members": { - "LineChartAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#LineChartAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a line chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a line chart.

" - } - }, - "com.amazonaws.quicksight#LineChartLineStyle": { - "type": "enum", - "members": { - "SOLID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOLID" - } - }, - "DOTTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOTTED" - } - }, - "DASHED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DASHED" - } - } - } - }, - "com.amazonaws.quicksight#LineChartLineStyleSettings": { - "type": "structure", - "members": { - "LineVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Configuration option that determines whether to show the line for the series.

" - } - }, - "LineInterpolation": { - "target": "com.amazonaws.quicksight#LineInterpolation", - "traits": { - "smithy.api#documentation": "

Interpolation style for line series.

\n " - } - }, - "LineStyle": { - "target": "com.amazonaws.quicksight#LineChartLineStyle", - "traits": { - "smithy.api#documentation": "

Line style for line series.

\n " - } - }, - "LineWidth": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

Width that determines the line thickness.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Line styles options for a line series in LineChartVisual.

" - } - }, - "com.amazonaws.quicksight#LineChartMarkerShape": { - "type": "enum", - "members": { - "CIRCLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CIRCLE" - } - }, - "TRIANGLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRIANGLE" - } - }, - "SQUARE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SQUARE" - } - }, - "DIAMOND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIAMOND" - } - }, - "ROUNDED_SQUARE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROUNDED_SQUARE" - } - } - } - }, - "com.amazonaws.quicksight#LineChartMarkerStyleSettings": { - "type": "structure", - "members": { - "MarkerVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Configuration option that determines whether to show the markers in the series.

" - } - }, - "MarkerShape": { - "target": "com.amazonaws.quicksight#LineChartMarkerShape", - "traits": { - "smithy.api#documentation": "

Shape option for markers in the series.

\n " - } - }, - "MarkerSize": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

Size of marker in the series.

" - } - }, - "MarkerColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

Color of marker in the series.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Marker styles options for a line series in LineChartVisual.

" - } - }, - "com.amazonaws.quicksight#LineChartSeriesSettings": { - "type": "structure", - "members": { - "LineStyleSettings": { - "target": "com.amazonaws.quicksight#LineChartLineStyleSettings", - "traits": { - "smithy.api#documentation": "

Line styles options for a line series in LineChartVisual.

" - } - }, - "MarkerStyleSettings": { - "target": "com.amazonaws.quicksight#LineChartMarkerStyleSettings", - "traits": { - "smithy.api#documentation": "

Marker styles options for a line series in LineChartVisual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of a line series in the visual

" - } - }, - "com.amazonaws.quicksight#LineChartSortConfiguration": { - "type": "structure", - "members": { - "CategorySort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the category fields.

" - } - }, - "CategoryItemsLimitConfiguration": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of categories that are displayed in a line chart.

" - } - }, - "ColorItemsLimitConfiguration": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of lines that are displayed in a line chart.

" - } - }, - "SmallMultiplesSort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the small multiples field.

" - } - }, - "SmallMultiplesLimitConfiguration": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of small multiples panels that are displayed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a line chart.

" - } - }, - "com.amazonaws.quicksight#LineChartType": { - "type": "enum", - "members": { - "LINE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LINE" - } - }, - "AREA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AREA" - } - }, - "STACKED_AREA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STACKED_AREA" - } - } - } - }, - "com.amazonaws.quicksight#LineChartVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#LineChartConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of a line chart.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A line chart.

\n

For more information, see Using line charts in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#LineInterpolation": { - "type": "enum", - "members": { - "LINEAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LINEAR" - } - }, - "SMOOTH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SMOOTH" - } - }, - "STEPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STEPPED" - } - } - } - }, - "com.amazonaws.quicksight#LineSeriesAxisDisplayOptions": { - "type": "structure", - "members": { - "AxisOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the line series axis.

" - } - }, - "MissingDataConfigurations": { - "target": "com.amazonaws.quicksight#MissingDataConfigurationList", - "traits": { - "smithy.api#documentation": "

The configuration options that determine how missing data is treated during the rendering of a line chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The series axis configuration of a line chart.

" - } - }, - "com.amazonaws.quicksight#LinkEntityArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^arn:aws[\\w\\-]*:quicksight:[\\w\\-]+:\\d+:analysis/[\\w\\-]{1,512}$" - } - }, - "com.amazonaws.quicksight#LinkEntityArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#LinkEntityArn" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.quicksight#LinkSharingConfiguration": { - "type": "structure", - "members": { - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A structure that contains the permissions of a shareable link.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains the configuration of a shareable link to the dashboard.

" - } - }, - "com.amazonaws.quicksight#ListAnalyses": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListAnalysesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListAnalysesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/analyses", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AnalysisSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListAnalysesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analyses.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListAnalysesResponse": { - "type": "structure", - "members": { - "AnalysisSummaryList": { - "target": "com.amazonaws.quicksight#AnalysisSummaryList", - "traits": { - "smithy.api#documentation": "

Metadata describing each of the analyses that are listed.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListAssetBundleExportJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListAssetBundleExportJobsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListAssetBundleExportJobsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/asset-bundle-export-jobs", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AssetBundleExportJobSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListAssetBundleExportJobsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that the export jobs were executed in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListAssetBundleExportJobsResponse": { - "type": "structure", - "members": { - "AssetBundleExportJobSummaryList": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobSummaryList", - "traits": { - "smithy.api#documentation": "

A list of export job summaries.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListAssetBundleImportJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListAssetBundleImportJobsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListAssetBundleImportJobsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/asset-bundle-import-jobs", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AssetBundleImportJobSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListAssetBundleImportJobsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that the import jobs were executed in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListAssetBundleImportJobsResponse": { - "type": "structure", - "members": { - "AssetBundleImportJobSummaryList": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobSummaryList", - "traits": { - "smithy.api#documentation": "

A list of import job summaries.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the response.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListControlDisplayOptions": { - "type": "structure", - "members": { - "SearchOptions": { - "target": "com.amazonaws.quicksight#ListControlSearchOptions", - "traits": { - "smithy.api#documentation": "

The configuration of the search options in a list control.

" - } - }, - "SelectAllOptions": { - "target": "com.amazonaws.quicksight#ListControlSelectAllOptions", - "traits": { - "smithy.api#documentation": "

The configuration of the Select all options in a list control.

" - } - }, - "TitleOptions": { - "target": "com.amazonaws.quicksight#LabelOptions", - "traits": { - "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" - } - }, - "InfoIconLabelOptions": { - "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", - "traits": { - "smithy.api#documentation": "

The configuration of info icon label options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "com.amazonaws.quicksight#ListControlSearchOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility configuration of the search options in a list control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of the search options in a list control.

" - } - }, - "com.amazonaws.quicksight#ListControlSelectAllOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility configuration of the Select all options in a list control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of the Select all options in a list control.

" - } - }, - "com.amazonaws.quicksight#ListDashboardVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListDashboardVersionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListDashboardVersionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all the versions of the dashboards in the Amazon QuickSight subscription.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/versions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "DashboardVersionSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListDashboardVersionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're listing versions\n for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListDashboardVersionsResponse": { - "type": "structure", - "members": { - "DashboardVersionSummaryList": { - "target": "com.amazonaws.quicksight#DashboardVersionSummaryList", - "traits": { - "smithy.api#documentation": "

A structure that contains information about each version of the dashboard.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListDashboards": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListDashboardsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListDashboardsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists dashboards in an Amazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/dashboards", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "DashboardSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListDashboardsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboards that you're\n listing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListDashboardsResponse": { - "type": "structure", - "members": { - "DashboardSummaryList": { - "target": "com.amazonaws.quicksight#DashboardSummaryList", - "traits": { - "smithy.api#documentation": "

A structure that contains all of the dashboards in your Amazon Web Services account. This structure\n provides basic information about the dashboards.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListDataSets": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListDataSetsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListDataSetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.

\n

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "DataSetSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListDataSetsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListDataSetsResponse": { - "type": "structure", - "members": { - "DataSetSummaries": { - "target": "com.amazonaws.quicksight#DataSetSummaryList", - "traits": { - "smithy.api#documentation": "

The list of dataset summaries.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListDataSources": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListDataSourcesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListDataSourcesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sources", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "DataSources", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListDataSourcesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListDataSourcesResponse": { - "type": "structure", - "members": { - "DataSources": { - "target": "com.amazonaws.quicksight#DataSourceList", - "traits": { - "smithy.api#documentation": "

A list of data sources.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListFolderMembers": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListFolderMembersRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListFolderMembersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/members", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "FolderMemberList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListFolderMembersRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListFolderMembersResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "FolderMemberList": { - "target": "com.amazonaws.quicksight#FolderMemberList", - "traits": { - "smithy.api#documentation": "

A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListFolders": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListFoldersRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListFoldersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all folders in an account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/folders", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "FolderSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListFoldersRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListFoldersResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "FolderSummaryList": { - "target": "com.amazonaws.quicksight#FolderSummaryList", - "traits": { - "smithy.api#documentation": "

A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListGroupMemberships": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListGroupMembershipsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListGroupMembershipsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists member users in a group.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "GroupMemberList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListGroupMembershipsRequest": { - "type": "structure", - "members": { - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

The name of the group that you want to see a membership list of.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return from this request.

", - "smithy.api#httpQuery": "max-results" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace of the group that you want a list of users from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListGroupMembershipsResponse": { - "type": "structure", - "members": { - "GroupMemberList": { - "target": "com.amazonaws.quicksight#GroupMemberList", - "traits": { - "smithy.api#documentation": "

The list of the members of the group.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListGroupsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all user groups in Amazon QuickSight.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "GroupList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListGroupsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "max-results" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that you want a list of groups from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListGroupsResponse": { - "type": "structure", - "members": { - "GroupList": { - "target": "com.amazonaws.quicksight#GroupList", - "traits": { - "smithy.api#documentation": "

The list of the groups.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListIAMPolicyAssignments": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListIAMPolicyAssignmentsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListIAMPolicyAssignmentsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the\n\t\t\tIAM policy assignments in the current Amazon QuickSight\n\t\t\taccount.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/v2/iam-policy-assignments", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "IAMPolicyAssignments", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUserRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConcurrentUpdatingException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all of\n\t\t\tthe IAM policy assignments, including the Amazon\n\t\t\tResource Names\n\t\t\t(ARNs),\n\t\t\tfor the IAM policies assigned to the specified user and\n\t\t\tgroup,\n\t\t\tor groups that the user belongs to.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/iam-policy-assignments", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ActiveAssignments", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUserRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the assignments.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "UserName": { - "target": "com.amazonaws.quicksight#UserName", - "traits": { - "smithy.api#documentation": "

The name of the user.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace of the assignment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUserResponse": { - "type": "structure", - "members": { - "ActiveAssignments": { - "target": "com.amazonaws.quicksight#ActiveIAMPolicyAssignmentList", - "traits": { - "smithy.api#documentation": "

The active assignments for this user.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListIAMPolicyAssignmentsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains these IAM policy\n\t\t\tassignments.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", - "traits": { - "smithy.api#documentation": "

The status of the assignments.

", - "smithy.api#httpQuery": "assignment-status" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace for the assignments.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListIAMPolicyAssignmentsResponse": { - "type": "structure", - "members": { - "IAMPolicyAssignments": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentSummaryList", - "traits": { - "smithy.api#documentation": "

Information describing the IAM policy assignments.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListIdentityPropagationConfigs": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListIdentityPropagationConfigsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListIdentityPropagationConfigsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.

\n

This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/identity-propagation-config", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#ListIdentityPropagationConfigsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contain the identity propagation configurations of.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#ListIdentityPropagationMaxResults", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to be returned.

", - "smithy.api#httpQuery": "max-results" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListIdentityPropagationConfigsResponse": { - "type": "structure", - "members": { - "Services": { - "target": "com.amazonaws.quicksight#AuthorizedTargetsByServices", - "traits": { - "smithy.api#documentation": "

A list of services and their authorized targets that the Amazon QuickSight IAM Identity Center application can access.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListIdentityPropagationMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#ListIngestions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListIngestionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListIngestionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the history of SPICE ingestions for a dataset.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Ingestions", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListIngestionsRequest": { - "type": "structure", - "members": { - "DataSetId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the dataset used in the ingestion.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#IngestionMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListIngestionsResponse": { - "type": "structure", - "members": { - "Ingestions": { - "target": "com.amazonaws.quicksight#Ingestions", - "traits": { - "smithy.api#documentation": "

A list of the ingestions.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListNamespaces": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListNamespacesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListNamespacesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Namespaces", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListNamespacesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous ListNameSpaces API call if there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListNamespacesResponse": { - "type": "structure", - "members": { - "Namespaces": { - "target": "com.amazonaws.quicksight#Namespaces", - "traits": { - "smithy.api#documentation": "

The information about the namespaces in this Amazon Web Services account. The response includes \n the namespace ARN, name, Amazon Web Services Region, notification email address, creation status, and \n identity store.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A unique pagination token that can be used in a subsequent request. Receiving NextToken in your response inticates that there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListRefreshSchedules": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListRefreshSchedulesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListRefreshSchedulesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#ListRefreshSchedulesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListRefreshSchedulesResponse": { - "type": "structure", - "members": { - "RefreshSchedules": { - "target": "com.amazonaws.quicksight#RefreshSchedules", - "traits": { - "smithy.api#documentation": "

The list of refresh schedules for the dataset.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListRoleMemberships": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListRoleMembershipsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListRoleMembershipsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all groups that are associated with a role.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "MembersList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListRoleMembershipsRequest": { - "type": "structure", - "members": { - "Role": { - "target": "com.amazonaws.quicksight#Role", - "traits": { - "smithy.api#documentation": "

The name of the role.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "max-results" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that includes the role.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListRoleMembershipsResponse": { - "type": "structure", - "members": { - "MembersList": { - "target": "com.amazonaws.quicksight#GroupsList", - "traits": { - "smithy.api#documentation": "

The list of groups associated with a role

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the tags assigned to a resource.

", - "smithy.api#http": { - "method": "GET", - "uri": "/resources/{ResourceArn}/tags", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want a list of tags for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the\n\t\t\tresource.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListTemplateAliases": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListTemplateAliasesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListTemplateAliasesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all the aliases of a template.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/aliases", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TemplateAliasList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListTemplateAliasesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template aliases that you're listing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-result" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListTemplateAliasesResponse": { - "type": "structure", - "members": { - "TemplateAliasList": { - "target": "com.amazonaws.quicksight#TemplateAliasList", - "traits": { - "smithy.api#documentation": "

A structure containing the list of the template's aliases.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListTemplateVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListTemplateVersionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListTemplateVersionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all the versions of the templates in the current Amazon QuickSight account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/versions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TemplateVersionSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListTemplateVersionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the templates that you're listing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListTemplateVersionsResponse": { - "type": "structure", - "members": { - "TemplateVersionSummaryList": { - "target": "com.amazonaws.quicksight#TemplateVersionSummaryList", - "traits": { - "smithy.api#documentation": "

A structure containing a list of all the versions of the specified template.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListTemplates": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListTemplatesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListTemplatesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all the templates in the current Amazon QuickSight account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/templates", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TemplateSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListTemplatesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the templates that you're listing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-result" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListTemplatesResponse": { - "type": "structure", - "members": { - "TemplateSummaryList": { - "target": "com.amazonaws.quicksight#TemplateSummaryList", - "traits": { - "smithy.api#documentation": "

A structure containing information about the templates in the list.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListThemeAliases": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListThemeAliasesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListThemeAliasesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all the aliases of a theme.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/aliases", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#ListThemeAliasesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme aliases that you're listing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-result" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListThemeAliasesResponse": { - "type": "structure", - "members": { - "ThemeAliasList": { - "target": "com.amazonaws.quicksight#ThemeAliasList", - "traits": { - "smithy.api#documentation": "

A structure containing the list of the theme's aliases.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListThemeVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListThemeVersionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListThemeVersionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all the versions of the themes in the current Amazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/versions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ThemeVersionSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListThemeVersionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the themes that you're listing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListThemeVersionsResponse": { - "type": "structure", - "members": { - "ThemeVersionSummaryList": { - "target": "com.amazonaws.quicksight#ThemeVersionSummaryList", - "traits": { - "smithy.api#documentation": "

A structure containing a list of all the versions of the specified theme.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListThemes": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListThemesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListThemesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all the themes in the current Amazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/themes", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ThemeSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListThemesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the themes that you're listing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#ThemeType", - "traits": { - "smithy.api#documentation": "

The type of themes that you want to list. Valid options include the following:

\n ", - "smithy.api#httpQuery": "type" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListThemesResponse": { - "type": "structure", - "members": { - "ThemeSummaryList": { - "target": "com.amazonaws.quicksight#ThemeSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the themes in the list.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListTopicRefreshSchedules": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListTopicRefreshSchedulesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListTopicRefreshSchedulesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all of the refresh schedules for a topic.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#ListTopicRefreshSchedulesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic whose refresh schedule\n you want described.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListTopicRefreshSchedulesResponse": { - "type": "structure", - "members": { - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "TopicArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "RefreshSchedules": { - "target": "com.amazonaws.quicksight#TopicRefreshScheduleSummaries", - "traits": { - "smithy.api#documentation": "

The list of topic refresh schedules.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListTopicReviewedAnswers": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListTopicReviewedAnswersRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListTopicReviewedAnswersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all reviewed answers for a Q Topic.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/reviewed-answers", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#ListTopicReviewedAnswersRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that containd the reviewed answers that you want listed.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListTopicReviewedAnswersResponse": { - "type": "structure", - "members": { - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "TopicArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "Answers": { - "target": "com.amazonaws.quicksight#TopicReviewedAnswers", - "traits": { - "smithy.api#documentation": "

The definition of all Answers in the topic.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListTopics": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListTopicsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListTopicsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all of the topics within an account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/topics", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListTopicsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topics that you want to\n list.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListTopicsResponse": { - "type": "structure", - "members": { - "TopicsSummaries": { - "target": "com.amazonaws.quicksight#TopicSummaries", - "traits": { - "smithy.api#documentation": "

A list of topic summaries.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListUserGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListUserGroupsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListUserGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/groups", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "GroupList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListUserGroupsRequest": { - "type": "structure", - "members": { - "UserName": { - "target": "com.amazonaws.quicksight#UserName", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight user name that you want to list group memberships for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account\n\t\t\tthat contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return from this request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListUserGroupsResponse": { - "type": "structure", - "members": { - "GroupList": { - "target": "com.amazonaws.quicksight#GroupList", - "traits": { - "smithy.api#documentation": "

The list of groups the user is a member of.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListUsers": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListUsersRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListUsersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of all of the Amazon QuickSight users belonging to this account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "UserList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListUsersRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return from this request.

", - "smithy.api#httpQuery": "max-results" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListUsersResponse": { - "type": "structure", - "members": { - "UserList": { - "target": "com.amazonaws.quicksight#UserList", - "traits": { - "smithy.api#documentation": "

The list of users.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListVPCConnections": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListVPCConnectionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListVPCConnectionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all of the VPC connections in the current set Amazon Web Services Region of an\n\t\t\t\tAmazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/vpc-connections", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListVPCConnectionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the account that contains the VPC connections\n\t\t\tthat you want to list.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListVPCConnectionsResponse": { - "type": "structure", - "members": { - "VPCConnectionSummaries": { - "target": "com.amazonaws.quicksight#VPCConnectionSummaryList", - "traits": { - "smithy.api#documentation": "

A VPCConnectionSummaries object that returns a summary of VPC connection\n\t\t\tobjects.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more\n\t\t\tresults.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#LoadingAnimation": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility configuration of LoadingAnimation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of loading animation in free-form layout.

" - } - }, - "com.amazonaws.quicksight#LocalNavigationConfiguration": { - "type": "structure", - "members": { - "TargetSheetId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The sheet that is targeted for navigation in the same analysis.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The navigation configuration for CustomActionNavigationOperation.

" - } - }, - "com.amazonaws.quicksight#LogicalTable": { - "type": "structure", - "members": { - "Alias": { - "target": "com.amazonaws.quicksight#LogicalTableAlias", - "traits": { - "smithy.api#documentation": "

A display name for the logical table.

", - "smithy.api#required": {} - } - }, - "DataTransforms": { - "target": "com.amazonaws.quicksight#TransformOperationList", - "traits": { - "smithy.api#documentation": "

Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.

" - } - }, - "Source": { - "target": "com.amazonaws.quicksight#LogicalTableSource", - "traits": { - "smithy.api#documentation": "

Source of this logical table.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A logical table is a unit that joins and that data\n transformations operate on. A logical table has a source, which can be either a physical\n table or result of a join. When a logical table points to a physical table, the logical\n table acts as a mutable copy of that physical table through transform operations.

" - } - }, - "com.amazonaws.quicksight#LogicalTableAlias": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#LogicalTableId": { - "type": "string", - "traits": { - "smithy.api#documentation": "

An identifier for the logical table that is defined in the dataset

", - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[0-9a-zA-Z-]*$" - } - }, - "com.amazonaws.quicksight#LogicalTableMap": { - "type": "map", - "key": { - "target": "com.amazonaws.quicksight#LogicalTableId" - }, - "value": { - "target": "com.amazonaws.quicksight#LogicalTable" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#LogicalTableSource": { - "type": "structure", - "members": { - "JoinInstruction": { - "target": "com.amazonaws.quicksight#JoinInstruction", - "traits": { - "smithy.api#documentation": "

Specifies the result of a join of two logical tables.

" - } - }, - "PhysicalTableId": { - "target": "com.amazonaws.quicksight#PhysicalTableId", - "traits": { - "smithy.api#documentation": "

Physical table ID.

" - } - }, - "DataSetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the parent dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the source of a logical table. This is a variant type structure. For\n this structure to be valid, only one of the attributes can be non-null.

" - } - }, - "com.amazonaws.quicksight#Long": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.quicksight#LongFormatText": { - "type": "structure", - "members": { - "PlainText": { - "target": "com.amazonaws.quicksight#LongPlainText", - "traits": { - "smithy.api#documentation": "

Plain text format.

" - } - }, - "RichText": { - "target": "com.amazonaws.quicksight#LongRichText", - "traits": { - "smithy.api#documentation": "

Rich text. Examples of rich text include bold, underline, and italics.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The text format for a subtitle.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#LongPlainText": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.quicksight#LongRichText": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#Longitude": { - "type": "double", - "traits": { - "smithy.api#range": { - "min": -1800, - "max": 1800 - } - } - }, - "com.amazonaws.quicksight#LookbackWindow": { - "type": "structure", - "members": { - "ColumnName": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of the lookback window column.

", - "smithy.api#required": {} - } - }, - "Size": { - "target": "com.amazonaws.quicksight#PositiveLong", - "traits": { - "smithy.api#documentation": "

The lookback window column size.

", - "smithy.api#required": {} - } - }, - "SizeUnit": { - "target": "com.amazonaws.quicksight#LookbackWindowSizeUnit", - "traits": { - "smithy.api#documentation": "

The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The lookback window setup of an incremental refresh configuration.

" - } - }, - "com.amazonaws.quicksight#LookbackWindowSizeUnit": { - "type": "enum", - "members": { - "HOUR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOUR" - } - }, - "DAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DAY" - } - }, - "WEEK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WEEK" - } - } - } - }, - "com.amazonaws.quicksight#ManifestFileLocation": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.quicksight#S3Bucket", - "traits": { - "smithy.api#documentation": "

Amazon S3 bucket.

", - "smithy.api#required": {} - } - }, - "Key": { - "target": "com.amazonaws.quicksight#S3Key", - "traits": { - "smithy.api#documentation": "

Amazon S3 key that identifies an object.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Amazon S3 manifest file location.

" - } - }, - "com.amazonaws.quicksight#MapZoomMode": { - "type": "enum", - "members": { - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - }, - "MANUAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MANUAL" - } - } - } - }, - "com.amazonaws.quicksight#MappedDataSetParameter": { - "type": "structure", - "members": { - "DataSetIdentifier": { - "target": "com.amazonaws.quicksight#DataSetIdentifier", - "traits": { - "smithy.api#documentation": "

A unique name that identifies a dataset within the analysis or dashboard.

", - "smithy.api#required": {} - } - }, - "DataSetParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The name of the dataset parameter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A dataset parameter that is mapped to an analysis parameter.

" - } - }, - "com.amazonaws.quicksight#MappedDataSetParameters": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MappedDataSetParameter" - }, - "traits": { - "smithy.api#documentation": "

A list of dataset parameters that are mapped to an analysis parameter.

", - "smithy.api#length": { - "min": 0, - "max": 150 - } - } - }, - "com.amazonaws.quicksight#MarginStyle": { - "type": "structure", - "members": { - "Show": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

This Boolean value controls whether to display sheet margins.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options for margins around the outside edge of sheets.

" - } - }, - "com.amazonaws.quicksight#MariaDbParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

Host.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

Port.

", - "smithy.api#required": {} - } - }, - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

Database.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for MariaDB.

" - } - }, - "com.amazonaws.quicksight#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#MaximumLabelType": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the maximum label.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The maximum label of a data path label.

" - } - }, - "com.amazonaws.quicksight#MaximumMinimumComputation": { - "type": "structure", - "members": { - "ComputationId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for a computation.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of a computation.

" - } - }, - "Time": { - "target": "com.amazonaws.quicksight#DimensionField", - "traits": { - "smithy.api#documentation": "

The time field that is used in a computation.

" - } - }, - "Value": { - "target": "com.amazonaws.quicksight#MeasureField", - "traits": { - "smithy.api#documentation": "

The value field that is used in a computation.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#MaximumMinimumComputationType", - "traits": { - "smithy.api#documentation": "

The type of computation. Choose one of the following options:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The maximum and minimum computation configuration.

" - } - }, - "com.amazonaws.quicksight#MaximumMinimumComputationType": { - "type": "enum", - "members": { - "MAXIMUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAXIMUM" - } - }, - "MINIMUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MINIMUM" - } - } - } - }, - "com.amazonaws.quicksight#MeasureField": { - "type": "structure", - "members": { - "NumericalMeasureField": { - "target": "com.amazonaws.quicksight#NumericalMeasureField", - "traits": { - "smithy.api#documentation": "

The measure type field with numerical type columns.

" - } - }, - "CategoricalMeasureField": { - "target": "com.amazonaws.quicksight#CategoricalMeasureField", - "traits": { - "smithy.api#documentation": "

The measure type field with categorical type columns.

" - } - }, - "DateMeasureField": { - "target": "com.amazonaws.quicksight#DateMeasureField", - "traits": { - "smithy.api#documentation": "

The measure type field with date type columns.

" - } - }, - "CalculatedMeasureField": { - "target": "com.amazonaws.quicksight#CalculatedMeasureField", - "traits": { - "smithy.api#documentation": "

The calculated measure field only used in pivot tables.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The measure (metric) type field.

" - } - }, - "com.amazonaws.quicksight#MeasureFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MeasureField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#MemberIdArnPair": { - "type": "structure", - "members": { - "MemberId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the member.

" - } - }, - "MemberArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the member.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that consists of a member Amazon Resource Name (ARN) and a member ID.

" - } - }, - "com.amazonaws.quicksight#MemberType": { - "type": "enum", - "members": { - "DASHBOARD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DASHBOARD" - } - }, - "ANALYSIS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ANALYSIS" - } - }, - "DATASET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATASET" - } - }, - "DATASOURCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATASOURCE" - } - }, - "TOPIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TOPIC" - } - } - } - }, - "com.amazonaws.quicksight#MetricComparisonComputation": { - "type": "structure", - "members": { - "ComputationId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for a computation.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of a computation.

" - } - }, - "Time": { - "target": "com.amazonaws.quicksight#DimensionField", - "traits": { - "smithy.api#documentation": "

The time field that is used in a computation.

" - } - }, - "FromValue": { - "target": "com.amazonaws.quicksight#MeasureField", - "traits": { - "smithy.api#documentation": "

The field that is used in a metric comparison from value setup.

" - } - }, - "TargetValue": { - "target": "com.amazonaws.quicksight#MeasureField", - "traits": { - "smithy.api#documentation": "

The field that is used in a metric comparison to value setup.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The metric comparison computation configuration.

" - } - }, - "com.amazonaws.quicksight#MinimumLabelType": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the minimum label.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum label of a data path label.

" - } - }, - "com.amazonaws.quicksight#MissingDataConfiguration": { - "type": "structure", - "members": { - "TreatmentOption": { - "target": "com.amazonaws.quicksight#MissingDataTreatmentOption", - "traits": { - "smithy.api#documentation": "

The treatment option that determines how missing data should be rendered. Choose\n from the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration options that determine how missing data is treated during the rendering of a line chart.

" - } - }, - "com.amazonaws.quicksight#MissingDataConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MissingDataConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#MissingDataTreatmentOption": { - "type": "enum", - "members": { - "INTERPOLATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERPOLATE" - } - }, - "SHOW_AS_ZERO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SHOW_AS_ZERO" - } - }, - "SHOW_AS_BLANK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SHOW_AS_BLANK" - } - } - } - }, - "com.amazonaws.quicksight#MySqlParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

Host.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

Port.

", - "smithy.api#required": {} - } - }, - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

Database.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for MySQL.

" - } - }, - "com.amazonaws.quicksight#NamedEntityAggType": { - "type": "enum", - "members": { - "SUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUM" - } - }, - "MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MIN" - } - }, - "MAX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX" - } - }, - "COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNT" - } - }, - "AVERAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVERAGE" - } - }, - "DISTINCT_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISTINCT_COUNT" - } - }, - "STDEV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEV" - } - }, - "STDEVP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEVP" - } - }, - "VAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VAR" - } - }, - "VARP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VARP" - } - }, - "PERCENTILE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENTILE" - } - }, - "MEDIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIAN" - } - }, - "CUSTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM" - } - } - } - }, - "com.amazonaws.quicksight#NamedEntityDefinition": { - "type": "structure", - "members": { - "FieldName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The name of the entity.

" - } - }, - "PropertyName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The property name to be used for the named entity.

" - } - }, - "PropertyRole": { - "target": "com.amazonaws.quicksight#PropertyRole", - "traits": { - "smithy.api#documentation": "

The property role. Valid values for this structure are PRIMARY and ID.

" - } - }, - "PropertyUsage": { - "target": "com.amazonaws.quicksight#PropertyUsage", - "traits": { - "smithy.api#documentation": "

The property usage. Valid values for this structure are INHERIT,\n DIMENSION,\n and MEASURE.

" - } - }, - "Metric": { - "target": "com.amazonaws.quicksight#NamedEntityDefinitionMetric", - "traits": { - "smithy.api#documentation": "

The definition of a metric.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a named entity.

" - } - }, - "com.amazonaws.quicksight#NamedEntityDefinitionMetric": { - "type": "structure", - "members": { - "Aggregation": { - "target": "com.amazonaws.quicksight#NamedEntityAggType", - "traits": { - "smithy.api#documentation": "

The aggregation of a named entity. Valid values for this structure are SUM,\n MIN, MAX, COUNT, AVERAGE,\n DISTINCT_COUNT, STDEV, STDEVP, VAR,\n VARP, PERCENTILE,\n MEDIAN,\n and CUSTOM.

" - } - }, - "AggregationFunctionParameters": { - "target": "com.amazonaws.quicksight#AggregationFunctionParameters", - "traits": { - "smithy.api#documentation": "

The additional parameters for an aggregation function.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a metric.

" - } - }, - "com.amazonaws.quicksight#NamedEntityDefinitions": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#NamedEntityDefinition" - } - }, - "com.amazonaws.quicksight#NamedEntityRef": { - "type": "structure", - "members": { - "NamedEntityName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The NamedEntityName for the NamedEntityRef.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a NamedEntityRef.

" - } - }, - "com.amazonaws.quicksight#NamedFilterAggType": { - "type": "enum", - "members": { - "NO_AGGREGATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NO_AGGREGATION" - } - }, - "SUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUM" - } - }, - "AVERAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVERAGE" - } - }, - "COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNT" - } - }, - "DISTINCT_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISTINCT_COUNT" - } - }, - "MAX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX" - } - }, - "MEDIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIAN" - } - }, - "MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MIN" - } - }, - "STDEV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEV" - } - }, - "STDEVP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEVP" - } - }, - "VAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VAR" - } - }, - "VARP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VARP" - } - } - } - }, - "com.amazonaws.quicksight#NamedFilterType": { - "type": "enum", - "members": { - "CATEGORY_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CATEGORY_FILTER" - } - }, - "NUMERIC_EQUALITY_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NUMERIC_EQUALITY_FILTER" - } - }, - "NUMERIC_RANGE_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NUMERIC_RANGE_FILTER" - } - }, - "DATE_RANGE_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATE_RANGE_FILTER" - } - }, - "RELATIVE_DATE_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RELATIVE_DATE_FILTER" - } - } - } - }, - "com.amazonaws.quicksight#Namespace": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[a-zA-Z0-9._-]*$" - } - }, - "com.amazonaws.quicksight#NamespaceError": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.quicksight#NamespaceErrorType", - "traits": { - "smithy.api#documentation": "

The error type.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The message for the error.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Errors that occur during namespace creation.

" - } - }, - "com.amazonaws.quicksight#NamespaceErrorType": { - "type": "enum", - "members": { - "PERMISSION_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERMISSION_DENIED" - } - }, - "INTERNAL_SERVICE_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_SERVICE_ERROR" - } - } - } - }, - "com.amazonaws.quicksight#NamespaceInfoV2": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The name of the error.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The namespace ARN.

" - } - }, - "CapacityRegion": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The namespace Amazon Web Services Region.

" - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#NamespaceStatus", - "traits": { - "smithy.api#documentation": "

The creation status of a namespace that is not yet completely created.

" - } - }, - "IdentityStore": { - "target": "com.amazonaws.quicksight#IdentityStore", - "traits": { - "smithy.api#documentation": "

The identity store used for the namespace.

" - } - }, - "NamespaceError": { - "target": "com.amazonaws.quicksight#NamespaceError", - "traits": { - "smithy.api#documentation": "

An error that occurred when the namespace was created.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The error type.

" - } - }, - "com.amazonaws.quicksight#NamespaceStatus": { - "type": "enum", - "members": { - "CREATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATED" - } - }, - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "RETRYABLE_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RETRYABLE_FAILURE" - } - }, - "NON_RETRYABLE_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NON_RETRYABLE_FAILURE" - } - } - } - }, - "com.amazonaws.quicksight#Namespaces": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#NamespaceInfoV2" - } - }, - "com.amazonaws.quicksight#NarrativeString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 150000 - } - } - }, - "com.amazonaws.quicksight#NegativeFormat": { - "type": "structure", - "members": { - "Prefix": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The prefix for a negative format.

" - } - }, - "Suffix": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The suffix for a negative format.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a negative format.

" - } - }, - "com.amazonaws.quicksight#NegativeValueConfiguration": { - "type": "structure", - "members": { - "DisplayMode": { - "target": "com.amazonaws.quicksight#NegativeValueDisplayMode", - "traits": { - "smithy.api#documentation": "

Determines the display mode of the negative value configuration.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the negative value configuration.

" - } - }, - "com.amazonaws.quicksight#NegativeValueDisplayMode": { - "type": "enum", - "members": { - "POSITIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POSITIVE" - } - }, - "NEGATIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEGATIVE" - } - } - } - }, - "com.amazonaws.quicksight#NestedFilter": { - "type": "structure", - "members": { - "FilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "IncludeInnerSet": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A boolean condition to include or exclude the subset that is defined by the values of the nested inner filter.

", - "smithy.api#required": {} - } - }, - "InnerFilter": { - "target": "com.amazonaws.quicksight#InnerFilter", - "traits": { - "smithy.api#documentation": "

The InnerFilter defines the subset of data to be used with the NestedFilter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A NestedFilter filters data with a subset of data that is defined by the nested inner filter.

" - } - }, - "com.amazonaws.quicksight#NetworkInterface": { - "type": "structure", - "members": { - "SubnetId": { - "target": "com.amazonaws.quicksight#SubnetId", - "traits": { - "smithy.api#documentation": "

The subnet ID associated with the network interface.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The availability zone that the network interface resides in.

" - } - }, - "ErrorMessage": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

An error message.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#NetworkInterfaceStatus", - "traits": { - "smithy.api#documentation": "

The status of the network interface.

" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.quicksight#NetworkInterfaceId", - "traits": { - "smithy.api#documentation": "

The network interface ID.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The structure that contains information about a network interface.

" - } - }, - "com.amazonaws.quicksight#NetworkInterfaceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": "^eni-[0-9a-z]*$" - } - }, - "com.amazonaws.quicksight#NetworkInterfaceList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#NetworkInterface" - } - }, - "com.amazonaws.quicksight#NetworkInterfaceStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVAILABLE" - } - }, - "CREATION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_FAILED" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "UPDATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_FAILED" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - }, - "DELETION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETION_FAILED" - } - }, - "DELETION_SCHEDULED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETION_SCHEDULED" - } - }, - "ATTACHMENT_FAILED_ROLLBACK_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ATTACHMENT_FAILED_ROLLBACK_FAILED" - } - } - } - }, - "com.amazonaws.quicksight#NewDefaultValues": { - "type": "structure", - "members": { - "StringStaticValues": { - "target": "com.amazonaws.quicksight#StringDatasetParameterValueList", - "traits": { - "smithy.api#documentation": "

A list of static default values for a given string parameter.

" - } - }, - "DecimalStaticValues": { - "target": "com.amazonaws.quicksight#DecimalDatasetParameterValueList", - "traits": { - "smithy.api#documentation": "

A list of static default values for a given decimal parameter.

" - } - }, - "DateTimeStaticValues": { - "target": "com.amazonaws.quicksight#DateTimeDatasetParameterValueList", - "traits": { - "smithy.api#documentation": "

A list of static default values for a given date time parameter.

" - } - }, - "IntegerStaticValues": { - "target": "com.amazonaws.quicksight#IntegerDatasetParameterValueList", - "traits": { - "smithy.api#documentation": "

A list of static default values for a given integer parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.

" - } - }, - "com.amazonaws.quicksight#NonEmptyString": { - "type": "string", - "traits": { - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.quicksight#NonRepeatingVisualsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#NullFilterOption": { - "type": "enum", - "members": { - "ALL_VALUES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL_VALUES" - } - }, - "NON_NULLS_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NON_NULLS_ONLY" - } - }, - "NULLS_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NULLS_ONLY" - } - } - } - }, - "com.amazonaws.quicksight#NullString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#NullValueFormatConfiguration": { - "type": "structure", - "members": { - "NullString": { - "target": "com.amazonaws.quicksight#NullString", - "traits": { - "smithy.api#documentation": "

Determines the null string of null values.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the null value format configuration.

" - } - }, - "com.amazonaws.quicksight#NullableBoolean": { - "type": "boolean" - }, - "com.amazonaws.quicksight#NumberDisplayFormatConfiguration": { - "type": "structure", - "members": { - "Prefix": { - "target": "com.amazonaws.quicksight#Prefix", - "traits": { - "smithy.api#documentation": "

Determines the prefix value of the number format.

" - } - }, - "Suffix": { - "target": "com.amazonaws.quicksight#Suffix", - "traits": { - "smithy.api#documentation": "

Determines the suffix value of the number format.

" - } - }, - "SeparatorConfiguration": { - "target": "com.amazonaws.quicksight#NumericSeparatorConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the numeric separator configuration.

" - } - }, - "DecimalPlacesConfiguration": { - "target": "com.amazonaws.quicksight#DecimalPlacesConfiguration", - "traits": { - "smithy.api#documentation": "

The option that determines the decimal places configuration.

" - } - }, - "NumberScale": { - "target": "com.amazonaws.quicksight#NumberScale", - "traits": { - "smithy.api#documentation": "

Determines the number scale value of the number format.

" - } - }, - "NegativeValueConfiguration": { - "target": "com.amazonaws.quicksight#NegativeValueConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the negative value configuration.

" - } - }, - "NullValueFormatConfiguration": { - "target": "com.amazonaws.quicksight#NullValueFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the null value format configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the number display format configuration.

" - } - }, - "com.amazonaws.quicksight#NumberFormatConfiguration": { - "type": "structure", - "members": { - "FormatConfiguration": { - "target": "com.amazonaws.quicksight#NumericFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the numeric format configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Formatting configuration for number fields.

" - } - }, - "com.amazonaws.quicksight#NumberScale": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - }, - "THOUSANDS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THOUSANDS" - } - }, - "MILLIONS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MILLIONS" - } - }, - "BILLIONS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BILLIONS" - } - }, - "TRILLIONS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRILLIONS" - } - } - } - }, - "com.amazonaws.quicksight#NumericAxisOptions": { - "type": "structure", - "members": { - "Scale": { - "target": "com.amazonaws.quicksight#AxisScale", - "traits": { - "smithy.api#documentation": "

The scale setup of a numeric axis.

" - } - }, - "Range": { - "target": "com.amazonaws.quicksight#AxisDisplayRange", - "traits": { - "smithy.api#documentation": "

The range setup of a numeric axis.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options for an axis with a numeric field.

" - } - }, - "com.amazonaws.quicksight#NumericEqualityDrillDownFilter": { - "type": "structure", - "members": { - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The value of the double input numeric drill down filter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The numeric equality type drill down filter.

" - } - }, - "com.amazonaws.quicksight#NumericEqualityFilter": { - "type": "structure", - "members": { - "FilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The input value.

" - } - }, - "SelectAllOptions": { - "target": "com.amazonaws.quicksight#NumericFilterSelectAllOptions", - "traits": { - "smithy.api#documentation": "

Select all of the values. Null is not the assigned value of select all.

\n " - } - }, - "MatchOperator": { - "target": "com.amazonaws.quicksight#NumericEqualityMatchOperator", - "traits": { - "smithy.api#documentation": "

The match operator that is used to determine if a filter should be applied.

", - "smithy.api#required": {} - } - }, - "AggregationFunction": { - "target": "com.amazonaws.quicksight#AggregationFunction", - "traits": { - "smithy.api#documentation": "

The aggregation function of the filter.

" - } - }, - "ParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The parameter whose value should be used for the filter value.

" - } - }, - "NullOption": { - "target": "com.amazonaws.quicksight#FilterNullOption", - "traits": { - "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", - "smithy.api#required": {} - } - }, - "DefaultFilterControlConfiguration": { - "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", - "traits": { - "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A NumericEqualityFilter filters values that are equal to the specified value.

" - } - }, - "com.amazonaws.quicksight#NumericEqualityMatchOperator": { - "type": "enum", - "members": { - "EQUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EQUALS" - } - }, - "DOES_NOT_EQUAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOES_NOT_EQUAL" - } - } - } - }, - "com.amazonaws.quicksight#NumericFilterSelectAllOptions": { - "type": "enum", - "members": { - "FILTER_ALL_VALUES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FILTER_ALL_VALUES" - } - } - } - }, - "com.amazonaws.quicksight#NumericFormatConfiguration": { - "type": "structure", - "members": { - "NumberDisplayFormatConfiguration": { - "target": "com.amazonaws.quicksight#NumberDisplayFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the number display format configuration.

" - } - }, - "CurrencyDisplayFormatConfiguration": { - "target": "com.amazonaws.quicksight#CurrencyDisplayFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the currency display format configuration.

" - } - }, - "PercentageDisplayFormatConfiguration": { - "target": "com.amazonaws.quicksight#PercentageDisplayFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the percentage display format configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the numeric format configuration.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#NumericRangeFilter": { - "type": "structure", - "members": { - "FilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "IncludeMinimum": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

Determines whether the minimum value in the filter value range should be included in the filtered results.

" - } - }, - "IncludeMaximum": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

Determines whether the maximum value in the filter value range should be included in the filtered results.

" - } - }, - "RangeMinimum": { - "target": "com.amazonaws.quicksight#NumericRangeFilterValue", - "traits": { - "smithy.api#documentation": "

The minimum value for the filter value range.

" - } - }, - "RangeMaximum": { - "target": "com.amazonaws.quicksight#NumericRangeFilterValue", - "traits": { - "smithy.api#documentation": "

The maximum value for the filter value range.

" - } - }, - "SelectAllOptions": { - "target": "com.amazonaws.quicksight#NumericFilterSelectAllOptions", - "traits": { - "smithy.api#documentation": "

Select all of the values. Null is not the assigned value of select all.

\n " - } - }, - "AggregationFunction": { - "target": "com.amazonaws.quicksight#AggregationFunction", - "traits": { - "smithy.api#documentation": "

The aggregation function of the filter.

" - } - }, - "NullOption": { - "target": "com.amazonaws.quicksight#FilterNullOption", - "traits": { - "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", - "smithy.api#required": {} - } - }, - "DefaultFilterControlConfiguration": { - "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", - "traits": { - "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A NumericRangeFilter filters values that are within the value range.

" - } - }, - "com.amazonaws.quicksight#NumericRangeFilterValue": { - "type": "structure", - "members": { - "StaticValue": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The static value of the numeric range filter.

" - } - }, - "Parameter": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The parameter that is used in the numeric range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The value input pf the numeric range filter.

" - } - }, - "com.amazonaws.quicksight#NumericSeparatorConfiguration": { - "type": "structure", - "members": { - "DecimalSeparator": { - "target": "com.amazonaws.quicksight#NumericSeparatorSymbol", - "traits": { - "smithy.api#documentation": "

Determines the decimal separator.

" - } - }, - "ThousandsSeparator": { - "target": "com.amazonaws.quicksight#ThousandSeparatorOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the thousands separator configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the numeric separator configuration.

" - } - }, - "com.amazonaws.quicksight#NumericSeparatorSymbol": { - "type": "enum", - "members": { - "COMMA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMMA" - } - }, - "DOT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOT" - } - }, - "SPACE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SPACE" - } - } - } - }, - "com.amazonaws.quicksight#NumericalAggregationFunction": { - "type": "structure", - "members": { - "SimpleNumericalAggregation": { - "target": "com.amazonaws.quicksight#SimpleNumericalAggregationFunction", - "traits": { - "smithy.api#documentation": "

Built-in aggregation functions for numerical values.

\n " - } - }, - "PercentileAggregation": { - "target": "com.amazonaws.quicksight#PercentileAggregation", - "traits": { - "smithy.api#documentation": "

An aggregation based on the percentile of values in a dimension or measure.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Aggregation for numerical values.

" - } - }, - "com.amazonaws.quicksight#NumericalDimensionField": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The custom field ID.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that is used in the NumericalDimensionField.

", - "smithy.api#required": {} - } - }, - "HierarchyId": { - "target": "com.amazonaws.quicksight#HierarchyId", - "traits": { - "smithy.api#documentation": "

The custom hierarchy ID.

" - } - }, - "FormatConfiguration": { - "target": "com.amazonaws.quicksight#NumberFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The format configuration of the field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The dimension type field with numerical type columns.

" - } - }, - "com.amazonaws.quicksight#NumericalMeasureField": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The custom field ID.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that is used in the NumericalMeasureField.

", - "smithy.api#required": {} - } - }, - "AggregationFunction": { - "target": "com.amazonaws.quicksight#NumericalAggregationFunction", - "traits": { - "smithy.api#documentation": "

The aggregation function of the measure field.

" - } - }, - "FormatConfiguration": { - "target": "com.amazonaws.quicksight#NumberFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The format configuration of the field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The measure type field with numerical type columns.

" - } - }, - "com.amazonaws.quicksight#OnClause": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.quicksight#OperandList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Identifier" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 25 - } - } - }, - "com.amazonaws.quicksight#OptionalPort": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 65535 - } - } - }, - "com.amazonaws.quicksight#OracleParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

An Oracle host.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

The port.

", - "smithy.api#required": {} - } - }, - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

The database.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for Oracle.

" - } - }, - "com.amazonaws.quicksight#OtherCategories": { - "type": "enum", - "members": { - "INCLUDE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INCLUDE" - } - }, - "EXCLUDE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXCLUDE" - } - } - } - }, - "com.amazonaws.quicksight#OutputColumn": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#ColumnName", - "traits": { - "smithy.api#documentation": "

The display name of the column..

" - } - }, - "Description": { - "target": "com.amazonaws.quicksight#ColumnDescriptiveText", - "traits": { - "smithy.api#documentation": "

A description for a column.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#ColumnDataType", - "traits": { - "smithy.api#documentation": "

The data type of the column.

" - } - }, - "SubType": { - "target": "com.amazonaws.quicksight#ColumnDataSubType", - "traits": { - "smithy.api#documentation": "

The sub data type of the column.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Output column.

" - } - }, - "com.amazonaws.quicksight#OutputColumnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#OutputColumn" - } - }, - "com.amazonaws.quicksight#OverrideDatasetParameterOperation": { - "type": "structure", - "members": { - "ParameterName": { - "target": "com.amazonaws.quicksight#DatasetParameterName", - "traits": { - "smithy.api#documentation": "

The name of the parameter to be overridden with different values.

", - "smithy.api#required": {} - } - }, - "NewParameterName": { - "target": "com.amazonaws.quicksight#DatasetParameterName", - "traits": { - "smithy.api#documentation": "

The new name for the parameter.

" - } - }, - "NewDefaultValues": { - "target": "com.amazonaws.quicksight#NewDefaultValues", - "traits": { - "smithy.api#documentation": "

The new default values for the parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A transform operation that overrides the dataset parameter values that are defined in another dataset.

" - } - }, - "com.amazonaws.quicksight#PageNumber": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.quicksight#PaginationConfiguration": { - "type": "structure", - "members": { - "PageSize": { - "target": "com.amazonaws.quicksight#Long", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

Indicates how many items render in one page.

", - "smithy.api#required": {} - } - }, - "PageNumber": { - "target": "com.amazonaws.quicksight#PageNumber", - "traits": { - "smithy.api#documentation": "

Indicates the page number.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The pagination configuration for a table visual or boxplot.

" - } - }, - "com.amazonaws.quicksight#PanelBorderStyle": { - "type": "enum", - "members": { - "SOLID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOLID" - } - }, - "DASHED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DASHED" - } - }, - "DOTTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOTTED" - } - } - } - }, - "com.amazonaws.quicksight#PanelConfiguration": { - "type": "structure", - "members": { - "Title": { - "target": "com.amazonaws.quicksight#PanelTitleOptions", - "traits": { - "smithy.api#documentation": "

Configures the title display within each small multiples panel.

" - } - }, - "BorderVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines whether or not each panel displays a border.

" - } - }, - "BorderThickness": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

Sets the line thickness of panel borders.

" - } - }, - "BorderStyle": { - "target": "com.amazonaws.quicksight#PanelBorderStyle", - "traits": { - "smithy.api#documentation": "

Sets the line style of panel borders.

" - } - }, - "BorderColor": { - "target": "com.amazonaws.quicksight#HexColorWithTransparency", - "traits": { - "smithy.api#documentation": "

Sets the line color of panel borders.

" - } - }, - "GutterVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines whether or not negative space between sibling panels is rendered.

" - } - }, - "GutterSpacing": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

Sets the total amount of negative space to display between sibling panels.

" - } - }, - "BackgroundVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines whether or not a background for each small multiples panel is rendered.

" - } - }, - "BackgroundColor": { - "target": "com.amazonaws.quicksight#HexColorWithTransparency", - "traits": { - "smithy.api#documentation": "

Sets the background color for each panel.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A collection of options that configure how each panel displays in a small multiples chart.

" - } - }, - "com.amazonaws.quicksight#PanelTitleOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines whether or not panel titles are displayed.

" - } - }, - "FontConfiguration": { - "target": "com.amazonaws.quicksight#FontConfiguration" - }, - "HorizontalTextAlignment": { - "target": "com.amazonaws.quicksight#HorizontalTextAlignment", - "traits": { - "smithy.api#documentation": "

Sets the horizontal text alignment of the title within each panel.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the title styles for each small multiples\n panel.

" - } - }, - "com.amazonaws.quicksight#PaperOrientation": { - "type": "enum", - "members": { - "PORTRAIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PORTRAIT" - } - }, - "LANDSCAPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LANDSCAPE" - } - } - } - }, - "com.amazonaws.quicksight#PaperSize": { - "type": "enum", - "members": { - "US_LETTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "US_LETTER" - } - }, - "US_LEGAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "US_LEGAL" - } - }, - "US_TABLOID_LEDGER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "US_TABLOID_LEDGER" - } - }, - "A0": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "A0" - } - }, - "A1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "A1" - } - }, - "A2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "A2" - } - }, - "A3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "A3" - } - }, - "A4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "A4" - } - }, - "A5": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "A5" - } - }, - "JIS_B4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JIS_B4" - } - }, - "JIS_B5": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JIS_B5" - } - } - } - }, - "com.amazonaws.quicksight#ParameterControl": { - "type": "structure", - "members": { - "DateTimePicker": { - "target": "com.amazonaws.quicksight#ParameterDateTimePickerControl", - "traits": { - "smithy.api#documentation": "

A control from a date parameter that specifies date and time.

" - } - }, - "List": { - "target": "com.amazonaws.quicksight#ParameterListControl", - "traits": { - "smithy.api#documentation": "

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

" - } - }, - "Dropdown": { - "target": "com.amazonaws.quicksight#ParameterDropDownControl", - "traits": { - "smithy.api#documentation": "

A control to display a dropdown list with buttons that are used to select a single value.

" - } - }, - "TextField": { - "target": "com.amazonaws.quicksight#ParameterTextFieldControl", - "traits": { - "smithy.api#documentation": "

A control to display a text box that is used to enter a single entry.

" - } - }, - "TextArea": { - "target": "com.amazonaws.quicksight#ParameterTextAreaControl", - "traits": { - "smithy.api#documentation": "

A control to display a text box that is used to enter multiple entries.

" - } - }, - "Slider": { - "target": "com.amazonaws.quicksight#ParameterSliderControl", - "traits": { - "smithy.api#documentation": "

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The control of a parameter that users can interact with in a dashboard or an analysis.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#ParameterControlList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ParameterControl" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#ParameterDateTimePickerControl": { - "type": "structure", - "members": { - "ParameterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the ParameterDateTimePickerControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the ParameterDateTimePickerControl.

", - "smithy.api#required": {} - } - }, - "SourceParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The name of the ParameterDateTimePickerControl.

", - "smithy.api#required": {} - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#DateTimePickerControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control from a date parameter that specifies date and time.

" - } - }, - "com.amazonaws.quicksight#ParameterDeclaration": { - "type": "structure", - "members": { - "StringParameterDeclaration": { - "target": "com.amazonaws.quicksight#StringParameterDeclaration", - "traits": { - "smithy.api#documentation": "

A parameter declaration for the String data type.

" - } - }, - "DecimalParameterDeclaration": { - "target": "com.amazonaws.quicksight#DecimalParameterDeclaration", - "traits": { - "smithy.api#documentation": "

A parameter declaration for the Decimal data type.

" - } - }, - "IntegerParameterDeclaration": { - "target": "com.amazonaws.quicksight#IntegerParameterDeclaration", - "traits": { - "smithy.api#documentation": "

A parameter declaration for the Integer data type.

" - } - }, - "DateTimeParameterDeclaration": { - "target": "com.amazonaws.quicksight#DateTimeParameterDeclaration", - "traits": { - "smithy.api#documentation": "

A parameter declaration for the DateTime data type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The declaration definition of a parameter.

\n

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#ParameterDeclarationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ParameterDeclaration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#ParameterDropDownControl": { - "type": "structure", - "members": { - "ParameterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the ParameterDropDownControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the ParameterDropDownControl.

", - "smithy.api#required": {} - } - }, - "SourceParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The source parameter name of the ParameterDropDownControl.

", - "smithy.api#required": {} - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#DropDownControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#SheetControlListType", - "traits": { - "smithy.api#documentation": "

The type parameter name of the ParameterDropDownControl.

" - } - }, - "SelectableValues": { - "target": "com.amazonaws.quicksight#ParameterSelectableValues", - "traits": { - "smithy.api#documentation": "

A list of selectable values that are used in a control.

" - } - }, - "CascadingControlConfiguration": { - "target": "com.amazonaws.quicksight#CascadingControlConfiguration", - "traits": { - "smithy.api#documentation": "

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control to display a dropdown list with buttons that are used to select a single value.

" - } - }, - "com.amazonaws.quicksight#ParameterListControl": { - "type": "structure", - "members": { - "ParameterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the ParameterListControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the ParameterListControl.

", - "smithy.api#required": {} - } - }, - "SourceParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The source parameter name of the ParameterListControl.

", - "smithy.api#required": {} - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#ListControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#SheetControlListType", - "traits": { - "smithy.api#documentation": "

The type of ParameterListControl.

" - } - }, - "SelectableValues": { - "target": "com.amazonaws.quicksight#ParameterSelectableValues", - "traits": { - "smithy.api#documentation": "

A list of selectable values that are used in a control.

" - } - }, - "CascadingControlConfiguration": { - "target": "com.amazonaws.quicksight#CascadingControlConfiguration", - "traits": { - "smithy.api#documentation": "

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

" - } - }, - "com.amazonaws.quicksight#ParameterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]+$" - } - }, - "com.amazonaws.quicksight#ParameterSelectableValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#String" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50000 - } - } - }, - "com.amazonaws.quicksight#ParameterSelectableValues": { - "type": "structure", - "members": { - "Values": { - "target": "com.amazonaws.quicksight#ParameterSelectableValueList", - "traits": { - "smithy.api#documentation": "

The values that are used in ParameterSelectableValues.

" - } - }, - "LinkToDataSetColumn": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column identifier that fetches values from the data set.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A list of selectable values that are used in a control.

" - } - }, - "com.amazonaws.quicksight#ParameterSliderControl": { - "type": "structure", - "members": { - "ParameterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the ParameterSliderControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the ParameterSliderControl.

", - "smithy.api#required": {} - } - }, - "SourceParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The source parameter name of the ParameterSliderControl.

", - "smithy.api#required": {} - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#SliderControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "MaximumValue": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The larger value that is displayed at the right of the slider.

", - "smithy.api#required": {} - } - }, - "MinimumValue": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The smaller value that is displayed at the left of the slider.

", - "smithy.api#required": {} - } - }, - "StepSize": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of increments that the slider bar is divided into.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

" - } - }, - "com.amazonaws.quicksight#ParameterTextAreaControl": { - "type": "structure", - "members": { - "ParameterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the ParameterTextAreaControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the ParameterTextAreaControl.

", - "smithy.api#required": {} - } - }, - "SourceParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The source parameter name of the ParameterTextAreaControl.

", - "smithy.api#required": {} - } - }, - "Delimiter": { - "target": "com.amazonaws.quicksight#TextAreaControlDelimiter", - "traits": { - "smithy.api#documentation": "

The delimiter that is used to separate the lines in text.

" - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#TextAreaControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control to display a text box that is used to enter multiple entries.

" - } - }, - "com.amazonaws.quicksight#ParameterTextFieldControl": { - "type": "structure", - "members": { - "ParameterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the ParameterTextFieldControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the ParameterTextFieldControl.

", - "smithy.api#required": {} - } - }, - "SourceParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The source parameter name of the ParameterTextFieldControl.

", - "smithy.api#required": {} - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#TextFieldControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control to display a text box that is used to enter a single entry.

" - } - }, - "com.amazonaws.quicksight#ParameterValueType": { - "type": "enum", - "members": { - "MULTI_VALUED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MULTI_VALUED" - } - }, - "SINGLE_VALUED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SINGLE_VALUED" - } - } - } - }, - "com.amazonaws.quicksight#Parameters": { - "type": "structure", - "members": { - "StringParameters": { - "target": "com.amazonaws.quicksight#StringParameterList", - "traits": { - "smithy.api#documentation": "

The parameters that have a data type of string.

" - } - }, - "IntegerParameters": { - "target": "com.amazonaws.quicksight#IntegerParameterList", - "traits": { - "smithy.api#documentation": "

The parameters that have a data type of integer.

" - } - }, - "DecimalParameters": { - "target": "com.amazonaws.quicksight#DecimalParameterList", - "traits": { - "smithy.api#documentation": "

The parameters that have a data type of decimal.

" - } - }, - "DateTimeParameters": { - "target": "com.amazonaws.quicksight#DateTimeParameterList", - "traits": { - "smithy.api#documentation": "

The parameters that have a data type of date-time.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A list of Amazon QuickSight parameters and the list's override values.

" - } - }, - "com.amazonaws.quicksight#Password": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.quicksight#Path": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Arn" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#PercentNumber": { - "type": "double", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#PercentVisibleRange": { - "type": "structure", - "members": { - "From": { - "target": "com.amazonaws.quicksight#PercentNumber", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The lower bound of the range.

" - } - }, - "To": { - "target": "com.amazonaws.quicksight#PercentNumber", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The top bound of the range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The percent range in the visible range.

" - } - }, - "com.amazonaws.quicksight#PercentageDisplayFormatConfiguration": { - "type": "structure", - "members": { - "Prefix": { - "target": "com.amazonaws.quicksight#Prefix", - "traits": { - "smithy.api#documentation": "

Determines the prefix value of the percentage format.

" - } - }, - "Suffix": { - "target": "com.amazonaws.quicksight#Suffix", - "traits": { - "smithy.api#documentation": "

Determines the suffix value of the percentage format.

" - } - }, - "SeparatorConfiguration": { - "target": "com.amazonaws.quicksight#NumericSeparatorConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the numeric separator configuration.

" - } - }, - "DecimalPlacesConfiguration": { - "target": "com.amazonaws.quicksight#DecimalPlacesConfiguration", - "traits": { - "smithy.api#documentation": "

The option that determines the decimal places configuration.

" - } - }, - "NegativeValueConfiguration": { - "target": "com.amazonaws.quicksight#NegativeValueConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the negative value configuration.

" - } - }, - "NullValueFormatConfiguration": { - "target": "com.amazonaws.quicksight#NullValueFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the null value format configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the percentage display format configuration.

" - } - }, - "com.amazonaws.quicksight#PercentileAggregation": { - "type": "structure", - "members": { - "PercentileValue": { - "target": "com.amazonaws.quicksight#PercentileValue", - "traits": { - "smithy.api#documentation": "

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An aggregation based on the percentile of values in a dimension or measure.

" - } - }, - "com.amazonaws.quicksight#PercentileValue": { - "type": "double", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#PeriodOverPeriodComputation": { - "type": "structure", - "members": { - "ComputationId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for a computation.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of a computation.

" - } - }, - "Time": { - "target": "com.amazonaws.quicksight#DimensionField", - "traits": { - "smithy.api#documentation": "

The time field that is used in a computation.

" - } - }, - "Value": { - "target": "com.amazonaws.quicksight#MeasureField", - "traits": { - "smithy.api#documentation": "

The value field that is used in a computation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The period over period computation configuration.

" - } - }, - "com.amazonaws.quicksight#PeriodToDateComputation": { - "type": "structure", - "members": { - "ComputationId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for a computation.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of a computation.

" - } - }, - "Time": { - "target": "com.amazonaws.quicksight#DimensionField", - "traits": { - "smithy.api#documentation": "

The time field that is used in a computation.

" - } - }, - "Value": { - "target": "com.amazonaws.quicksight#MeasureField", - "traits": { - "smithy.api#documentation": "

The value field that is used in a computation.

" - } - }, - "PeriodTimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The time granularity setup of period to date computation. Choose from the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The period to date computation configuration.

" - } - }, - "com.amazonaws.quicksight#PeriodsBackward": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 1000 - } - } - }, - "com.amazonaws.quicksight#PeriodsForward": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.quicksight#PhysicalTable": { - "type": "union", - "members": { - "RelationalTable": { - "target": "com.amazonaws.quicksight#RelationalTable", - "traits": { - "smithy.api#documentation": "

A physical table type for relational data sources.

" - } - }, - "CustomSql": { - "target": "com.amazonaws.quicksight#CustomSql", - "traits": { - "smithy.api#documentation": "

A physical table type built from the results of the custom SQL query.

" - } - }, - "S3Source": { - "target": "com.amazonaws.quicksight#S3Source", - "traits": { - "smithy.api#documentation": "

A physical table type for as S3 data source.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A view of a data source that contains information about the shape of the data in the\n underlying source. This is a variant type structure. For this structure to be valid,\n only one of the attributes can be non-null.

" - } - }, - "com.amazonaws.quicksight#PhysicalTableId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[0-9a-zA-Z-]*$" - } - }, - "com.amazonaws.quicksight#PhysicalTableMap": { - "type": "map", - "key": { - "target": "com.amazonaws.quicksight#PhysicalTableId" - }, - "value": { - "target": "com.amazonaws.quicksight#PhysicalTable" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 32 - } - } - }, - "com.amazonaws.quicksight#PieChartAggregatedFieldWells": { - "type": "structure", - "members": { - "Category": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The category (group/color) field wells of a pie chart.

" - } - }, - "Values": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The value field wells of a pie chart. Values are aggregated based on categories.

" - } - }, - "SmallMultiples": { - "target": "com.amazonaws.quicksight#SmallMultiplesDimensionFieldList", - "traits": { - "smithy.api#documentation": "

The small multiples field well of a pie chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a pie chart.

" - } - }, - "com.amazonaws.quicksight#PieChartConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#PieChartFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#PieChartSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a pie chart.

" - } - }, - "DonutOptions": { - "target": "com.amazonaws.quicksight#DonutOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart.

" - } - }, - "SmallMultiplesOptions": { - "target": "com.amazonaws.quicksight#SmallMultiplesOptions", - "traits": { - "smithy.api#documentation": "

The small multiples setup for the visual.

" - } - }, - "CategoryLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options of the group/color that is displayed in a pie chart.

" - } - }, - "ValueLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options for the value that is displayed in a pie chart.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "

The legend display setup of the visual.

" - } - }, - "DataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The tooltip display setup of the visual.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" - } - }, - "ContributionAnalysisDefaults": { - "target": "com.amazonaws.quicksight#ContributionAnalysisDefaultList", - "traits": { - "smithy.api#documentation": "

The contribution analysis (anomaly configuration) setup of the visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a pie chart.

" - } - }, - "com.amazonaws.quicksight#PieChartFieldWells": { - "type": "structure", - "members": { - "PieChartAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#PieChartAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a pie chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a pie chart.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#PieChartSortConfiguration": { - "type": "structure", - "members": { - "CategorySort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the category fields.

" - } - }, - "CategoryItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of categories that are displayed in a pie chart.

" - } - }, - "SmallMultiplesSort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the small multiples field.

" - } - }, - "SmallMultiplesLimitConfiguration": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of small multiples panels that are displayed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a pie chart.

" - } - }, - "com.amazonaws.quicksight#PieChartVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#PieChartConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of a pie chart.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A pie or donut chart.

\n

The PieChartVisual structure describes a visual that is a member of the pie chart family.

\n

The following charts can be described by using this structure:

\n \n

For more information, see Using pie charts in the Amazon QuickSight User Guide.

\n

For more information, see Using donut charts in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#PivotFieldSortOptions": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID for the field sort options.

", - "smithy.api#required": {} - } - }, - "SortBy": { - "target": "com.amazonaws.quicksight#PivotTableSortBy", - "traits": { - "smithy.api#documentation": "

The sort by field for the field sort options.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The field sort options for a pivot table sort configuration.

" - } - }, - "com.amazonaws.quicksight#PivotFieldSortOptionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#PivotFieldSortOptions" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#PivotMeasureFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MeasureField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 40 - } - } - }, - "com.amazonaws.quicksight#PivotTableAggregatedFieldWells": { - "type": "structure", - "members": { - "Rows": { - "target": "com.amazonaws.quicksight#PivotTableDimensionList", - "traits": { - "smithy.api#documentation": "

The rows field well for a pivot table. Values are grouped by rows fields.

" - } - }, - "Columns": { - "target": "com.amazonaws.quicksight#PivotTableDimensionList", - "traits": { - "smithy.api#documentation": "

The columns field well for a pivot table. Values are grouped by columns fields.

" - } - }, - "Values": { - "target": "com.amazonaws.quicksight#PivotMeasureFieldList", - "traits": { - "smithy.api#documentation": "

The values field well for a pivot table. Values are aggregated based on rows and columns fields.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The aggregated field well for the pivot table.

" - } - }, - "com.amazonaws.quicksight#PivotTableCellConditionalFormatting": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID of the cell for conditional formatting.

", - "smithy.api#required": {} - } - }, - "TextFormat": { - "target": "com.amazonaws.quicksight#TextConditionalFormat", - "traits": { - "smithy.api#documentation": "

The text format of the cell for conditional formatting.

" - } - }, - "Scope": { - "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingScope", - "traits": { - "smithy.api#documentation": "

The scope of the cell for conditional formatting.

" - } - }, - "Scopes": { - "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingScopeList", - "traits": { - "smithy.api#documentation": "

A list of cell scopes for conditional formatting.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The cell conditional formatting option for a pivot table.

" - } - }, - "com.amazonaws.quicksight#PivotTableConditionalFormatting": { - "type": "structure", - "members": { - "ConditionalFormattingOptions": { - "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingOptionList", - "traits": { - "smithy.api#documentation": "

Conditional formatting options for a PivotTableVisual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting for a PivotTableVisual.

" - } - }, - "com.amazonaws.quicksight#PivotTableConditionalFormattingOption": { - "type": "structure", - "members": { - "Cell": { - "target": "com.amazonaws.quicksight#PivotTableCellConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The cell conditional formatting option for a pivot table.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Conditional formatting options for a PivotTableVisual.

" - } - }, - "com.amazonaws.quicksight#PivotTableConditionalFormattingOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingOption" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.quicksight#PivotTableConditionalFormattingScope": { - "type": "structure", - "members": { - "Role": { - "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingScopeRole", - "traits": { - "smithy.api#documentation": "

The role (field, field total, grand total) of the cell for conditional formatting.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The scope of the cell for conditional formatting.

" - } - }, - "com.amazonaws.quicksight#PivotTableConditionalFormattingScopeList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingScope" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 3 - } - } - }, - "com.amazonaws.quicksight#PivotTableConditionalFormattingScopeRole": { - "type": "enum", - "members": { - "FIELD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIELD" - } - }, - "FIELD_TOTAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIELD_TOTAL" - } - }, - "GRAND_TOTAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GRAND_TOTAL" - } - } - } - }, - "com.amazonaws.quicksight#PivotTableConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#PivotTableFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#PivotTableSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration for a PivotTableVisual.

" - } - }, - "TableOptions": { - "target": "com.amazonaws.quicksight#PivotTableOptions", - "traits": { - "smithy.api#documentation": "

The table options for a pivot table visual.

" - } - }, - "TotalOptions": { - "target": "com.amazonaws.quicksight#PivotTableTotalOptions", - "traits": { - "smithy.api#documentation": "

The total options for a pivot table visual.

" - } - }, - "FieldOptions": { - "target": "com.amazonaws.quicksight#PivotTableFieldOptions", - "traits": { - "smithy.api#documentation": "

The field options for a pivot table visual.

" - } - }, - "PaginatedReportOptions": { - "target": "com.amazonaws.quicksight#PivotTablePaginatedReportOptions", - "traits": { - "smithy.api#documentation": "

The paginated report options for a pivot table visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for a PivotTableVisual.

" - } - }, - "com.amazonaws.quicksight#PivotTableDataPathOption": { - "type": "structure", - "members": { - "DataPathList": { - "target": "com.amazonaws.quicksight#DataPathValueList", - "traits": { - "smithy.api#documentation": "

The list of data path values for the data path options.

", - "smithy.api#required": {} - } - }, - "Width": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The width of the data path option.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The data path options for the pivot table field options.

" - } - }, - "com.amazonaws.quicksight#PivotTableDataPathOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#PivotTableDataPathOption" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#PivotTableDataPathType": { - "type": "enum", - "members": { - "HIERARCHY_ROWS_LAYOUT_COLUMN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HIERARCHY_ROWS_LAYOUT_COLUMN" - } - }, - "MULTIPLE_ROW_METRICS_COLUMN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MULTIPLE_ROW_METRICS_COLUMN" - } - }, - "EMPTY_COLUMN_HEADER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EMPTY_COLUMN_HEADER" - } - }, - "COUNT_METRIC_COLUMN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNT_METRIC_COLUMN" - } - } - } - }, - "com.amazonaws.quicksight#PivotTableDimensionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DimensionField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 40 - } - } - }, - "com.amazonaws.quicksight#PivotTableFieldCollapseState": { - "type": "enum", - "members": { - "COLLAPSED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLLAPSED" - } - }, - "EXPANDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXPANDED" - } - } - } - }, - "com.amazonaws.quicksight#PivotTableFieldCollapseStateOption": { - "type": "structure", - "members": { - "Target": { - "target": "com.amazonaws.quicksight#PivotTableFieldCollapseStateTarget", - "traits": { - "smithy.api#documentation": "

A tagged-union object that sets the collapse state.

", - "smithy.api#required": {} - } - }, - "State": { - "target": "com.amazonaws.quicksight#PivotTableFieldCollapseState", - "traits": { - "smithy.api#documentation": "

The state of the field target of a pivot table. Choose one of the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The collapse state options for the pivot table field options.

" - } - }, - "com.amazonaws.quicksight#PivotTableFieldCollapseStateOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#PivotTableFieldCollapseStateOption" - } - }, - "com.amazonaws.quicksight#PivotTableFieldCollapseStateTarget": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The field ID of the pivot table that the collapse state needs to be set to.

" - } - }, - "FieldDataPathValues": { - "target": "com.amazonaws.quicksight#DataPathValueList", - "traits": { - "smithy.api#documentation": "

The data path of the pivot table's header. Used to set the collapse state.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The target of a pivot table field collapse state.

" - } - }, - "com.amazonaws.quicksight#PivotTableFieldOption": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID of the pivot table field.

", - "smithy.api#required": {} - } - }, - "CustomLabel": { - "target": "com.amazonaws.quicksight#CustomLabel", - "traits": { - "smithy.api#documentation": "

The custom label of the pivot table field.

" - } - }, - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the pivot table field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The selected field options for the pivot table field options.

" - } - }, - "com.amazonaws.quicksight#PivotTableFieldOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#PivotTableFieldOption" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#PivotTableFieldOptions": { - "type": "structure", - "members": { - "SelectedFieldOptions": { - "target": "com.amazonaws.quicksight#PivotTableFieldOptionList", - "traits": { - "smithy.api#documentation": "

The selected field options for the pivot table field options.

" - } - }, - "DataPathOptions": { - "target": "com.amazonaws.quicksight#PivotTableDataPathOptionList", - "traits": { - "smithy.api#documentation": "

The data path options for the pivot table field options.

" - } - }, - "CollapseStateOptions": { - "target": "com.amazonaws.quicksight#PivotTableFieldCollapseStateOptionList", - "traits": { - "smithy.api#documentation": "

The collapse state options for the pivot table field options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field options for a pivot table visual.

" - } - }, - "com.amazonaws.quicksight#PivotTableFieldSubtotalOptions": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID of the subtotal options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The optional configuration of subtotals cells.

" - } - }, - "com.amazonaws.quicksight#PivotTableFieldSubtotalOptionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#PivotTableFieldSubtotalOptions" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#PivotTableFieldWells": { - "type": "structure", - "members": { - "PivotTableAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#PivotTableAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field well for the pivot table.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field wells for a pivot table visual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#PivotTableMetricPlacement": { - "type": "enum", - "members": { - "ROW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROW" - } - }, - "COLUMN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLUMN" - } - } - } - }, - "com.amazonaws.quicksight#PivotTableOptions": { - "type": "structure", - "members": { - "MetricPlacement": { - "target": "com.amazonaws.quicksight#PivotTableMetricPlacement", - "traits": { - "smithy.api#documentation": "

The metric placement (row, column) options.

" - } - }, - "SingleMetricVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the single metric options.

" - } - }, - "ColumnNamesVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the column names.

" - } - }, - "ToggleButtonsVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines the visibility of the pivot table.

" - } - }, - "ColumnHeaderStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The table cell style of the column header.

" - } - }, - "RowHeaderStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The table cell style of the row headers.

" - } - }, - "CellStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The table cell style of cells.

" - } - }, - "RowFieldNamesStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The table cell style of row field names.

" - } - }, - "RowAlternateColorOptions": { - "target": "com.amazonaws.quicksight#RowAlternateColorOptions", - "traits": { - "smithy.api#documentation": "

The row alternate color options (widget status, row alternate colors).

" - } - }, - "CollapsedRowDimensionsVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is HIDDEN, all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE.

" - } - }, - "RowsLayout": { - "target": "com.amazonaws.quicksight#PivotTableRowsLayout", - "traits": { - "smithy.api#documentation": "

The layout for the row dimension headers of a pivot table. Choose one of the following options.

\n " - } - }, - "RowsLabelOptions": { - "target": "com.amazonaws.quicksight#PivotTableRowsLabelOptions", - "traits": { - "smithy.api#documentation": "

The options for the label that is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.

" - } - }, - "DefaultCellWidth": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The default cell width of the pivot table.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The table options for a pivot table visual.

" - } - }, - "com.amazonaws.quicksight#PivotTablePaginatedReportOptions": { - "type": "structure", - "members": { - "VerticalOverflowVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the printing table overflow across pages.

" - } - }, - "OverflowColumnHeaderVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the repeating header rows on each page.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The paginated report options for a pivot table visual.

" - } - }, - "com.amazonaws.quicksight#PivotTableRowsLabelOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the rows label.

" - } - }, - "CustomLabel": { - "target": "com.amazonaws.quicksight#PivotTableRowsLabelText", - "traits": { - "smithy.api#documentation": "

The custom label string for the rows label.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options for the label thta is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.

" - } - }, - "com.amazonaws.quicksight#PivotTableRowsLabelText": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.quicksight#PivotTableRowsLayout": { - "type": "enum", - "members": { - "TABULAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TABULAR" - } - }, - "HIERARCHY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HIERARCHY" - } - } - } - }, - "com.amazonaws.quicksight#PivotTableSortBy": { - "type": "structure", - "members": { - "Field": { - "target": "com.amazonaws.quicksight#FieldSort", - "traits": { - "smithy.api#documentation": "

The field sort (field id, direction) for the pivot table sort by options.

" - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnSort", - "traits": { - "smithy.api#documentation": "

The column sort (field id, direction) for the pivot table sort by options.

" - } - }, - "DataPath": { - "target": "com.amazonaws.quicksight#DataPathSort", - "traits": { - "smithy.api#documentation": "

The data path sort (data path value, direction) for the pivot table sort by options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort by field for the field sort options.

" - } - }, - "com.amazonaws.quicksight#PivotTableSortConfiguration": { - "type": "structure", - "members": { - "FieldSortOptions": { - "target": "com.amazonaws.quicksight#PivotFieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The field sort options for a pivot table sort configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration for a PivotTableVisual.

" - } - }, - "com.amazonaws.quicksight#PivotTableSubtotalLevel": { - "type": "enum", - "members": { - "ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL" - } - }, - "CUSTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM" - } - }, - "LAST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAST" - } - } - } - }, - "com.amazonaws.quicksight#PivotTableTotalOptions": { - "type": "structure", - "members": { - "RowSubtotalOptions": { - "target": "com.amazonaws.quicksight#SubtotalOptions", - "traits": { - "smithy.api#documentation": "

The row subtotal options.

" - } - }, - "ColumnSubtotalOptions": { - "target": "com.amazonaws.quicksight#SubtotalOptions", - "traits": { - "smithy.api#documentation": "

The column subtotal options.

" - } - }, - "RowTotalOptions": { - "target": "com.amazonaws.quicksight#PivotTotalOptions", - "traits": { - "smithy.api#documentation": "

The row total options.

" - } - }, - "ColumnTotalOptions": { - "target": "com.amazonaws.quicksight#PivotTotalOptions", - "traits": { - "smithy.api#documentation": "

The column total options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The total options for a pivot table visual.

" - } - }, - "com.amazonaws.quicksight#PivotTableVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#PivotTableConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the visual.

" - } - }, - "ConditionalFormatting": { - "target": "com.amazonaws.quicksight#PivotTableConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The conditional formatting for a PivotTableVisual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A pivot table.

\n

For more information, see Using pivot tables in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#PivotTotalOptions": { - "type": "structure", - "members": { - "TotalsVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility configuration for the total cells.

" - } - }, - "Placement": { - "target": "com.amazonaws.quicksight#TableTotalsPlacement", - "traits": { - "smithy.api#documentation": "

The placement (start, end) for the total cells.

" - } - }, - "ScrollStatus": { - "target": "com.amazonaws.quicksight#TableTotalsScrollStatus", - "traits": { - "smithy.api#documentation": "

The scroll status (pinned, scrolled) for the total cells.

" - } - }, - "CustomLabel": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The custom label string for the total cells.

" - } - }, - "TotalCellStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The cell styling options for the total cells.

" - } - }, - "ValueCellStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The cell styling options for the totals of value cells.

" - } - }, - "MetricHeaderCellStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The cell styling options for the total of header cells.

" - } - }, - "TotalAggregationOptions": { - "target": "com.amazonaws.quicksight#TotalAggregationOptionList", - "traits": { - "smithy.api#documentation": "

The total aggregation options for each value field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The optional configuration of totals cells in a PivotTableVisual.

" - } - }, - "com.amazonaws.quicksight#PixelLength": { - "type": "string", - "traits": { - "smithy.api#documentation": "String based length that is composed of value and unit in px" - } - }, - "com.amazonaws.quicksight#Port": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 65535 - } - } - }, - "com.amazonaws.quicksight#PositiveInteger": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.quicksight#PositiveLong": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.quicksight#PostgreSqlParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

Host.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

Port.

", - "smithy.api#required": {} - } - }, - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

Database.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for PostgreSQL.

" - } - }, - "com.amazonaws.quicksight#PreconditionNotMetException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

One or more preconditions aren't met.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.quicksight#PredefinedHierarchy": { - "type": "structure", - "members": { - "HierarchyId": { - "target": "com.amazonaws.quicksight#HierarchyId", - "traits": { - "smithy.api#documentation": "

The hierarchy ID of the predefined hierarchy.

", - "smithy.api#required": {} - } - }, - "Columns": { - "target": "com.amazonaws.quicksight#PredefinedHierarchyColumnList", - "traits": { - "smithy.api#documentation": "

The list of columns that define the predefined hierarchy.

", - "smithy.api#required": {} - } - }, - "DrillDownFilters": { - "target": "com.amazonaws.quicksight#DrillDownFilterList", - "traits": { - "smithy.api#documentation": "

The option that determines the drill down filters for the predefined hierarchy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

" - } - }, - "com.amazonaws.quicksight#PredefinedHierarchyColumnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnIdentifier" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#PredictionInterval": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 50, - "max": 95 - } - } - }, - "com.amazonaws.quicksight#Prefix": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#PrestoParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

Host.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

Port.

", - "smithy.api#required": {} - } - }, - "Catalog": { - "target": "com.amazonaws.quicksight#Catalog", - "traits": { - "smithy.api#documentation": "

Catalog.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for Presto.

" - } - }, - "com.amazonaws.quicksight#PrimaryValueDisplayType": { - "type": "enum", - "members": { - "HIDDEN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HIDDEN" - } - }, - "COMPARISON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPARISON" - } - }, - "ACTUAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTUAL" - } - } - } - }, - "com.amazonaws.quicksight#Principal": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.quicksight#PrincipalList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#String" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#ProgressBarOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the progress bar.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the progress bar of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#ProjectId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.quicksight#ProjectOperation": { - "type": "structure", - "members": { - "ProjectedColumns": { - "target": "com.amazonaws.quicksight#ProjectedColumnList", - "traits": { - "smithy.api#documentation": "

Projected columns.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A transform operation that projects columns. Operations that come after a projection\n can only refer to projected columns.

" - } - }, - "com.amazonaws.quicksight#ProjectedColumnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#String" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2000 - } - } - }, - "com.amazonaws.quicksight#PropertyRole": { - "type": "enum", - "members": { - "PRIMARY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRIMARY" - } - }, - "ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ID" - } - } - } - }, - "com.amazonaws.quicksight#PropertyUsage": { - "type": "enum", - "members": { - "INHERIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INHERIT" - } - }, - "DIMENSION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIMENSION" - } - }, - "MEASURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEASURE" - } - } - } - }, - "com.amazonaws.quicksight#PurchaseMode": { - "type": "enum", - "members": { - "MANUAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MANUAL" - } - }, - "AUTO_PURCHASE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO_PURCHASE" - } - } - } - }, - "com.amazonaws.quicksight#PutDataSetRefreshProperties": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#PutDataSetRefreshPropertiesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#PutDataSetRefreshPropertiesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates or updates the dataset refresh properties for the dataset.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#PutDataSetRefreshPropertiesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetRefreshProperties": { - "target": "com.amazonaws.quicksight#DataSetRefreshProperties", - "traits": { - "smithy.api#documentation": "

The dataset refresh properties.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#PutDataSetRefreshPropertiesResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#Query": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.quicksight#QueueInfo": { - "type": "structure", - "members": { - "WaitingOnIngestion": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the queued ingestion.

", - "smithy.api#required": {} - } - }, - "QueuedIngestion": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing\n ingestion to complete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a queued dataset SPICE ingestion.

" - } - }, - "com.amazonaws.quicksight#QuickSightUserNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The user with the provided name isn't found. This error can happen in any operation\n\t\t\tthat requires finding a user based on a provided user name, such as\n\t\t\t\tDeleteUser, DescribeUser, and so on.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.quicksight#QuickSight_20180401": { - "type": "service", - "version": "2018-04-01", - "operations": [ - { - "target": "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswer" - }, - { - "target": "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswer" - }, - { - "target": "com.amazonaws.quicksight#CancelIngestion" - }, - { - "target": "com.amazonaws.quicksight#CreateAccountCustomization" - }, - { - "target": "com.amazonaws.quicksight#CreateAccountSubscription" - }, - { - "target": "com.amazonaws.quicksight#CreateAnalysis" - }, - { - "target": "com.amazonaws.quicksight#CreateDashboard" - }, - { - "target": "com.amazonaws.quicksight#CreateDataSet" - }, - { - "target": "com.amazonaws.quicksight#CreateDataSource" - }, - { - "target": "com.amazonaws.quicksight#CreateFolder" - }, - { - "target": "com.amazonaws.quicksight#CreateFolderMembership" - }, - { - "target": "com.amazonaws.quicksight#CreateGroup" - }, - { - "target": "com.amazonaws.quicksight#CreateGroupMembership" - }, - { - "target": "com.amazonaws.quicksight#CreateIAMPolicyAssignment" - }, - { - "target": "com.amazonaws.quicksight#CreateIngestion" - }, - { - "target": "com.amazonaws.quicksight#CreateNamespace" - }, - { - "target": "com.amazonaws.quicksight#CreateRefreshSchedule" - }, - { - "target": "com.amazonaws.quicksight#CreateRoleMembership" - }, - { - "target": "com.amazonaws.quicksight#CreateTemplate" - }, - { - "target": "com.amazonaws.quicksight#CreateTemplateAlias" - }, - { - "target": "com.amazonaws.quicksight#CreateTheme" - }, - { - "target": "com.amazonaws.quicksight#CreateThemeAlias" - }, - { - "target": "com.amazonaws.quicksight#CreateTopic" - }, - { - "target": "com.amazonaws.quicksight#CreateTopicRefreshSchedule" - }, - { - "target": "com.amazonaws.quicksight#CreateVPCConnection" - }, - { - "target": "com.amazonaws.quicksight#DeleteAccountCustomization" - }, - { - "target": "com.amazonaws.quicksight#DeleteAccountSubscription" - }, - { - "target": "com.amazonaws.quicksight#DeleteAnalysis" - }, - { - "target": "com.amazonaws.quicksight#DeleteDashboard" - }, - { - "target": "com.amazonaws.quicksight#DeleteDataSet" - }, - { - "target": "com.amazonaws.quicksight#DeleteDataSetRefreshProperties" - }, - { - "target": "com.amazonaws.quicksight#DeleteDataSource" - }, - { - "target": "com.amazonaws.quicksight#DeleteFolder" - }, - { - "target": "com.amazonaws.quicksight#DeleteFolderMembership" - }, - { - "target": "com.amazonaws.quicksight#DeleteGroup" - }, - { - "target": "com.amazonaws.quicksight#DeleteGroupMembership" - }, - { - "target": "com.amazonaws.quicksight#DeleteIAMPolicyAssignment" - }, - { - "target": "com.amazonaws.quicksight#DeleteIdentityPropagationConfig" - }, - { - "target": "com.amazonaws.quicksight#DeleteNamespace" - }, - { - "target": "com.amazonaws.quicksight#DeleteRefreshSchedule" - }, - { - "target": "com.amazonaws.quicksight#DeleteRoleCustomPermission" - }, - { - "target": "com.amazonaws.quicksight#DeleteRoleMembership" - }, - { - "target": "com.amazonaws.quicksight#DeleteTemplate" - }, - { - "target": "com.amazonaws.quicksight#DeleteTemplateAlias" - }, - { - "target": "com.amazonaws.quicksight#DeleteTheme" - }, - { - "target": "com.amazonaws.quicksight#DeleteThemeAlias" - }, - { - "target": "com.amazonaws.quicksight#DeleteTopic" - }, - { - "target": "com.amazonaws.quicksight#DeleteTopicRefreshSchedule" - }, - { - "target": "com.amazonaws.quicksight#DeleteUser" - }, - { - "target": "com.amazonaws.quicksight#DeleteUserByPrincipalId" - }, - { - "target": "com.amazonaws.quicksight#DeleteVPCConnection" - }, - { - "target": "com.amazonaws.quicksight#DescribeAccountCustomization" - }, - { - "target": "com.amazonaws.quicksight#DescribeAccountSettings" - }, - { - "target": "com.amazonaws.quicksight#DescribeAccountSubscription" - }, - { - "target": "com.amazonaws.quicksight#DescribeAnalysis" - }, - { - "target": "com.amazonaws.quicksight#DescribeAnalysisDefinition" - }, - { - "target": "com.amazonaws.quicksight#DescribeAnalysisPermissions" - }, - { - "target": "com.amazonaws.quicksight#DescribeAssetBundleExportJob" - }, - { - "target": "com.amazonaws.quicksight#DescribeAssetBundleImportJob" - }, - { - "target": "com.amazonaws.quicksight#DescribeDashboard" - }, - { - "target": "com.amazonaws.quicksight#DescribeDashboardDefinition" - }, - { - "target": "com.amazonaws.quicksight#DescribeDashboardPermissions" - }, - { - "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJob" - }, - { - "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResult" - }, - { - "target": "com.amazonaws.quicksight#DescribeDataSet" - }, - { - "target": "com.amazonaws.quicksight#DescribeDataSetPermissions" - }, - { - "target": "com.amazonaws.quicksight#DescribeDataSetRefreshProperties" - }, - { - "target": "com.amazonaws.quicksight#DescribeDataSource" - }, - { - "target": "com.amazonaws.quicksight#DescribeDataSourcePermissions" - }, - { - "target": "com.amazonaws.quicksight#DescribeFolder" - }, - { - "target": "com.amazonaws.quicksight#DescribeFolderPermissions" - }, - { - "target": "com.amazonaws.quicksight#DescribeFolderResolvedPermissions" - }, - { - "target": "com.amazonaws.quicksight#DescribeGroup" - }, - { - "target": "com.amazonaws.quicksight#DescribeGroupMembership" - }, - { - "target": "com.amazonaws.quicksight#DescribeIAMPolicyAssignment" - }, - { - "target": "com.amazonaws.quicksight#DescribeIngestion" - }, - { - "target": "com.amazonaws.quicksight#DescribeIpRestriction" - }, - { - "target": "com.amazonaws.quicksight#DescribeKeyRegistration" - }, - { - "target": "com.amazonaws.quicksight#DescribeNamespace" - }, - { - "target": "com.amazonaws.quicksight#DescribeRefreshSchedule" - }, - { - "target": "com.amazonaws.quicksight#DescribeRoleCustomPermission" - }, - { - "target": "com.amazonaws.quicksight#DescribeTemplate" - }, - { - "target": "com.amazonaws.quicksight#DescribeTemplateAlias" - }, - { - "target": "com.amazonaws.quicksight#DescribeTemplateDefinition" - }, - { - "target": "com.amazonaws.quicksight#DescribeTemplatePermissions" - }, - { - "target": "com.amazonaws.quicksight#DescribeTheme" - }, - { - "target": "com.amazonaws.quicksight#DescribeThemeAlias" - }, - { - "target": "com.amazonaws.quicksight#DescribeThemePermissions" - }, - { - "target": "com.amazonaws.quicksight#DescribeTopic" - }, - { - "target": "com.amazonaws.quicksight#DescribeTopicPermissions" - }, - { - "target": "com.amazonaws.quicksight#DescribeTopicRefresh" - }, - { - "target": "com.amazonaws.quicksight#DescribeTopicRefreshSchedule" - }, - { - "target": "com.amazonaws.quicksight#DescribeUser" - }, - { - "target": "com.amazonaws.quicksight#DescribeVPCConnection" - }, - { - "target": "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUser" - }, - { - "target": "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUser" - }, - { - "target": "com.amazonaws.quicksight#GetDashboardEmbedUrl" - }, - { - "target": "com.amazonaws.quicksight#GetSessionEmbedUrl" - }, - { - "target": "com.amazonaws.quicksight#ListAnalyses" - }, - { - "target": "com.amazonaws.quicksight#ListAssetBundleExportJobs" - }, - { - "target": "com.amazonaws.quicksight#ListAssetBundleImportJobs" - }, - { - "target": "com.amazonaws.quicksight#ListDashboards" - }, - { - "target": "com.amazonaws.quicksight#ListDashboardVersions" - }, - { - "target": "com.amazonaws.quicksight#ListDataSets" - }, - { - "target": "com.amazonaws.quicksight#ListDataSources" - }, - { - "target": "com.amazonaws.quicksight#ListFolderMembers" - }, - { - "target": "com.amazonaws.quicksight#ListFolders" - }, - { - "target": "com.amazonaws.quicksight#ListGroupMemberships" - }, - { - "target": "com.amazonaws.quicksight#ListGroups" - }, - { - "target": "com.amazonaws.quicksight#ListIAMPolicyAssignments" - }, - { - "target": "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUser" - }, - { - "target": "com.amazonaws.quicksight#ListIdentityPropagationConfigs" - }, - { - "target": "com.amazonaws.quicksight#ListIngestions" - }, - { - "target": "com.amazonaws.quicksight#ListNamespaces" - }, - { - "target": "com.amazonaws.quicksight#ListRefreshSchedules" - }, - { - "target": "com.amazonaws.quicksight#ListRoleMemberships" - }, - { - "target": "com.amazonaws.quicksight#ListTagsForResource" - }, - { - "target": "com.amazonaws.quicksight#ListTemplateAliases" - }, - { - "target": "com.amazonaws.quicksight#ListTemplates" - }, - { - "target": "com.amazonaws.quicksight#ListTemplateVersions" - }, - { - "target": "com.amazonaws.quicksight#ListThemeAliases" - }, - { - "target": "com.amazonaws.quicksight#ListThemes" - }, - { - "target": "com.amazonaws.quicksight#ListThemeVersions" - }, - { - "target": "com.amazonaws.quicksight#ListTopicRefreshSchedules" - }, - { - "target": "com.amazonaws.quicksight#ListTopicReviewedAnswers" - }, - { - "target": "com.amazonaws.quicksight#ListTopics" - }, - { - "target": "com.amazonaws.quicksight#ListUserGroups" - }, - { - "target": "com.amazonaws.quicksight#ListUsers" - }, - { - "target": "com.amazonaws.quicksight#ListVPCConnections" - }, - { - "target": "com.amazonaws.quicksight#PutDataSetRefreshProperties" - }, - { - "target": "com.amazonaws.quicksight#RegisterUser" - }, - { - "target": "com.amazonaws.quicksight#RestoreAnalysis" - }, - { - "target": "com.amazonaws.quicksight#SearchAnalyses" - }, - { - "target": "com.amazonaws.quicksight#SearchDashboards" - }, - { - "target": "com.amazonaws.quicksight#SearchDataSets" - }, - { - "target": "com.amazonaws.quicksight#SearchDataSources" - }, - { - "target": "com.amazonaws.quicksight#SearchFolders" - }, - { - "target": "com.amazonaws.quicksight#SearchGroups" - }, - { - "target": "com.amazonaws.quicksight#StartAssetBundleExportJob" - }, - { - "target": "com.amazonaws.quicksight#StartAssetBundleImportJob" - }, - { - "target": "com.amazonaws.quicksight#StartDashboardSnapshotJob" - }, - { - "target": "com.amazonaws.quicksight#TagResource" - }, - { - "target": "com.amazonaws.quicksight#UntagResource" - }, - { - "target": "com.amazonaws.quicksight#UpdateAccountCustomization" - }, - { - "target": "com.amazonaws.quicksight#UpdateAccountSettings" - }, - { - "target": "com.amazonaws.quicksight#UpdateAnalysis" - }, - { - "target": "com.amazonaws.quicksight#UpdateAnalysisPermissions" - }, - { - "target": "com.amazonaws.quicksight#UpdateDashboard" - }, - { - "target": "com.amazonaws.quicksight#UpdateDashboardLinks" - }, - { - "target": "com.amazonaws.quicksight#UpdateDashboardPermissions" - }, - { - "target": "com.amazonaws.quicksight#UpdateDashboardPublishedVersion" - }, - { - "target": "com.amazonaws.quicksight#UpdateDataSet" - }, - { - "target": "com.amazonaws.quicksight#UpdateDataSetPermissions" - }, - { - "target": "com.amazonaws.quicksight#UpdateDataSource" - }, - { - "target": "com.amazonaws.quicksight#UpdateDataSourcePermissions" - }, - { - "target": "com.amazonaws.quicksight#UpdateFolder" - }, - { - "target": "com.amazonaws.quicksight#UpdateFolderPermissions" - }, - { - "target": "com.amazonaws.quicksight#UpdateGroup" - }, - { - "target": "com.amazonaws.quicksight#UpdateIAMPolicyAssignment" - }, - { - "target": "com.amazonaws.quicksight#UpdateIdentityPropagationConfig" - }, - { - "target": "com.amazonaws.quicksight#UpdateIpRestriction" - }, - { - "target": "com.amazonaws.quicksight#UpdateKeyRegistration" - }, - { - "target": "com.amazonaws.quicksight#UpdatePublicSharingSettings" - }, - { - "target": "com.amazonaws.quicksight#UpdateRefreshSchedule" - }, - { - "target": "com.amazonaws.quicksight#UpdateRoleCustomPermission" - }, - { - "target": "com.amazonaws.quicksight#UpdateSPICECapacityConfiguration" - }, - { - "target": "com.amazonaws.quicksight#UpdateTemplate" - }, - { - "target": "com.amazonaws.quicksight#UpdateTemplateAlias" - }, - { - "target": "com.amazonaws.quicksight#UpdateTemplatePermissions" - }, - { - "target": "com.amazonaws.quicksight#UpdateTheme" - }, - { - "target": "com.amazonaws.quicksight#UpdateThemeAlias" - }, - { - "target": "com.amazonaws.quicksight#UpdateThemePermissions" - }, - { - "target": "com.amazonaws.quicksight#UpdateTopic" - }, - { - "target": "com.amazonaws.quicksight#UpdateTopicPermissions" - }, - { - "target": "com.amazonaws.quicksight#UpdateTopicRefreshSchedule" - }, - { - "target": "com.amazonaws.quicksight#UpdateUser" - }, - { - "target": "com.amazonaws.quicksight#UpdateVPCConnection" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "QuickSight", - "arnNamespace": "quicksight", - "cloudFormationName": "QuickSight", - "cloudTrailEventSource": "quicksight.amazonaws.com", - "endpointPrefix": "quicksight" - }, - "aws.auth#sigv4": { - "name": "quicksight" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Amazon QuickSight API Reference\n

Amazon QuickSight is a fully managed, serverless business intelligence service for the\n Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your\n organization. This API reference contains documentation for a programming interface that\n you can use to manage Amazon QuickSight.

", - "smithy.api#title": "Amazon QuickSight", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://quicksight-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://quicksight-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://quicksight.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://quicksight.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.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://quicksight.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.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://quicksight.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://quicksight.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region api with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.api.amazonaws.com" - } - }, - "params": { - "Region": "api", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.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://quicksight.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.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://quicksight.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.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://quicksight.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://quicksight-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://quicksight-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://quicksight.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://quicksight-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://quicksight-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://quicksight.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://quicksight.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region api with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.api.amazonaws.com" - } - }, - "params": { - "Region": "api", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://quicksight-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://quicksight-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://quicksight.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://quicksight.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://quicksight-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://quicksight.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://quicksight-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://quicksight.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.quicksight#RadarChartAggregatedFieldWells": { - "type": "structure", - "members": { - "Category": { - "target": "com.amazonaws.quicksight#RadarChartCategoryFieldList", - "traits": { - "smithy.api#documentation": "

The aggregated field well categories of a radar chart.

" - } - }, - "Color": { - "target": "com.amazonaws.quicksight#RadarChartColorFieldList", - "traits": { - "smithy.api#documentation": "

The color that are assigned to the aggregated field wells of a radar chart.

" - } - }, - "Values": { - "target": "com.amazonaws.quicksight#RadarChartValuesFieldList", - "traits": { - "smithy.api#documentation": "

The values that are assigned to the aggregated field wells of a radar chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The aggregated field well configuration of a RadarChartVisual.

" - } - }, - "com.amazonaws.quicksight#RadarChartAreaStyleSettings": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility settings of a radar chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configured style settings of a radar chart.

" - } - }, - "com.amazonaws.quicksight#RadarChartAxesRangeScale": { - "type": "enum", - "members": { - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - }, - "INDEPENDENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INDEPENDENT" - } - }, - "SHARED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SHARED" - } - } - } - }, - "com.amazonaws.quicksight#RadarChartCategoryFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DimensionField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#RadarChartColorFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DimensionField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#RadarChartConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#RadarChartFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a RadarChartVisual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#RadarChartSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a RadarChartVisual.

" - } - }, - "Shape": { - "target": "com.amazonaws.quicksight#RadarChartShape", - "traits": { - "smithy.api#documentation": "

The shape of the radar chart.

" - } - }, - "BaseSeriesSettings": { - "target": "com.amazonaws.quicksight#RadarChartSeriesSettings", - "traits": { - "smithy.api#documentation": "

The base sreies settings of a radar chart.

" - } - }, - "StartAngle": { - "target": "com.amazonaws.quicksight#RadarChartStartAngle", - "traits": { - "smithy.api#documentation": "

The start angle of a radar chart's axis.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" - } - }, - "AlternateBandColorsVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines the visibility of the colors of alternatign bands in a radar chart.

" - } - }, - "AlternateBandEvenColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color of the even-numbered alternate bands of a radar chart.

" - } - }, - "AlternateBandOddColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color of the odd-numbered alternate bands of a radar chart.

" - } - }, - "CategoryAxis": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The category axis of a radar chart.

" - } - }, - "CategoryLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The category label options of a radar chart.

" - } - }, - "ColorAxis": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The color axis of a radar chart.

" - } - }, - "ColorLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The color label options of a radar chart.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "

The legend display setup of the visual.

" - } - }, - "AxesRangeScale": { - "target": "com.amazonaws.quicksight#RadarChartAxesRangeScale", - "traits": { - "smithy.api#documentation": "

The axis behavior options of a radar chart.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a RadarChartVisual.

" - } - }, - "com.amazonaws.quicksight#RadarChartFieldWells": { - "type": "structure", - "members": { - "RadarChartAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#RadarChartAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a radar chart visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field wells of a radar chart visual.

" - } - }, - "com.amazonaws.quicksight#RadarChartSeriesSettings": { - "type": "structure", - "members": { - "AreaStyleSettings": { - "target": "com.amazonaws.quicksight#RadarChartAreaStyleSettings", - "traits": { - "smithy.api#documentation": "

The area style settings of a radar chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The series settings of a radar chart.

" - } - }, - "com.amazonaws.quicksight#RadarChartShape": { - "type": "enum", - "members": { - "CIRCLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CIRCLE" - } - }, - "POLYGON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POLYGON" - } - } - } - }, - "com.amazonaws.quicksight#RadarChartSortConfiguration": { - "type": "structure", - "members": { - "CategorySort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The category sort options of a radar chart.

" - } - }, - "CategoryItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The category items limit for a radar chart.

" - } - }, - "ColorSort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The color sort configuration of a radar chart.

" - } - }, - "ColorItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The color items limit of a radar chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a RadarChartVisual.

" - } - }, - "com.amazonaws.quicksight#RadarChartStartAngle": { - "type": "double", - "traits": { - "smithy.api#range": { - "min": -360, - "max": 360 - } - } - }, - "com.amazonaws.quicksight#RadarChartValuesFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MeasureField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#RadarChartVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#RadarChartConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the visual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A radar chart visual.

" - } - }, - "com.amazonaws.quicksight#RangeConstant": { - "type": "structure", - "members": { - "Minimum": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The minimum value for a range constant.

" - } - }, - "Maximum": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The maximum value for a range constant.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a range constant.

" - } - }, - "com.amazonaws.quicksight#RangeEndsLabelType": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the range ends label.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The range ends label type of a data path label.

" - } - }, - "com.amazonaws.quicksight#RdsParameters": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.quicksight#InstanceId", - "traits": { - "smithy.api#documentation": "

Instance ID.

", - "smithy.api#required": {} - } - }, - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

Database.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for Amazon RDS.

" - } - }, - "com.amazonaws.quicksight#RecoveryWindowInDays": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 7, - "max": 30 - } - } - }, - "com.amazonaws.quicksight#RedshiftIAMParameters": { - "type": "structure", - "members": { - "RoleArn": { - "target": "com.amazonaws.quicksight#RoleArn", - "traits": { - "smithy.api#documentation": "

Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.

", - "smithy.api#required": {} - } - }, - "DatabaseUser": { - "target": "com.amazonaws.quicksight#DatabaseUser", - "traits": { - "smithy.api#documentation": "

The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.

" - } - }, - "DatabaseGroups": { - "target": "com.amazonaws.quicksight#DatabaseGroupList", - "traits": { - "smithy.api#documentation": "

A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.

" - } - }, - "AutoCreateDatabaseUser": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that grants Amazon QuickSight access to your cluster and make a call to the redshift:GetClusterCredentials API. For more information on the redshift:GetClusterCredentials API, see \n GetClusterCredentials\n .

" - } - }, - "com.amazonaws.quicksight#RedshiftParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

Host. This field can be blank if ClusterId is provided.

" - } - }, - "Port": { - "target": "com.amazonaws.quicksight#OptionalPort", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Port. This field can be blank if the ClusterId is provided.

" - } - }, - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

Database.

", - "smithy.api#required": {} - } - }, - "ClusterId": { - "target": "com.amazonaws.quicksight#ClusterId", - "traits": { - "smithy.api#documentation": "

Cluster ID. This field can be blank if the Host and Port are\n provided.

" - } - }, - "IAMParameters": { - "target": "com.amazonaws.quicksight#RedshiftIAMParameters", - "traits": { - "smithy.api#documentation": "

An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.

" - } - }, - "IdentityCenterConfiguration": { - "target": "com.amazonaws.quicksight#IdentityCenterConfiguration", - "traits": { - "smithy.api#documentation": "

An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.

\n

This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for Amazon Redshift. The ClusterId field can be blank if\n Host and Port are both set. The Host and Port fields can be blank if the ClusterId field is set.

" - } - }, - "com.amazonaws.quicksight#ReferenceLine": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#WidgetStatus", - "traits": { - "smithy.api#documentation": "

The status of the reference line. Choose one of the following options:

\n " - } - }, - "DataConfiguration": { - "target": "com.amazonaws.quicksight#ReferenceLineDataConfiguration", - "traits": { - "smithy.api#documentation": "

The data configuration of the reference line.

", - "smithy.api#required": {} - } - }, - "StyleConfiguration": { - "target": "com.amazonaws.quicksight#ReferenceLineStyleConfiguration", - "traits": { - "smithy.api#documentation": "

The style configuration of the reference line.

" - } - }, - "LabelConfiguration": { - "target": "com.amazonaws.quicksight#ReferenceLineLabelConfiguration", - "traits": { - "smithy.api#documentation": "

The label configuration of the reference line.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The reference line visual display options.

" - } - }, - "com.amazonaws.quicksight#ReferenceLineCustomLabelConfiguration": { - "type": "structure", - "members": { - "CustomLabel": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The string text of the custom label.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for a custom label on a ReferenceLine.

" - } - }, - "com.amazonaws.quicksight#ReferenceLineDataConfiguration": { - "type": "structure", - "members": { - "StaticConfiguration": { - "target": "com.amazonaws.quicksight#ReferenceLineStaticDataConfiguration", - "traits": { - "smithy.api#documentation": "

The static data configuration of the reference line data configuration.

" - } - }, - "DynamicConfiguration": { - "target": "com.amazonaws.quicksight#ReferenceLineDynamicDataConfiguration", - "traits": { - "smithy.api#documentation": "

The dynamic configuration of the reference line data configuration.

" - } - }, - "AxisBinding": { - "target": "com.amazonaws.quicksight#AxisBinding", - "traits": { - "smithy.api#documentation": "

The axis binding type of the reference line. Choose one of the following options:

\n " - } - }, - "SeriesType": { - "target": "com.amazonaws.quicksight#ReferenceLineSeriesType", - "traits": { - "smithy.api#documentation": "

The series type of the reference line data configuration. Choose one of the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The data configuration of the reference line.

" - } - }, - "com.amazonaws.quicksight#ReferenceLineDynamicDataConfiguration": { - "type": "structure", - "members": { - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the dynamic data targets.

", - "smithy.api#required": {} - } - }, - "MeasureAggregationFunction": { - "target": "com.amazonaws.quicksight#AggregationFunction", - "traits": { - "smithy.api#documentation": "

The aggregation function that is used in the dynamic data.

" - } - }, - "Calculation": { - "target": "com.amazonaws.quicksight#NumericalAggregationFunction", - "traits": { - "smithy.api#documentation": "

The calculation that is used in the dynamic data.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The dynamic configuration of the reference line data configuration.

" - } - }, - "com.amazonaws.quicksight#ReferenceLineLabelConfiguration": { - "type": "structure", - "members": { - "ValueLabelConfiguration": { - "target": "com.amazonaws.quicksight#ReferenceLineValueLabelConfiguration", - "traits": { - "smithy.api#documentation": "

The value label configuration of the label in a reference line.

" - } - }, - "CustomLabelConfiguration": { - "target": "com.amazonaws.quicksight#ReferenceLineCustomLabelConfiguration", - "traits": { - "smithy.api#documentation": "

The custom label configuration of the label in a reference line.

" - } - }, - "FontConfiguration": { - "target": "com.amazonaws.quicksight#FontConfiguration", - "traits": { - "smithy.api#documentation": "

The font configuration of the label in a reference line.

" - } - }, - "FontColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The font color configuration of the label in a reference line.

" - } - }, - "HorizontalPosition": { - "target": "com.amazonaws.quicksight#ReferenceLineLabelHorizontalPosition", - "traits": { - "smithy.api#documentation": "

The horizontal position configuration of the label in a reference line. Choose one of\n the following options:

\n " - } - }, - "VerticalPosition": { - "target": "com.amazonaws.quicksight#ReferenceLineLabelVerticalPosition", - "traits": { - "smithy.api#documentation": "

The vertical position configuration of the label in a reference line. Choose one of the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The label configuration of a reference line.

" - } - }, - "com.amazonaws.quicksight#ReferenceLineLabelHorizontalPosition": { - "type": "enum", - "members": { - "LEFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LEFT" - } - }, - "CENTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CENTER" - } - }, - "RIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RIGHT" - } - } - } - }, - "com.amazonaws.quicksight#ReferenceLineLabelVerticalPosition": { - "type": "enum", - "members": { - "ABOVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ABOVE" - } - }, - "BELOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BELOW" - } - } - } - }, - "com.amazonaws.quicksight#ReferenceLineList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ReferenceLine" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#ReferenceLinePatternType": { - "type": "enum", - "members": { - "SOLID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOLID" - } - }, - "DASHED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DASHED" - } - }, - "DOTTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOTTED" - } - } - } - }, - "com.amazonaws.quicksight#ReferenceLineSeriesType": { - "type": "enum", - "members": { - "BAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BAR" - } - }, - "LINE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LINE" - } - } - } - }, - "com.amazonaws.quicksight#ReferenceLineStaticDataConfiguration": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.quicksight#SensitiveDouble", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The double input of the static data.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The static data configuration of the reference line data configuration.

" - } - }, - "com.amazonaws.quicksight#ReferenceLineStyleConfiguration": { - "type": "structure", - "members": { - "Pattern": { - "target": "com.amazonaws.quicksight#ReferenceLinePatternType", - "traits": { - "smithy.api#documentation": "

The pattern type of the line style. Choose one of the following options:

\n " - } - }, - "Color": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The hex color of the reference line.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The style configuration of the reference\n line.

" - } - }, - "com.amazonaws.quicksight#ReferenceLineValueLabelConfiguration": { - "type": "structure", - "members": { - "RelativePosition": { - "target": "com.amazonaws.quicksight#ReferenceLineValueLabelRelativePosition", - "traits": { - "smithy.api#documentation": "

The relative position of the value label. Choose one of the following options:

\n " - } - }, - "FormatConfiguration": { - "target": "com.amazonaws.quicksight#NumericFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The format configuration of the value label.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The value label configuration of the label in a reference line.

" - } - }, - "com.amazonaws.quicksight#ReferenceLineValueLabelRelativePosition": { - "type": "enum", - "members": { - "BEFORE_CUSTOM_LABEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BEFORE_CUSTOM_LABEL" - } - }, - "AFTER_CUSTOM_LABEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AFTER_CUSTOM_LABEL" - } - } - } - }, - "com.amazonaws.quicksight#RefreshConfiguration": { - "type": "structure", - "members": { - "IncrementalRefresh": { - "target": "com.amazonaws.quicksight#IncrementalRefresh", - "traits": { - "smithy.api#documentation": "

The incremental refresh for the dataset.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The refresh configuration of a dataset.

" - } - }, - "com.amazonaws.quicksight#RefreshFrequency": { - "type": "structure", - "members": { - "Interval": { - "target": "com.amazonaws.quicksight#RefreshInterval", - "traits": { - "smithy.api#documentation": "

The interval between scheduled refreshes. Valid values are as follows:

\n ", - "smithy.api#required": {} - } - }, - "RefreshOnDay": { - "target": "com.amazonaws.quicksight#ScheduleRefreshOnEntity", - "traits": { - "smithy.api#documentation": "

The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.

" - } - }, - "Timezone": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs().

" - } - }, - "TimeOfTheDay": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the interval between each scheduled refresh of a dataset.

" - } - }, - "com.amazonaws.quicksight#RefreshInterval": { - "type": "enum", - "members": { - "MINUTE15": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MINUTE15" - } - }, - "MINUTE30": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MINUTE30" - } - }, - "HOURLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOURLY" - } - }, - "DAILY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DAILY" - } - }, - "WEEKLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WEEKLY" - } - }, - "MONTHLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MONTHLY" - } - } - } - }, - "com.amazonaws.quicksight#RefreshSchedule": { - "type": "structure", - "members": { - "ScheduleId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

An identifier for the refresh schedule.

", - "smithy.api#required": {} - } - }, - "ScheduleFrequency": { - "target": "com.amazonaws.quicksight#RefreshFrequency", - "traits": { - "smithy.api#documentation": "

The frequency for the refresh schedule.

", - "smithy.api#required": {} - } - }, - "StartAfterDateTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

" - } - }, - "RefreshType": { - "target": "com.amazonaws.quicksight#IngestionType", - "traits": { - "smithy.api#documentation": "

The type of refresh that a datset undergoes. Valid values are as follows:

\n \n

For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon QuickSight User Guide.

", - "smithy.api#required": {} - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the refresh schedule.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The refresh schedule of a dataset.

" - } - }, - "com.amazonaws.quicksight#RefreshSchedules": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#RefreshSchedule", - "traits": { - "smithy.api#documentation": "

A list of RefreshSchedule objects.

" - } - } - }, - "com.amazonaws.quicksight#RegisterUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#RegisterUserRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#RegisterUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#RegisterUserRequest": { - "type": "structure", - "members": { - "IdentityType": { - "target": "com.amazonaws.quicksight#IdentityType", - "traits": { - "smithy.api#documentation": "

The identity type that your Amazon QuickSight account uses to manage the identity of users.

", - "smithy.api#required": {} - } - }, - "Email": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The email address of the user that you want to register.

", - "smithy.api#required": {} - } - }, - "UserRole": { - "target": "com.amazonaws.quicksight#UserRole", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight role for the user. The user role can be one of the\n\t\t\tfollowing:

\n ", - "smithy.api#required": {} - } - }, - "IamArn": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ARN of the IAM user or role that you are registering with Amazon QuickSight.

" - } - }, - "SessionName": { - "target": "com.amazonaws.quicksight#RoleSessionName", - "traits": { - "smithy.api#documentation": "

You need to use this parameter only when you register one or more users using an assumed\n\t\t\tIAM role. You don't need to provide the session name for other scenarios, for example when\n\t\t\tyou are registering an IAM user or an Amazon QuickSight user. You can register multiple\n\t\t\tusers using the same IAM role if each user has a different session name. For more\n\t\t\tinformation on assuming IAM roles, see \n assume-role\n in the CLI Reference.\n

" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "UserName": { - "target": "com.amazonaws.quicksight#UserName", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight user name that you want to create for the user you are\n\t\t\tregistering.

" - } - }, - "CustomPermissionsName": { - "target": "com.amazonaws.quicksight#RoleName", - "traits": { - "smithy.api#documentation": "

(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:

\n \n

To add custom permissions to an existing user, use \n UpdateUser\n instead.

\n

A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the Amazon QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a Amazon QuickSight user.

\n

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning Amazon QuickSight users to one of the\n default security cohorts in Amazon QuickSight (admin, author, reader, admin pro, author pro, reader pro).

\n

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

" - } - }, - "ExternalLoginFederationProviderType": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

\n " - } - }, - "CustomFederationProviderUrl": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate\n into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should\n only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

" - } - }, - "ExternalLoginId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The identity ID for a user in the external login provider.

" - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

The tags to associate with the user.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#RegisterUserResponse": { - "type": "structure", - "members": { - "User": { - "target": "com.amazonaws.quicksight#User", - "traits": { - "smithy.api#documentation": "

The user's user name.

" - } - }, - "UserInvitationUrl": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The URL the user visits to complete registration and provide a password. This is\n\t\t\treturned only for users with an identity type of QUICKSIGHT.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#RegisteredCustomerManagedKey": { - "type": "structure", - "members": { - "KeyArn": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ARN of the KMS key that is registered to a Amazon QuickSight account for encryption and decryption use.

" - } - }, - "DefaultKey": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a RegisteredCustomerManagedKey is set as the default key for encryption and decryption use.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A customer managed key structure that contains the information listed below:

\n " - } - }, - "com.amazonaws.quicksight#RegisteredUserConsoleFeatureConfigurations": { - "type": "structure", - "members": { - "StatePersistence": { - "target": "com.amazonaws.quicksight#StatePersistenceConfigurations", - "traits": { - "smithy.api#documentation": "

The state persistence configurations of an embedded Amazon QuickSight console.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The feature configurations of an embedded Amazon QuickSight console.

" - } - }, - "com.amazonaws.quicksight#RegisteredUserDashboardEmbeddingConfiguration": { - "type": "structure", - "members": { - "InitialDashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.

\n

If the user does not have permission to view this dashboard, they see a permissions error message.

", - "smithy.api#required": {} - } - }, - "FeatureConfigurations": { - "target": "com.amazonaws.quicksight#RegisteredUserDashboardFeatureConfigurations", - "traits": { - "smithy.api#documentation": "

The feature configurations of an embbedded Amazon QuickSight dashboard.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the dashboard you want to embed.

" - } - }, - "com.amazonaws.quicksight#RegisteredUserDashboardFeatureConfigurations": { - "type": "structure", - "members": { - "StatePersistence": { - "target": "com.amazonaws.quicksight#StatePersistenceConfigurations", - "traits": { - "smithy.api#documentation": "

The state persistence settings of an embedded dashboard.

" - } - }, - "Bookmarks": { - "target": "com.amazonaws.quicksight#BookmarksConfigurations", - "traits": { - "smithy.api#documentation": "

The bookmarks configuration for an embedded dashboard in Amazon QuickSight.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The feature configuration for an embedded dashboard.

" - } - }, - "com.amazonaws.quicksight#RegisteredUserDashboardVisualEmbeddingConfiguration": { - "type": "structure", - "members": { - "InitialDashboardVisualId": { - "target": "com.amazonaws.quicksight#DashboardVisualId", - "traits": { - "smithy.api#documentation": "

The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.

\n

The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.

" - } - }, - "com.amazonaws.quicksight#RegisteredUserEmbeddingExperienceConfiguration": { - "type": "structure", - "members": { - "Dashboard": { - "target": "com.amazonaws.quicksight#RegisteredUserDashboardEmbeddingConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration details for providing a dashboard embedding experience.

" - } - }, - "QuickSightConsole": { - "target": "com.amazonaws.quicksight#RegisteredUserQuickSightConsoleEmbeddingConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User\n Guide.

\n

Use \n GenerateEmbedUrlForRegisteredUser\n \n where\n you want to provide an authoring portal that allows users to create data sources,\n datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console\n needs to belong to the author or admin security cohort. If you want to restrict permissions\n to some of these features, add a custom permissions profile to the user with the\n \n UpdateUser\n API operation. Use the \n RegisterUser\n API operation to add a new user with a custom permission profile attached. For more\n information, see the following sections in the Amazon QuickSight User\n Guide:

\n \n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

" - } - }, - "QSearchBar": { - "target": "com.amazonaws.quicksight#RegisteredUserQSearchBarEmbeddingConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration details for embedding the Q search bar.

\n

For more information about embedding the Q search bar, see Embedding Overview in\n the Amazon QuickSight User Guide.

" - } - }, - "DashboardVisual": { - "target": "com.amazonaws.quicksight#RegisteredUserDashboardVisualEmbeddingConfiguration", - "traits": { - "smithy.api#documentation": "

The type of embedding experience. In this case, Amazon QuickSight visuals.

" - } - }, - "GenerativeQnA": { - "target": "com.amazonaws.quicksight#RegisteredUserGenerativeQnAEmbeddingConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration details for embedding the Generative Q&A experience.

\n

For more information about embedding the Generative Q&A experience, see Embedding Overview in\n the Amazon QuickSight User Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.

\n \n

Exactly one of the experience configurations is required. You can choose\n Dashboard or QuickSightConsole. You cannot choose more\n than one experience configuration.

\n " - } - }, - "com.amazonaws.quicksight#RegisteredUserGenerativeQnAEmbeddingConfiguration": { - "type": "structure", - "members": { - "InitialTopicId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&A experience.\n You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening\n a topic. The ID is in the URL for the topic that you open.

\n

If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader experience topics is shown in the Generative Q&A experience for your readers. When you select an initial new reader experience topic, you can specify whether or not readers are allowed to select other new reader experience topics from the available ones in the list.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that provides information about the configuration of a Generative Q&A experience.

" - } - }, - "com.amazonaws.quicksight#RegisteredUserQSearchBarEmbeddingConfiguration": { - "type": "structure", - "members": { - "InitialTopicId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the Amazon QuickSight console, navigate to the Topics pane, and choose thre topic that you want to use. The TopicID is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers\n are allowed to select other topics from the list of available topics.

\n

If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the Q search bar embedding experience.

" - } - }, - "com.amazonaws.quicksight#RegisteredUserQuickSightConsoleEmbeddingConfiguration": { - "type": "structure", - "members": { - "InitialPath": { - "target": "com.amazonaws.quicksight#EntryPath", - "traits": { - "smithy.api#documentation": "

The initial URL path for the Amazon QuickSight console. InitialPath is required.

\n

The entry point URL is constrained to the following paths:

\n " - } - }, - "FeatureConfigurations": { - "target": "com.amazonaws.quicksight#RegisteredUserConsoleFeatureConfigurations", - "traits": { - "smithy.api#documentation": "

The embedding configuration of an embedded Amazon QuickSight console.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the Amazon QuickSight console that you want to embed.

" - } - }, - "com.amazonaws.quicksight#RelationalTable": { - "type": "structure", - "members": { - "DataSourceArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the data source.

", - "smithy.api#required": {} - } - }, - "Catalog": { - "target": "com.amazonaws.quicksight#RelationalTableCatalog", - "traits": { - "smithy.api#documentation": "

The catalog associated with a table.

" - } - }, - "Schema": { - "target": "com.amazonaws.quicksight#RelationalTableSchema", - "traits": { - "smithy.api#documentation": "

The schema name. This name applies to certain relational database engines.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#RelationalTableName", - "traits": { - "smithy.api#documentation": "

The name of the relational table.

", - "smithy.api#required": {} - } - }, - "InputColumns": { - "target": "com.amazonaws.quicksight#InputColumnList", - "traits": { - "smithy.api#documentation": "

The column schema of the table.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A physical table type for relational data sources.

" - } - }, - "com.amazonaws.quicksight#RelationalTableCatalog": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.quicksight#RelationalTableName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.quicksight#RelationalTableSchema": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.quicksight#RelativeDateTimeControlDisplayOptions": { - "type": "structure", - "members": { - "TitleOptions": { - "target": "com.amazonaws.quicksight#LabelOptions", - "traits": { - "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" - } - }, - "DateTimeFormat": { - "target": "com.amazonaws.quicksight#DateTimeFormat", - "traits": { - "smithy.api#documentation": "

Customize how dates are formatted in controls.

" - } - }, - "InfoIconLabelOptions": { - "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", - "traits": { - "smithy.api#documentation": "

The configuration of info icon label options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "com.amazonaws.quicksight#RelativeDateType": { - "type": "enum", - "members": { - "PREVIOUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PREVIOUS" - } - }, - "THIS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THIS" - } - }, - "LAST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAST" - } - }, - "NOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOW" - } - }, - "NEXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEXT" - } - } - } - }, - "com.amazonaws.quicksight#RelativeDatesFilter": { - "type": "structure", - "members": { - "FilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "AnchorDateConfiguration": { - "target": "com.amazonaws.quicksight#AnchorDateConfiguration", - "traits": { - "smithy.api#documentation": "

The date configuration of the filter.

", - "smithy.api#required": {} - } - }, - "MinimumGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The minimum granularity (period granularity) of the relative dates filter.

" - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

", - "smithy.api#required": {} - } - }, - "RelativeDateType": { - "target": "com.amazonaws.quicksight#RelativeDateType", - "traits": { - "smithy.api#documentation": "

The range date type of the filter. Choose one of the options below:

\n ", - "smithy.api#required": {} - } - }, - "RelativeDateValue": { - "target": "com.amazonaws.quicksight#Integer", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The date value of the filter.

" - } - }, - "ParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The parameter whose value should be used for the filter value.

" - } - }, - "NullOption": { - "target": "com.amazonaws.quicksight#FilterNullOption", - "traits": { - "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", - "smithy.api#required": {} - } - }, - "ExcludePeriodConfiguration": { - "target": "com.amazonaws.quicksight#ExcludePeriodConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration for the exclude period of the filter.

" - } - }, - "DefaultFilterControlConfiguration": { - "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", - "traits": { - "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A RelativeDatesFilter filters relative dates values.

" - } - }, - "com.amazonaws.quicksight#RelativeFontSize": { - "type": "enum", - "members": { - "EXTRA_SMALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXTRA_SMALL" - } - }, - "SMALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SMALL" - } - }, - "MEDIUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIUM" - } - }, - "LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LARGE" - } - }, - "EXTRA_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXTRA_LARGE" - } - } - } - }, - "com.amazonaws.quicksight#RenameColumnOperation": { - "type": "structure", - "members": { - "ColumnName": { - "target": "com.amazonaws.quicksight#ColumnName", - "traits": { - "smithy.api#documentation": "

The name of the column to be renamed.

", - "smithy.api#required": {} - } - }, - "NewColumnName": { - "target": "com.amazonaws.quicksight#ColumnName", - "traits": { - "smithy.api#documentation": "

The new name for the column.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A transform operation that renames a column.

" - } - }, - "com.amazonaws.quicksight#ResizeOption": { - "type": "enum", - "members": { - "FIXED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIXED" - } - }, - "RESPONSIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESPONSIVE" - } - } - } - }, - "com.amazonaws.quicksight#ResourceExistsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "ResourceType": { - "target": "com.amazonaws.quicksight#ExceptionResourceType", - "traits": { - "smithy.api#documentation": "

The resource type for this request.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The resource specified already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.quicksight#ResourceId": { - "type": "string" - }, - "com.amazonaws.quicksight#ResourceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.quicksight#ResourceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "ResourceType": { - "target": "com.amazonaws.quicksight#ExceptionResourceType", - "traits": { - "smithy.api#documentation": "

The resource type for this request.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

One or more resources can't be found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.quicksight#ResourcePermission": { - "type": "structure", - "members": { - "Principal": { - "target": "com.amazonaws.quicksight#Principal", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n ", - "smithy.api#required": {} - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#ActionList", - "traits": { - "smithy.api#documentation": "

The IAM action to grant or revoke permissions on.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Permission for the resource.

" - } - }, - "com.amazonaws.quicksight#ResourcePermissionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ResourcePermission" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#ResourceStatus": { - "type": "enum", - "members": { - "CREATION_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_IN_PROGRESS" - } - }, - "CREATION_SUCCESSFUL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_SUCCESSFUL" - } - }, - "CREATION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_FAILED" - } - }, - "UPDATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_IN_PROGRESS" - } - }, - "UPDATE_SUCCESSFUL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_SUCCESSFUL" - } - }, - "UPDATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_FAILED" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - } - } - }, - "com.amazonaws.quicksight#ResourceUnavailableException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "ResourceType": { - "target": "com.amazonaws.quicksight#ExceptionResourceType", - "traits": { - "smithy.api#documentation": "

The resource type for this request.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This resource is currently unavailable.

", - "smithy.api#error": "server", - "smithy.api#httpError": 503 - } - }, - "com.amazonaws.quicksight#RestoreAnalysis": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#RestoreAnalysisRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#RestoreAnalysisResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Restores an analysis.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/restore/analyses/{AnalysisId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#RestoreAnalysisRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis that you're restoring.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#RestoreAnalysisResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the analysis that you're restoring.

" - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis that you're restoring.\n

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#RestrictiveResourceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^[\\w\\-]+$" - } - }, - "com.amazonaws.quicksight#ReviewedAnswerErrorCode": { - "type": "enum", - "members": { - "INTERNAL_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_ERROR" - } - }, - "MISSING_ANSWER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MISSING_ANSWER" - } - }, - "DATASET_DOES_NOT_EXIST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATASET_DOES_NOT_EXIST" - } - }, - "INVALID_DATASET_ARN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INVALID_DATASET_ARN" - } - }, - "DUPLICATED_ANSWER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DUPLICATED_ANSWER" - } - }, - "INVALID_DATA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INVALID_DATA" - } - }, - "MISSING_REQUIRED_FIELDS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MISSING_REQUIRED_FIELDS" - } - } - } - }, - "com.amazonaws.quicksight#Role": { - "type": "enum", - "members": { - "ADMIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ADMIN" - } - }, - "AUTHOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTHOR" - } - }, - "READER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READER" - } - }, - "ADMIN_PRO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ADMIN_PRO" - } - }, - "AUTHOR_PRO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTHOR_PRO" - } - }, - "READER_PRO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READER_PRO" - } - } - } - }, - "com.amazonaws.quicksight#RoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#RoleName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[a-zA-Z0-9+=,.@_-]+$" - } - }, - "com.amazonaws.quicksight#RoleSessionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 64 - }, - "smithy.api#pattern": "^[\\w+=.@-]*$" - } - }, - "com.amazonaws.quicksight#RollingDateConfiguration": { - "type": "structure", - "members": { - "DataSetIdentifier": { - "target": "com.amazonaws.quicksight#DataSetIdentifier", - "traits": { - "smithy.api#documentation": "

The data set that is used in the rolling date configuration.

" - } - }, - "Expression": { - "target": "com.amazonaws.quicksight#Expression", - "traits": { - "smithy.api#documentation": "

The expression of the rolling date configuration.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The rolling date configuration of a date time filter.

" - } - }, - "com.amazonaws.quicksight#RowAlternateColorList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#HexColor" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#RowAlternateColorOptions": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#WidgetStatus", - "traits": { - "smithy.api#documentation": "

Determines the widget status.

" - } - }, - "RowAlternateColors": { - "target": "com.amazonaws.quicksight#RowAlternateColorList", - "traits": { - "smithy.api#documentation": "

Determines the list of row alternate colors.

" - } - }, - "UsePrimaryBackgroundColor": { - "target": "com.amazonaws.quicksight#WidgetStatus", - "traits": { - "smithy.api#documentation": "

The primary background color options for alternate rows.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines the row alternate color options.

" - } - }, - "com.amazonaws.quicksight#RowInfo": { - "type": "structure", - "members": { - "RowsIngested": { - "target": "com.amazonaws.quicksight#Long", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The number of rows that were ingested.

" - } - }, - "RowsDropped": { - "target": "com.amazonaws.quicksight#Long", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The number of rows that were not ingested.

" - } - }, - "TotalRowsInDataset": { - "target": "com.amazonaws.quicksight#Long", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The total number of rows in the dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about rows for a data set SPICE ingestion.

" - } - }, - "com.amazonaws.quicksight#RowLevelPermissionDataSet": { - "type": "structure", - "members": { - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace associated with the dataset that contains permissions for RLS.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

", - "smithy.api#required": {} - } - }, - "PermissionPolicy": { - "target": "com.amazonaws.quicksight#RowLevelPermissionPolicy", - "traits": { - "smithy.api#documentation": "

The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS\n is included for backward compatibility only.

", - "smithy.api#required": {} - } - }, - "FormatVersion": { - "target": "com.amazonaws.quicksight#RowLevelPermissionFormatVersion", - "traits": { - "smithy.api#documentation": "

The user or group rules associated with the dataset that contains permissions for RLS.

\n

By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#Status", - "traits": { - "smithy.api#documentation": "

The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a dataset that contains permissions for row-level security (RLS).\n The permissions dataset maps fields to users or groups. For more information, see\n Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User\n Guide.

\n

The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is\n not supported for new RLS datasets.

" - } - }, - "com.amazonaws.quicksight#RowLevelPermissionFormatVersion": { - "type": "enum", - "members": { - "VERSION_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VERSION_1" - } - }, - "VERSION_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VERSION_2" - } - } - } - }, - "com.amazonaws.quicksight#RowLevelPermissionPolicy": { - "type": "enum", - "members": { - "GRANT_ACCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GRANT_ACCESS" - } - }, - "DENY_ACCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DENY_ACCESS" - } - } - } - }, - "com.amazonaws.quicksight#RowLevelPermissionTagConfiguration": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#Status", - "traits": { - "smithy.api#documentation": "

The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

" - } - }, - "TagRules": { - "target": "com.amazonaws.quicksight#RowLevelPermissionTagRuleList", - "traits": { - "smithy.api#documentation": "

A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

", - "smithy.api#required": {} - } - }, - "TagRuleConfigurations": { - "target": "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfigurationList", - "traits": { - "smithy.api#documentation": "

A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of tags on a dataset to set row-level security.

" - } - }, - "com.amazonaws.quicksight#RowLevelPermissionTagDelimiter": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#RowLevelPermissionTagRule": { - "type": "structure", - "members": { - "TagKey": { - "target": "com.amazonaws.quicksight#SessionTagKey", - "traits": { - "smithy.api#documentation": "

The unique key for a tag.

", - "smithy.api#required": {} - } - }, - "ColumnName": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The column name that a tag key is assigned to.

", - "smithy.api#required": {} - } - }, - "TagMultiValueDelimiter": { - "target": "com.amazonaws.quicksight#RowLevelPermissionTagDelimiter", - "traits": { - "smithy.api#documentation": "

A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.

" - } - }, - "MatchAllValue": { - "target": "com.amazonaws.quicksight#SessionTagValue", - "traits": { - "smithy.api#documentation": "

A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A set of rules associated with a tag.

" - } - }, - "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfiguration": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SessionTagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#RowLevelPermissionTagRuleList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#RowLevelPermissionTagRule" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#RowSortList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FieldSortOptions" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#S3Bucket": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.quicksight#S3BucketConfiguration": { - "type": "structure", - "members": { - "BucketName": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.

", - "smithy.api#required": {} - } - }, - "BucketPrefix": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The prefix of the Amazon S3 bucket that the generated snapshots are stored in.

", - "smithy.api#required": {} - } - }, - "BucketRegion": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An optional structure that contains the Amazon S3 bucket configuration that the generated snapshots are stored in. If you don't provide this information, generated snapshots are stored in the default Amazon QuickSight bucket.

" - } - }, - "com.amazonaws.quicksight#S3Key": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.quicksight#S3Parameters": { - "type": "structure", - "members": { - "ManifestFileLocation": { - "target": "com.amazonaws.quicksight#ManifestFileLocation", - "traits": { - "smithy.api#documentation": "

Location of the Amazon S3 manifest file. This is NULL if the manifest file was\n uploaded into Amazon QuickSight.

", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.quicksight#RoleArn", - "traits": { - "smithy.api#documentation": "

Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for S3.

" - } - }, - "com.amazonaws.quicksight#S3Source": { - "type": "structure", - "members": { - "DataSourceArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the data source.

", - "smithy.api#required": {} - } - }, - "UploadSettings": { - "target": "com.amazonaws.quicksight#UploadSettings", - "traits": { - "smithy.api#documentation": "

Information about the format for the S3 source file or files.

" - } - }, - "InputColumns": { - "target": "com.amazonaws.quicksight#InputColumnList", - "traits": { - "smithy.api#documentation": "

A physical table type for an S3 data source.

\n \n

For files that aren't JSON, only STRING data types are supported in input columns.

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A physical table type for an S3 data source.

" - } - }, - "com.amazonaws.quicksight#S3Uri": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(https|s3)://([^/]+)/?(.*)$" - } - }, - "com.amazonaws.quicksight#SameSheetTargetVisualConfiguration": { - "type": "structure", - "members": { - "TargetVisuals": { - "target": "com.amazonaws.quicksight#TargetVisualList", - "traits": { - "smithy.api#documentation": "

A list of the target visual IDs that are located in the same sheet of the analysis.

" - } - }, - "TargetVisualOptions": { - "target": "com.amazonaws.quicksight#TargetVisualOptions", - "traits": { - "smithy.api#documentation": "

The options that choose the target visual in the same sheet.

\n

Valid values are defined as follows:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of the same-sheet target visuals that you want to be filtered.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#SankeyDiagramAggregatedFieldWells": { - "type": "structure", - "members": { - "Source": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The source field wells of a sankey diagram.

" - } - }, - "Destination": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The destination field wells of a sankey diagram.

" - } - }, - "Weight": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The weight field wells of a sankey diagram.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a sankey diagram.

" - } - }, - "com.amazonaws.quicksight#SankeyDiagramChartConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#SankeyDiagramFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a sankey diagram.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#SankeyDiagramSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a sankey diagram.

" - } - }, - "DataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The data label configuration of a sankey diagram.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a sankey diagram.

" - } - }, - "com.amazonaws.quicksight#SankeyDiagramFieldWells": { - "type": "structure", - "members": { - "SankeyDiagramAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#SankeyDiagramAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a sankey diagram.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a sankey diagram.

" - } - }, - "com.amazonaws.quicksight#SankeyDiagramSortConfiguration": { - "type": "structure", - "members": { - "WeightSort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the weight fields.

" - } - }, - "SourceItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of source nodes that are displayed in a sankey diagram.

" - } - }, - "DestinationItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of destination nodes that are displayed in a sankey diagram.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a sankey diagram.

" - } - }, - "com.amazonaws.quicksight#SankeyDiagramVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#SankeyDiagramChartConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of a sankey diagram.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A sankey diagram.

\n

For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#ScatterPlotCategoricallyAggregatedFieldWells": { - "type": "structure", - "members": { - "XAxis": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The x-axis field well of a scatter plot.

\n

The x-axis is aggregated by category.

" - } - }, - "YAxis": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The y-axis field well of a scatter plot.

\n

The y-axis is aggregated by category.

" - } - }, - "Category": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The category field well of a scatter plot.

" - } - }, - "Size": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The size field well of a scatter plot.

" - } - }, - "Label": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The label field well of a scatter plot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The aggregated field well of a scatter plot.

" - } - }, - "com.amazonaws.quicksight#ScatterPlotConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#ScatterPlotFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#ScatterPlotSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a scatter plot.

" - } - }, - "XAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.

" - } - }, - "XAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.

" - } - }, - "YAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.

" - } - }, - "YAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "

The legend display setup of the visual.

" - } - }, - "DataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The legend display setup of the visual.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a scatter plot.

" - } - }, - "com.amazonaws.quicksight#ScatterPlotFieldWells": { - "type": "structure", - "members": { - "ScatterPlotCategoricallyAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#ScatterPlotCategoricallyAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a scatter plot. The x and y-axes of scatter plots with aggregated field wells are aggregated by category, label, or both.

" - } - }, - "ScatterPlotUnaggregatedFieldWells": { - "target": "com.amazonaws.quicksight#ScatterPlotUnaggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The unaggregated field wells of a scatter plot. The x and y-axes of these scatter plots are\n unaggregated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a scatter plot.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#ScatterPlotSortConfiguration": { - "type": "structure", - "members": { - "ScatterPlotLimitConfiguration": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration" - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a scatter plot.

" - } - }, - "com.amazonaws.quicksight#ScatterPlotUnaggregatedFieldWells": { - "type": "structure", - "members": { - "XAxis": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The x-axis field well of a scatter plot.

\n

The x-axis is a dimension field and cannot be aggregated.

" - } - }, - "YAxis": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The y-axis field well of a scatter plot.

\n

The y-axis is a dimension field and cannot be aggregated.

" - } - }, - "Size": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The size field well of a scatter plot.

" - } - }, - "Category": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The category field well of a scatter plot.

" - } - }, - "Label": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The label field well of a scatter plot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The unaggregated field wells of a scatter plot.

" - } - }, - "com.amazonaws.quicksight#ScatterPlotVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#ScatterPlotConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the visual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A scatter plot.

\n

For more information, see Using scatter plots in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#ScheduleRefreshOnEntity": { - "type": "structure", - "members": { - "DayOfWeek": { - "target": "com.amazonaws.quicksight#DayOfWeek", - "traits": { - "smithy.api#documentation": "

The day of the week that you want to schedule a refresh on.

" - } - }, - "DayOfMonth": { - "target": "com.amazonaws.quicksight#DayOfMonth", - "traits": { - "smithy.api#documentation": "

The day of the month that you want to schedule refresh on.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The refresh on entity for weekly or monthly schedules.

" - } - }, - "com.amazonaws.quicksight#ScrollBarOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the data zoom scroll bar.

" - } - }, - "VisibleRange": { - "target": "com.amazonaws.quicksight#VisibleRangeOptions", - "traits": { - "smithy.api#documentation": "

The visibility range for the data zoom scroll bar.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The visual display options for a data zoom scroll bar.

" - } - }, - "com.amazonaws.quicksight#SearchAnalyses": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#SearchAnalysesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#SearchAnalysesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Searches for analyses that belong to the user specified in the filter.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/search/analyses", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AnalysisSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#SearchAnalysesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analyses that you're searching\n for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.quicksight#AnalysisSearchFilterList", - "traits": { - "smithy.api#documentation": "

The structure for the search filters that you want to apply to your search.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#SearchAnalysesResponse": { - "type": "structure", - "members": { - "AnalysisSummaryList": { - "target": "com.amazonaws.quicksight#AnalysisSummaryList", - "traits": { - "smithy.api#documentation": "

Metadata describing the analyses that you searched for.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.\n

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#SearchDashboards": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#SearchDashboardsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#SearchDashboardsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Searches for dashboards that belong to a user.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/search/dashboards", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "DashboardSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#SearchDashboardsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the user whose dashboards you're searching\n for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.quicksight#DashboardSearchFilterList", - "traits": { - "smithy.api#documentation": "

The filters to apply to the search. Currently, you can search only by user name, for\n example, \"Filters\": [ { \"Name\": \"QUICKSIGHT_USER\", \"Operator\": \"StringEquals\",\n \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\" } ]\n

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#SearchDashboardsResponse": { - "type": "structure", - "members": { - "DashboardSummaryList": { - "target": "com.amazonaws.quicksight#DashboardSummaryList", - "traits": { - "smithy.api#documentation": "

The list of dashboards owned by the user specified in Filters in your\n request.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#SearchDataSets": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#SearchDataSetsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#SearchDataSetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Use the SearchDataSets operation to search for datasets that belong to an account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/search/data-sets", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "DataSetSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#SearchDataSetsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.quicksight#DataSetSearchFilterList", - "traits": { - "smithy.api#documentation": "

The filters to apply to the search.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#SearchDataSetsResponse": { - "type": "structure", - "members": { - "DataSetSummaries": { - "target": "com.amazonaws.quicksight#DataSetSummaryList", - "traits": { - "smithy.api#documentation": "

A DataSetSummaries object that returns a summary of a dataset.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#SearchDataSources": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#SearchDataSourcesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#SearchDataSourcesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Use the SearchDataSources operation to search for data sources that belong to an account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/search/data-sources", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "DataSourceSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#SearchDataSourcesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.quicksight#DataSourceSearchFilterList", - "traits": { - "smithy.api#documentation": "

The filters to apply to the search.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#SearchDataSourcesResponse": { - "type": "structure", - "members": { - "DataSourceSummaries": { - "target": "com.amazonaws.quicksight#DataSourceSummaryList", - "traits": { - "smithy.api#documentation": "

A DataSourceSummaries object that returns a summary of a data source.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#SearchFolders": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#SearchFoldersRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#SearchFoldersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#InvalidRequestException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Searches the subfolders in a folder.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/search/folders", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "FolderSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#SearchFoldersRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.quicksight#FolderSearchFilterList", - "traits": { - "smithy.api#documentation": "

The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, \"Filters\": [ { \"Name\": \"PARENT_FOLDER_ARN\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:folder/folderId\" } ].

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#SearchFoldersResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "FolderSummaryList": { - "target": "com.amazonaws.quicksight#FolderSummaryList", - "traits": { - "smithy.api#documentation": "

A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#SearchGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#SearchGroupsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#SearchGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups-search", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "GroupList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#SearchGroupsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n Amazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return from this request.

", - "smithy.api#httpQuery": "max-results" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that you want to search.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.quicksight#GroupSearchFilterList", - "traits": { - "smithy.api#documentation": "

The structure for the search filters that you want to apply to your search.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#SearchGroupsResponse": { - "type": "structure", - "members": { - "GroupList": { - "target": "com.amazonaws.quicksight#GroupList", - "traits": { - "smithy.api#documentation": "

A list of groups in a specified namespace that match the filters you set in your SearchGroups request.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#Seasonality": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 180 - } - } - }, - "com.amazonaws.quicksight#SecondaryValueOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines the visibility of the secondary value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the secondary value of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#SecretArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:[-a-z0-9]*:secretsmanager:[-a-z0-9]*:[0-9]{12}:secret:.+$" - } - }, - "com.amazonaws.quicksight#SectionAfterPageBreak": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#SectionPageBreakStatus", - "traits": { - "smithy.api#documentation": "

The option that enables or disables a page break at the end of a section.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a page break after a section.

" - } - }, - "com.amazonaws.quicksight#SectionBasedLayoutCanvasSizeOptions": { - "type": "structure", - "members": { - "PaperCanvasSizeOptions": { - "target": "com.amazonaws.quicksight#SectionBasedLayoutPaperCanvasSizeOptions", - "traits": { - "smithy.api#documentation": "

The options for a paper canvas of a section-based layout.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options for the canvas of a section-based layout.

" - } - }, - "com.amazonaws.quicksight#SectionBasedLayoutConfiguration": { - "type": "structure", - "members": { - "HeaderSections": { - "target": "com.amazonaws.quicksight#HeaderFooterSectionConfigurationList", - "traits": { - "smithy.api#documentation": "

A list of header section configurations.

", - "smithy.api#required": {} - } - }, - "BodySections": { - "target": "com.amazonaws.quicksight#BodySectionConfigurationList", - "traits": { - "smithy.api#documentation": "

A list of body section configurations.

", - "smithy.api#required": {} - } - }, - "FooterSections": { - "target": "com.amazonaws.quicksight#HeaderFooterSectionConfigurationList", - "traits": { - "smithy.api#documentation": "

A list of footer section configurations.

", - "smithy.api#required": {} - } - }, - "CanvasSizeOptions": { - "target": "com.amazonaws.quicksight#SectionBasedLayoutCanvasSizeOptions", - "traits": { - "smithy.api#documentation": "

The options for the canvas of a section-based layout.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for a\n section-based layout.

" - } - }, - "com.amazonaws.quicksight#SectionBasedLayoutPaperCanvasSizeOptions": { - "type": "structure", - "members": { - "PaperSize": { - "target": "com.amazonaws.quicksight#PaperSize", - "traits": { - "smithy.api#documentation": "

The paper size that is used to define canvas dimensions.

" - } - }, - "PaperOrientation": { - "target": "com.amazonaws.quicksight#PaperOrientation", - "traits": { - "smithy.api#documentation": "

The paper orientation that\n is used to define canvas dimensions. Choose one of the following\n options:

\n " - } - }, - "PaperMargin": { - "target": "com.amazonaws.quicksight#Spacing", - "traits": { - "smithy.api#documentation": "

Defines the spacing between the canvas content and the top, bottom, left, and right edges.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options for a paper canvas of a section-based layout.

" - } - }, - "com.amazonaws.quicksight#SectionLayoutConfiguration": { - "type": "structure", - "members": { - "FreeFormLayout": { - "target": "com.amazonaws.quicksight#FreeFormSectionLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

The free-form layout configuration of a section.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The layout configuration of a section.

" - } - }, - "com.amazonaws.quicksight#SectionPageBreakConfiguration": { - "type": "structure", - "members": { - "After": { - "target": "com.amazonaws.quicksight#SectionAfterPageBreak", - "traits": { - "smithy.api#documentation": "

The configuration of a page break after a section.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a page break for a section.

" - } - }, - "com.amazonaws.quicksight#SectionPageBreakStatus": { - "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.quicksight#SectionStyle": { - "type": "structure", - "members": { - "Height": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The height of a section.

\n

Heights can only be defined for header and footer sections. The default height margin is 0.5 inches.

" - } - }, - "Padding": { - "target": "com.amazonaws.quicksight#Spacing", - "traits": { - "smithy.api#documentation": "

The spacing between section content and its top, bottom, left, and right edges.

\n

There is no padding by default.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that style a section.

" - } - }, - "com.amazonaws.quicksight#SecurityGroupId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^sg-[0-9a-z]*$" - } - }, - "com.amazonaws.quicksight#SecurityGroupIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SecurityGroupId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16 - } - } - }, - "com.amazonaws.quicksight#SelectAllValueOptions": { - "type": "enum", - "members": { - "ALL_VALUES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL_VALUES" - } - } - } - }, - "com.amazonaws.quicksight#SelectedFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FieldId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#SelectedFieldOptions": { - "type": "enum", - "members": { - "ALL_FIELDS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL_FIELDS" - } - } - } - }, - "com.amazonaws.quicksight#SelectedSheetsFilterScopeConfiguration": { - "type": "structure", - "members": { - "SheetVisualScopingConfigurations": { - "target": "com.amazonaws.quicksight#SheetVisualScopingConfigurations", - "traits": { - "smithy.api#documentation": "

The sheet ID and visual IDs of the sheet and visuals that the filter is applied to.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for applying a filter to specific sheets or visuals. You can apply this filter to multiple visuals that are on one sheet or to all visuals on a sheet.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#SelectedTooltipType": { - "type": "enum", - "members": { - "BASIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BASIC" - } - }, - "DETAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DETAILED" - } - } - } - }, - "com.amazonaws.quicksight#SemanticEntityType": { - "type": "structure", - "members": { - "TypeName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The semantic entity type name.

" - } - }, - "SubTypeName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The semantic entity sub type name.

" - } - }, - "TypeParameters": { - "target": "com.amazonaws.quicksight#TypeParameters", - "traits": { - "smithy.api#documentation": "

The semantic entity type parameters.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a semantic entity type.

" - } - }, - "com.amazonaws.quicksight#SemanticType": { - "type": "structure", - "members": { - "TypeName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The semantic type name.

" - } - }, - "SubTypeName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The semantic type sub type name.

" - } - }, - "TypeParameters": { - "target": "com.amazonaws.quicksight#TypeParameters", - "traits": { - "smithy.api#documentation": "

The semantic type parameters.

" - } - }, - "TruthyCellValue": { - "target": "com.amazonaws.quicksight#SensitiveString", - "traits": { - "smithy.api#documentation": "

The semantic type truthy cell value.

" - } - }, - "TruthyCellValueSynonyms": { - "target": "com.amazonaws.quicksight#SensitiveStringList", - "traits": { - "smithy.api#documentation": "

The other names or aliases for the true cell value.

" - } - }, - "FalseyCellValue": { - "target": "com.amazonaws.quicksight#SensitiveString", - "traits": { - "smithy.api#documentation": "

The semantic type falsey cell value.

" - } - }, - "FalseyCellValueSynonyms": { - "target": "com.amazonaws.quicksight#SensitiveStringList", - "traits": { - "smithy.api#documentation": "

The other names or aliases for the false cell value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a semantic type.

" - } - }, - "com.amazonaws.quicksight#SensitiveDouble": { - "type": "double", - "traits": { - "smithy.api#default": 0, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#SensitiveDoubleList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SensitiveDouble" - } - }, - "com.amazonaws.quicksight#SensitiveDoubleObject": { - "type": "double", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#SensitiveLong": { - "type": "long", - "traits": { - "smithy.api#default": 0, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#SensitiveLongList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SensitiveLong" - } - }, - "com.amazonaws.quicksight#SensitiveLongObject": { - "type": "long", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#SensitiveS3Uri": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(https|s3)://([^/]+)/?(.*)$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#SensitiveString": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#SensitiveStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SensitiveString" - } - }, - "com.amazonaws.quicksight#SensitiveStringObject": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#SensitiveTimestamp": { - "type": "timestamp", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#SensitiveTimestampList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SensitiveTimestamp" - } - }, - "com.amazonaws.quicksight#SeriesItem": { - "type": "structure", - "members": { - "FieldSeriesItem": { - "target": "com.amazonaws.quicksight#FieldSeriesItem", - "traits": { - "smithy.api#documentation": "

The field series item configuration of a line chart.

" - } - }, - "DataFieldSeriesItem": { - "target": "com.amazonaws.quicksight#DataFieldSeriesItem", - "traits": { - "smithy.api#documentation": "

The data field series item configuration of a line chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The series item configuration of a line chart.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#SeriesItemList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SeriesItem" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2000 - } - } - }, - "com.amazonaws.quicksight#ServiceNowParameters": { - "type": "structure", - "members": { - "SiteBaseUrl": { - "target": "com.amazonaws.quicksight#SiteBaseUrl", - "traits": { - "smithy.api#documentation": "

URL of the base site.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for ServiceNow.

" - } - }, - "com.amazonaws.quicksight#ServiceType": { - "type": "enum", - "members": { - "REDSHIFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REDSHIFT" - } - } - } - }, - "com.amazonaws.quicksight#SessionLifetimeInMinutes": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 15, - "max": 600 - } - } - }, - "com.amazonaws.quicksight#SessionLifetimeInMinutesInvalidException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The number of minutes specified for the lifetime of a session isn't valid. The session\n\t\t\tlifetime must be 15-600 minutes.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.quicksight#SessionTag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.quicksight#SessionTagKey", - "traits": { - "smithy.api#documentation": "

The key for the tag.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.quicksight#SessionTagValue", - "traits": { - "smithy.api#documentation": "

The value that you want to assign the tag.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The key-value pair used for the row-level security tags feature.

" - } - }, - "com.amazonaws.quicksight#SessionTagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.quicksight#SessionTagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SessionTagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#SessionTagList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SessionTag" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#SessionTagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#SetParameterValueConfiguration": { - "type": "structure", - "members": { - "DestinationParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The destination parameter name of the SetParameterValueConfiguration.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.quicksight#DestinationParameterValueConfiguration", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of adding parameters in action.

" - } - }, - "com.amazonaws.quicksight#SetParameterValueConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SetParameterValueConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#ShapeConditionalFormat": { - "type": "structure", - "members": { - "BackgroundColor": { - "target": "com.amazonaws.quicksight#ConditionalFormattingColor", - "traits": { - "smithy.api#documentation": "

The conditional formatting for the shape background color of a filled map visual.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The shape conditional formatting of a filled map visual.

" - } - }, - "com.amazonaws.quicksight#SharingModel": { - "type": "enum", - "members": { - "ACCOUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCOUNT" - } - }, - "NAMESPACE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NAMESPACE" - } - } - } - }, - "com.amazonaws.quicksight#Sheet": { - "type": "structure", - "members": { - "SheetId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier associated with a sheet.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#SheetName", - "traits": { - "smithy.api#documentation": "

The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A sheet, which is an object that contains a set of visuals that\n are viewed together on one page in Amazon QuickSight. Every analysis and dashboard\n contains at least one sheet. Each sheet contains at least one visualization widget, for\n example a chart, pivot table, or narrative insight. Sheets can be associated with other\n components, such as controls, filters, and so on.

" - } - }, - "com.amazonaws.quicksight#SheetContentType": { - "type": "enum", - "members": { - "PAGINATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PAGINATED" - } - }, - "INTERACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERACTIVE" - } - } - } - }, - "com.amazonaws.quicksight#SheetControlDateTimePickerType": { - "type": "enum", - "members": { - "SINGLE_VALUED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SINGLE_VALUED" - } - }, - "DATE_RANGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATE_RANGE" - } - } - } - }, - "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility configuration of info icon label options.

" - } - }, - "InfoIconText": { - "target": "com.amazonaws.quicksight#SheetControlInfoIconText", - "traits": { - "smithy.api#documentation": "

The text content of info icon.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control to display info icons for filters and parameters.

" - } - }, - "com.amazonaws.quicksight#SheetControlInfoIconText": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#SheetControlLayout": { - "type": "structure", - "members": { - "Configuration": { - "target": "com.amazonaws.quicksight#SheetControlLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration that determines the elements and canvas size options of sheet control.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A grid layout to define the placement of sheet control.

" - } - }, - "com.amazonaws.quicksight#SheetControlLayoutConfiguration": { - "type": "structure", - "members": { - "GridLayout": { - "target": "com.amazonaws.quicksight#GridLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration that determines the elements and canvas size options of sheet control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration that determines the elements and canvas size options of sheet control.

" - } - }, - "com.amazonaws.quicksight#SheetControlLayoutList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SheetControlLayout" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#SheetControlListType": { - "type": "enum", - "members": { - "MULTI_SELECT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MULTI_SELECT" - } - }, - "SINGLE_SELECT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SINGLE_SELECT" - } - } - } - }, - "com.amazonaws.quicksight#SheetControlSliderType": { - "type": "enum", - "members": { - "SINGLE_POINT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SINGLE_POINT" - } - }, - "RANGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RANGE" - } - } - } - }, - "com.amazonaws.quicksight#SheetControlTitle": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#SheetControlsOption": { - "type": "structure", - "members": { - "VisibilityState": { - "target": "com.amazonaws.quicksight#DashboardUIState", - "traits": { - "smithy.api#documentation": "

Visibility state.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Sheet controls option.

" - } - }, - "com.amazonaws.quicksight#SheetDefinition": { - "type": "structure", - "members": { - "SheetId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a sheet.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetTitle", - "traits": { - "smithy.api#documentation": "

The title of the sheet.

" - } - }, - "Description": { - "target": "com.amazonaws.quicksight#SheetDescription", - "traits": { - "smithy.api#documentation": "

A description of the sheet.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#SheetName", - "traits": { - "smithy.api#documentation": "

The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.

" - } - }, - "ParameterControls": { - "target": "com.amazonaws.quicksight#ParameterControlList", - "traits": { - "smithy.api#documentation": "

The list of parameter controls that are on a sheet.

\n

For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.

" - } - }, - "FilterControls": { - "target": "com.amazonaws.quicksight#FilterControlList", - "traits": { - "smithy.api#documentation": "

The list of filter controls that are on a sheet.

\n

For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide.

" - } - }, - "Visuals": { - "target": "com.amazonaws.quicksight#VisualList", - "traits": { - "smithy.api#documentation": "

A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

" - } - }, - "TextBoxes": { - "target": "com.amazonaws.quicksight#SheetTextBoxList", - "traits": { - "smithy.api#documentation": "

The text boxes that are on a sheet.

" - } - }, - "Layouts": { - "target": "com.amazonaws.quicksight#LayoutList", - "traits": { - "smithy.api#documentation": "

Layouts define how the components of a sheet are arranged.

\n

For more information, see Types of layout in the Amazon QuickSight User Guide.

" - } - }, - "SheetControlLayouts": { - "target": "com.amazonaws.quicksight#SheetControlLayoutList", - "traits": { - "smithy.api#documentation": "

The control layouts of the sheet.

" - } - }, - "ContentType": { - "target": "com.amazonaws.quicksight#SheetContentType", - "traits": { - "smithy.api#documentation": "

The layout content type of the sheet. Choose one of the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

A sheet is an object that contains a set of visuals that\n are viewed together on one page in a paginated report. Every analysis and dashboard must contain at least one sheet.

" - } - }, - "com.amazonaws.quicksight#SheetDefinitionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SheetDefinition" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#SheetDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.quicksight#SheetElementConfigurationOverrides": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines whether or not the overrides are visible. Choose one of the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The override configuration of the rendering rules of a sheet.

" - } - }, - "com.amazonaws.quicksight#SheetElementRenderingRule": { - "type": "structure", - "members": { - "Expression": { - "target": "com.amazonaws.quicksight#Expression", - "traits": { - "smithy.api#documentation": "

The expression of the rendering rules of a sheet.

", - "smithy.api#required": {} - } - }, - "ConfigurationOverrides": { - "target": "com.amazonaws.quicksight#SheetElementConfigurationOverrides", - "traits": { - "smithy.api#documentation": "

The override configuration of the rendering rules of a sheet.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The rendering rules of a sheet that uses a free-form layout.

" - } - }, - "com.amazonaws.quicksight#SheetElementRenderingRuleList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SheetElementRenderingRule" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - } - } - }, - "com.amazonaws.quicksight#SheetLayoutElementMaximizationOption": { - "type": "structure", - "members": { - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#DashboardBehavior", - "traits": { - "smithy.api#documentation": "

The status of the sheet layout maximization options of a dashbaord.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sheet layout maximization options of a dashbaord.

" - } - }, - "com.amazonaws.quicksight#SheetList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Sheet" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#SheetName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#SheetStyle": { - "type": "structure", - "members": { - "Tile": { - "target": "com.amazonaws.quicksight#TileStyle", - "traits": { - "smithy.api#documentation": "

The display options for tiles.

" - } - }, - "TileLayout": { - "target": "com.amazonaws.quicksight#TileLayoutStyle", - "traits": { - "smithy.api#documentation": "

The layout options for tiles.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The theme display options for sheets.

" - } - }, - "com.amazonaws.quicksight#SheetTextBox": { - "type": "structure", - "members": { - "SheetTextBoxId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier for a text box. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have text boxes that share identifiers.

", - "smithy.api#required": {} - } - }, - "Content": { - "target": "com.amazonaws.quicksight#SheetTextBoxContent", - "traits": { - "smithy.api#documentation": "

The content that is displayed in the text box.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A text box.

" - } - }, - "com.amazonaws.quicksight#SheetTextBoxContent": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 150000 - } - } - }, - "com.amazonaws.quicksight#SheetTextBoxList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SheetTextBox" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#SheetTitle": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.quicksight#SheetVisualScopingConfiguration": { - "type": "structure", - "members": { - "SheetId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The selected sheet that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.quicksight#FilterVisualScope", - "traits": { - "smithy.api#documentation": "

The scope of the applied entities. Choose one of the following options:

\n ", - "smithy.api#required": {} - } - }, - "VisualIds": { - "target": "com.amazonaws.quicksight#FilteredVisualsList", - "traits": { - "smithy.api#documentation": "

The selected visuals that the filter is applied to.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The filter that is applied to the options.

" - } - }, - "com.amazonaws.quicksight#SheetVisualScopingConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SheetVisualScopingConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#ShortFormatText": { - "type": "structure", - "members": { - "PlainText": { - "target": "com.amazonaws.quicksight#ShortPlainText", - "traits": { - "smithy.api#documentation": "

Plain text format.

" - } - }, - "RichText": { - "target": "com.amazonaws.quicksight#ShortRichText", - "traits": { - "smithy.api#documentation": "

Rich text. Examples of rich text include bold, underline, and italics.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The text format for the title.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#ShortPlainText": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.quicksight#ShortRestrictiveResourceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - }, - "smithy.api#pattern": "^[\\w\\-]+$" - } - }, - "com.amazonaws.quicksight#ShortRichText": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.quicksight#SignupResponse": { - "type": "structure", - "members": { - "IAMUser": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean that is TRUE if the Amazon QuickSight uses IAM as an\n authentication method.

" - } - }, - "userLoginName": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The user login name for your Amazon QuickSight account.

" - } - }, - "accountName": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of your Amazon QuickSight account.

" - } - }, - "directoryType": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The type of Active Directory that is being used to authenticate the Amazon QuickSight\n account. Valid values are SIMPLE_AD, AD_CONNECTOR, and\n MICROSOFT_AD.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A SignupResponse object that contains a summary of a newly created account.

" - } - }, - "com.amazonaws.quicksight#SimpleAttributeAggregationFunction": { - "type": "enum", - "members": { - "UNIQUE_VALUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNIQUE_VALUE" - } - } - } - }, - "com.amazonaws.quicksight#SimpleClusterMarker": { - "type": "structure", - "members": { - "Color": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color of the simple cluster marker.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The simple cluster marker of the cluster marker.

" - } - }, - "com.amazonaws.quicksight#SimpleNumericalAggregationFunction": { - "type": "enum", - "members": { - "SUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUM" - } - }, - "AVERAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVERAGE" - } - }, - "MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MIN" - } - }, - "MAX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX" - } - }, - "COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNT" - } - }, - "DISTINCT_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISTINCT_COUNT" - } - }, - "VAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VAR" - } - }, - "VARP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VARP" - } - }, - "STDEV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEV" - } - }, - "STDEVP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEVP" - } - }, - "MEDIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIAN" - } - } - } - }, - "com.amazonaws.quicksight#SimpleTotalAggregationFunction": { - "type": "enum", - "members": { - "DEFAULT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEFAULT" - } - }, - "SUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUM" - } - }, - "AVERAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVERAGE" - } - }, - "MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MIN" - } - }, - "MAX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX" - } - }, - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - } - } - }, - "com.amazonaws.quicksight#SingleAxisOptions": { - "type": "structure", - "members": { - "YAxisOptions": { - "target": "com.amazonaws.quicksight#YAxisOptions", - "traits": { - "smithy.api#documentation": "

The Y axis options of a single axis configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The settings of a chart's single axis configuration.

" - } - }, - "com.amazonaws.quicksight#SingleYAxisOption": { - "type": "enum", - "members": { - "PRIMARY_Y_AXIS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRIMARY_Y_AXIS" - } - } - } - }, - "com.amazonaws.quicksight#SiteBaseUrl": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.quicksight#SliderControlDisplayOptions": { - "type": "structure", - "members": { - "TitleOptions": { - "target": "com.amazonaws.quicksight#LabelOptions", - "traits": { - "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" - } - }, - "InfoIconLabelOptions": { - "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", - "traits": { - "smithy.api#documentation": "

The configuration of info icon label options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "com.amazonaws.quicksight#Slot": { - "type": "structure", - "members": { - "SlotId": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The slot ID of the slot.

" - } - }, - "VisualId": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The visual ID for the slot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for the slot.

" - } - }, - "com.amazonaws.quicksight#Slots": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Slot" - } - }, - "com.amazonaws.quicksight#SmallMultiplesAxisPlacement": { - "type": "enum", - "members": { - "OUTSIDE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OUTSIDE" - } - }, - "INSIDE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSIDE" - } - } - } - }, - "com.amazonaws.quicksight#SmallMultiplesAxisProperties": { - "type": "structure", - "members": { - "Scale": { - "target": "com.amazonaws.quicksight#SmallMultiplesAxisScale", - "traits": { - "smithy.api#documentation": "

Determines whether scale of the axes are shared or independent. The default value is SHARED.

" - } - }, - "Placement": { - "target": "com.amazonaws.quicksight#SmallMultiplesAxisPlacement", - "traits": { - "smithy.api#documentation": "

Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configures the properties of a chart's axes that are used by small multiples panels.

" - } - }, - "com.amazonaws.quicksight#SmallMultiplesAxisScale": { - "type": "enum", - "members": { - "SHARED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SHARED" - } - }, - "INDEPENDENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INDEPENDENT" - } - } - } - }, - "com.amazonaws.quicksight#SmallMultiplesDimensionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DimensionField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#SmallMultiplesOptions": { - "type": "structure", - "members": { - "MaxVisibleRows": { - "target": "com.amazonaws.quicksight#VisiblePanelRows", - "traits": { - "smithy.api#documentation": "

Sets the maximum number of visible rows to display in the grid of small multiples panels.

\n

The default value is Auto,\n which automatically adjusts the rows in the grid\n to fit the overall layout and size of the given chart.

" - } - }, - "MaxVisibleColumns": { - "target": "com.amazonaws.quicksight#VisiblePanelColumns", - "traits": { - "smithy.api#documentation": "

Sets the maximum number of visible columns to display in the grid of small multiples panels.

\n

The default is Auto, which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.

" - } - }, - "PanelConfiguration": { - "target": "com.amazonaws.quicksight#PanelConfiguration", - "traits": { - "smithy.api#documentation": "

Configures the display options for each small multiples panel.

" - } - }, - "XAxis": { - "target": "com.amazonaws.quicksight#SmallMultiplesAxisProperties", - "traits": { - "smithy.api#documentation": "

The properties of a small multiples X axis.

" - } - }, - "YAxis": { - "target": "com.amazonaws.quicksight#SmallMultiplesAxisProperties", - "traits": { - "smithy.api#documentation": "

The properties of a small multiples Y axis.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Options that determine the layout and display options of a chart's small multiples.

" - } - }, - "com.amazonaws.quicksight#SnapshotAnonymousUser": { - "type": "structure", - "members": { - "RowLevelPermissionTags": { - "target": "com.amazonaws.quicksight#SessionTagList", - "traits": { - "smithy.api#documentation": "

The tags to be used for row-level security (RLS). Make sure that the relevant datasets have RLS tags configured before you start a snapshot export job. You can configure the RLS tags of a dataset with a DataSet$RowLevelPermissionTagConfiguration API call.

\n

These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in Amazon QuickSight, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains information on the anonymous user configuration.

" - } - }, - "com.amazonaws.quicksight#SnapshotAnonymousUserList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SnapshotAnonymousUser" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#SnapshotAnonymousUserRedacted": { - "type": "structure", - "members": { - "RowLevelPermissionTagKeys": { - "target": "com.amazonaws.quicksight#SessionTagKeyList", - "traits": { - "smithy.api#documentation": "

The tag keys for the RowLevelPermissionTags.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Use this structure to redact sensitive information that you provide about an anonymous user from the snapshot.

" - } - }, - "com.amazonaws.quicksight#SnapshotAnonymousUserRedactedList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SnapshotAnonymousUserRedacted" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#SnapshotConfiguration": { - "type": "structure", - "members": { - "FileGroups": { - "target": "com.amazonaws.quicksight#SnapshotFileGroupList", - "traits": { - "smithy.api#documentation": "

A list of SnapshotJobResultFileGroup objects that contain information about the snapshot that is generated. This list can hold a maximum of 6 FileGroup configurations.

", - "smithy.api#required": {} - } - }, - "DestinationConfiguration": { - "target": "com.amazonaws.quicksight#SnapshotDestinationConfiguration", - "traits": { - "smithy.api#documentation": "

A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in.

" - } - }, - "Parameters": { - "target": "com.amazonaws.quicksight#Parameters" - } - }, - "traits": { - "smithy.api#documentation": "

Describes the configuration of the dashboard snapshot.

" - } - }, - "com.amazonaws.quicksight#SnapshotDestinationConfiguration": { - "type": "structure", - "members": { - "S3Destinations": { - "target": "com.amazonaws.quicksight#SnapshotS3DestinationConfigurationList", - "traits": { - "smithy.api#documentation": "

\n A list of SnapshotS3DestinationConfiguration objects that contain Amazon S3 destination configurations. This structure can hold a maximum of 1 S3DestinationConfiguration.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains information on the Amazon S3 destinations of the generated snapshot.

" - } - }, - "com.amazonaws.quicksight#SnapshotFile": { - "type": "structure", - "members": { - "SheetSelections": { - "target": "com.amazonaws.quicksight#SnapshotFileSheetSelectionList", - "traits": { - "smithy.api#documentation": "

A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF.

", - "smithy.api#required": {} - } - }, - "FormatType": { - "target": "com.amazonaws.quicksight#SnapshotFileFormatType", - "traits": { - "smithy.api#documentation": "

The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job.

" - } - }, - "com.amazonaws.quicksight#SnapshotFileFormatType": { - "type": "enum", - "members": { - "CSV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CSV" - } - }, - "PDF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PDF" - } - }, - "EXCEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXCEL" - } - } - } - }, - "com.amazonaws.quicksight#SnapshotFileGroup": { - "type": "structure", - "members": { - "Files": { - "target": "com.amazonaws.quicksight#SnapshotFileList", - "traits": { - "smithy.api#documentation": "

A list of SnapshotFile objects that contain the information on the snapshot files that need to be generated. This structure can hold 1 configuration at a time.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains the information on the snapshot files.

" - } - }, - "com.amazonaws.quicksight#SnapshotFileGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SnapshotFileGroup" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 7 - } - } - }, - "com.amazonaws.quicksight#SnapshotFileList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SnapshotFile" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#SnapshotFileSheetSelection": { - "type": "structure", - "members": { - "SheetId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.

", - "smithy.api#required": {} - } - }, - "SelectionScope": { - "target": "com.amazonaws.quicksight#SnapshotFileSheetSelectionScope", - "traits": { - "smithy.api#documentation": "

The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.

\n ", - "smithy.api#required": {} - } - }, - "VisualIds": { - "target": "com.amazonaws.quicksight#SnapshotFileSheetSelectionVisualIdList", - "traits": { - "smithy.api#documentation": "

\n A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains information that identifies the snapshot that needs to be generated.

" - } - }, - "com.amazonaws.quicksight#SnapshotFileSheetSelectionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SnapshotFileSheetSelection" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.quicksight#SnapshotFileSheetSelectionScope": { - "type": "enum", - "members": { - "ALL_VISUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL_VISUALS" - } - }, - "SELECTED_VISUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SELECTED_VISUALS" - } - } - } - }, - "com.amazonaws.quicksight#SnapshotFileSheetSelectionVisualIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.quicksight#SnapshotJobErrorInfo": { - "type": "structure", - "members": { - "ErrorMessage": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The error message.

" - } - }, - "ErrorType": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The error type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains information on the error that caused the snapshot job to fail.

" - } - }, - "com.amazonaws.quicksight#SnapshotJobResult": { - "type": "structure", - "members": { - "AnonymousUsers": { - "target": "com.amazonaws.quicksight#AnonymousUserSnapshotJobResultList", - "traits": { - "smithy.api#documentation": "

A list of AnonymousUserSnapshotJobResult objects that contain information on anonymous users and their user configurations. This data provided by you when you make a StartDashboardSnapshotJob API call.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that provides information on the result of a snapshot job. This object provides information about the job, the job status, and the location of the generated file.

" - } - }, - "com.amazonaws.quicksight#SnapshotJobResultErrorInfo": { - "type": "structure", - "members": { - "ErrorMessage": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The error message.

" - } - }, - "ErrorType": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The error type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information on the error that caused the snapshot job to fail.

" - } - }, - "com.amazonaws.quicksight#SnapshotJobResultErrorInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SnapshotJobResultErrorInfo" - } - }, - "com.amazonaws.quicksight#SnapshotJobResultFileGroup": { - "type": "structure", - "members": { - "Files": { - "target": "com.amazonaws.quicksight#SnapshotFileList", - "traits": { - "smithy.api#documentation": "

A list of SnapshotFile objects.

" - } - }, - "S3Results": { - "target": "com.amazonaws.quicksight#SnapshotJobS3ResultList", - "traits": { - "smithy.api#documentation": "

A list of SnapshotJobS3Result objects.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains information on the generated snapshot file groups.

" - } - }, - "com.amazonaws.quicksight#SnapshotJobResultFileGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SnapshotJobResultFileGroup" - } - }, - "com.amazonaws.quicksight#SnapshotJobS3Result": { - "type": "structure", - "members": { - "S3DestinationConfiguration": { - "target": "com.amazonaws.quicksight#SnapshotS3DestinationConfiguration", - "traits": { - "smithy.api#documentation": "

A list of Amazon S3 bucket configurations that are provided when you make a StartDashboardSnapshotJob API call.\n

" - } - }, - "S3Uri": { - "target": "com.amazonaws.quicksight#SensitiveS3Uri", - "traits": { - "smithy.api#documentation": "

The Amazon S3 Uri.

" - } - }, - "ErrorInfo": { - "target": "com.amazonaws.quicksight#SnapshotJobResultErrorInfoList", - "traits": { - "smithy.api#documentation": "

An array of error records that describe any failures that occur while the dashboard snapshot job runs.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Amazon S3 result from the snapshot job. The result includes the DestinationConfiguration and the Amazon S3 Uri. If an error occured during the job, the result returns information on the error.

" - } - }, - "com.amazonaws.quicksight#SnapshotJobS3ResultList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SnapshotJobS3Result" - } - }, - "com.amazonaws.quicksight#SnapshotJobStatus": { - "type": "enum", - "members": { - "QUEUED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUEUED" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.quicksight#SnapshotS3DestinationConfiguration": { - "type": "structure", - "members": { - "BucketConfiguration": { - "target": "com.amazonaws.quicksight#S3BucketConfiguration", - "traits": { - "smithy.api#documentation": "

A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that describes the Amazon S3 settings to use to save the generated dashboard snapshot.

" - } - }, - "com.amazonaws.quicksight#SnapshotS3DestinationConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SnapshotS3DestinationConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#SnapshotUserConfiguration": { - "type": "structure", - "members": { - "AnonymousUsers": { - "target": "com.amazonaws.quicksight#SnapshotAnonymousUserList", - "traits": { - "smithy.api#documentation": "

An array of records that describe the anonymous users that the dashboard snapshot is generated for.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains information about the users that the dashboard snapshot is generated for.

" - } - }, - "com.amazonaws.quicksight#SnapshotUserConfigurationRedacted": { - "type": "structure", - "members": { - "AnonymousUsers": { - "target": "com.amazonaws.quicksight#SnapshotAnonymousUserRedactedList", - "traits": { - "smithy.api#documentation": "

\n An array of records that describe anonymous users that the dashboard snapshot is generated for. Sensitive user information is excluded.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains information about the users that the dashboard snapshot is generated for. Sensitive user information is excluded.\n

" - } - }, - "com.amazonaws.quicksight#SnowflakeParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

Host.

", - "smithy.api#required": {} - } - }, - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

Database.

", - "smithy.api#required": {} - } - }, - "Warehouse": { - "target": "com.amazonaws.quicksight#Warehouse", - "traits": { - "smithy.api#documentation": "

Warehouse.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for Snowflake.

" - } - }, - "com.amazonaws.quicksight#SortDirection": { - "type": "enum", - "members": { - "ASC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASC" - } - }, - "DESC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DESC" - } - } - } - }, - "com.amazonaws.quicksight#Spacing": { - "type": "structure", - "members": { - "Top": { - "target": "com.amazonaws.quicksight#Length", - "traits": { - "smithy.api#documentation": "

Define the top spacing.

" - } - }, - "Bottom": { - "target": "com.amazonaws.quicksight#Length", - "traits": { - "smithy.api#documentation": "

Define the bottom spacing.

" - } - }, - "Left": { - "target": "com.amazonaws.quicksight#Length", - "traits": { - "smithy.api#documentation": "

Define the left spacing.

" - } - }, - "Right": { - "target": "com.amazonaws.quicksight#Length", - "traits": { - "smithy.api#documentation": "

Define the right spacing.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of spacing (often a margin or padding).

" - } - }, - "com.amazonaws.quicksight#SparkParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

Host.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

Port.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for Spark.

" - } - }, - "com.amazonaws.quicksight#SpecialValue": { - "type": "enum", - "members": { - "EMPTY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EMPTY" - } - }, - "NULL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NULL" - } - }, - "OTHER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OTHER" - } - } - } - }, - "com.amazonaws.quicksight#SqlEndpointPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 4096 - } - } - }, - "com.amazonaws.quicksight#SqlQuery": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 168000 - } - } - }, - "com.amazonaws.quicksight#SqlServerParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

Host.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

Port.

", - "smithy.api#required": {} - } - }, - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

Database.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for SQL Server.

" - } - }, - "com.amazonaws.quicksight#SslProperties": { - "type": "structure", - "members": { - "DisableSsl": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean option to control whether SSL should be disabled.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your\n underlying data source.

" - } - }, - "com.amazonaws.quicksight#StarburstParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

The host name of the Starburst data source.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

The port for the Starburst data source.

", - "smithy.api#required": {} - } - }, - "Catalog": { - "target": "com.amazonaws.quicksight#Catalog", - "traits": { - "smithy.api#documentation": "

The catalog name for the Starburst data source.

", - "smithy.api#required": {} - } - }, - "ProductType": { - "target": "com.amazonaws.quicksight#StarburstProductType", - "traits": { - "smithy.api#documentation": "

The product type for the Starburst data source.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters that are required to connect to a Starburst data source.

" - } - }, - "com.amazonaws.quicksight#StarburstProductType": { - "type": "enum", - "members": { - "GALAXY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GALAXY" - } - }, - "ENTERPRISE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENTERPRISE" - } - } - } - }, - "com.amazonaws.quicksight#StartAssetBundleExportJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#StartAssetBundleExportJobRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#StartAssetBundleExportJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts an Asset Bundle export job.

\n

An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 5 export jobs concurrently.

\n

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/asset-bundle-export-jobs/export", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#StartAssetBundleExportJobRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account to export assets from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssetBundleExportJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

", - "smithy.api#required": {} - } - }, - "ResourceArns": { - "target": "com.amazonaws.quicksight#AssetBundleResourceArns", - "traits": { - "smithy.api#documentation": "

An array of resource ARNs to export. The following resources are supported.

\n \n

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

", - "smithy.api#required": {} - } - }, - "IncludeAllDependencies": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean that determines whether all dependencies of each resource ARN are recursively\n exported with the job. For example, say you provided a Dashboard ARN to the\n ResourceArns parameter. If you set IncludeAllDependencies to\n TRUE, any theme, dataset, and data source resource that is a dependency of the dashboard is also\n exported.

" - } - }, - "ExportFormat": { - "target": "com.amazonaws.quicksight#AssetBundleExportFormat", - "traits": { - "smithy.api#documentation": "

The export data format.

", - "smithy.api#required": {} - } - }, - "CloudFormationOverridePropertyConfiguration": { - "target": "com.amazonaws.quicksight#AssetBundleCloudFormationOverridePropertyConfiguration", - "traits": { - "smithy.api#documentation": "

An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.

\n

Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON.

" - } - }, - "IncludePermissions": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.\n

" - } - }, - "IncludeTags": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.

" - } - }, - "ValidationStrategy": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobValidationStrategy", - "traits": { - "smithy.api#documentation": "

An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#StartAssetBundleExportJobResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the export job.

" - } - }, - "AssetBundleExportJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services response ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the response.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#StartAssetBundleImportJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#StartAssetBundleImportJobRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#StartAssetBundleImportJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts an Asset Bundle import job.

\n

An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently.

\n

The API caller must have the necessary \"create\", \"describe\", and \"update\" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/asset-bundle-import-jobs/import", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#StartAssetBundleImportJobRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account to import assets into.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssetBundleImportJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

", - "smithy.api#required": {} - } - }, - "AssetBundleImportSource": { - "target": "com.amazonaws.quicksight#AssetBundleImportSource", - "traits": { - "smithy.api#documentation": "

The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.\n

", - "smithy.api#required": {} - } - }, - "OverrideParameters": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideParameters", - "traits": { - "smithy.api#documentation": "

Optional overrides that are applied to the resource configuration before import.

" - } - }, - "FailureAction": { - "target": "com.amazonaws.quicksight#AssetBundleImportFailureAction", - "traits": { - "smithy.api#documentation": "

The failure action for the import job.

\n

If you choose ROLLBACK, failed import jobs will attempt to undo any asset changes caused by the failed job.

\n

If you choose DO_NOTHING, failed import jobs will not attempt to roll back\n any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.

" - } - }, - "OverridePermissions": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobOverridePermissions", - "traits": { - "smithy.api#documentation": "

Optional permission overrides that are applied to the resource configuration before import.

" - } - }, - "OverrideTags": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideTags", - "traits": { - "smithy.api#documentation": "

Optional tag overrides that are applied to the resource configuration before import.

" - } - }, - "OverrideValidationStrategy": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideValidationStrategy", - "traits": { - "smithy.api#documentation": "

An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#StartAssetBundleImportJobResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the import job.

" - } - }, - "AssetBundleImportJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services response ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the response.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#StartDashboardSnapshotJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#StartDashboardSnapshotJobRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#StartDashboardSnapshotJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedPricingPlanException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.

\n \n

The status of a submitted job can be polled with the DescribeDashboardSnapshotJob API. When you call the DescribeDashboardSnapshotJob API, check the JobStatus field in the response. Once the job reaches a COMPLETED or FAILED status, use the DescribeDashboardSnapshotJobResult API to obtain the URLs for the generated files. If the job fails, the DescribeDashboardSnapshotJobResult API returns detailed information about the error that occurred.

\n

\n StartDashboardSnapshotJob API throttling\n

\n

Amazon QuickSight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the StartDashboardSnapshotJob. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Amazon QuickSight throttles the API calls to maintin an optimal experience and reliability for all Amazon QuickSight users.

\n

\n Common throttling scenarios\n

\n

The following list provides information about the most commin throttling scenarios that can occur.

\n \n

If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account.

\n

\n Best practices to handle throttling\n

\n

If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Amazon QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example (12 minutes * 9 = 108 minutes). Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.

\n

The time that it takes to process a job can be impacted by the following factors:

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#StartDashboardSnapshotJobRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dashboard that you want to start a snapshot job for.\n

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SnapshotJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.

", - "smithy.api#required": {} - } - }, - "UserConfiguration": { - "target": "com.amazonaws.quicksight#SnapshotUserConfiguration", - "traits": { - "smithy.api#documentation": "

\n A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.

", - "smithy.api#required": {} - } - }, - "SnapshotConfiguration": { - "target": "com.amazonaws.quicksight#SnapshotConfiguration", - "traits": { - "smithy.api#documentation": "

A structure that describes the configuration of the dashboard snapshot.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#StartDashboardSnapshotJobResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the dashboard snapshot job.

" - } - }, - "SnapshotJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Web Services request ID for this operation.\n

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#StatePersistenceConfigurations": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The state perssitence configuration of an embedded dashboard.

" - } - }, - "com.amazonaws.quicksight#Status": { - "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.quicksight#StatusCode": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.quicksight#String": { - "type": "string" - }, - "com.amazonaws.quicksight#StringDatasetParameter": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.quicksight#DatasetParameterId", - "traits": { - "smithy.api#documentation": "

An identifier for the string parameter that is created in the dataset.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DatasetParameterName", - "traits": { - "smithy.api#documentation": "

The name of the string parameter that is created in the dataset.

", - "smithy.api#required": {} - } - }, - "ValueType": { - "target": "com.amazonaws.quicksight#DatasetParameterValueType", - "traits": { - "smithy.api#documentation": "

The value type of the dataset parameter. Valid values are single value or multi value.

", - "smithy.api#required": {} - } - }, - "DefaultValues": { - "target": "com.amazonaws.quicksight#StringDatasetParameterDefaultValues", - "traits": { - "smithy.api#documentation": "

A list of default values for a given string dataset parameter type. This structure only accepts static values.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A string parameter for a dataset.

" - } - }, - "com.amazonaws.quicksight#StringDatasetParameterDefaultValue": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The default value for the string parameter.

", - "smithy.api#length": { - "min": 0, - "max": 512 - } - } - }, - "com.amazonaws.quicksight#StringDatasetParameterDefaultValues": { - "type": "structure", - "members": { - "StaticValues": { - "target": "com.amazonaws.quicksight#StringDatasetParameterValueList", - "traits": { - "smithy.api#documentation": "

A list of static default values for a given string parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default values of a string parameter.

" - } - }, - "com.amazonaws.quicksight#StringDatasetParameterValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#StringDatasetParameterDefaultValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.quicksight#StringDefaultValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SensitiveStringObject" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50000 - } - } - }, - "com.amazonaws.quicksight#StringDefaultValues": { - "type": "structure", - "members": { - "DynamicValue": { - "target": "com.amazonaws.quicksight#DynamicDefaultValue", - "traits": { - "smithy.api#documentation": "

The dynamic value of the StringDefaultValues. Different defaults displayed according to users, groups, and values mapping.

" - } - }, - "StaticValues": { - "target": "com.amazonaws.quicksight#StringDefaultValueList", - "traits": { - "smithy.api#documentation": "

The static values of the DecimalDefaultValues.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default values of the StringParameterDeclaration.

" - } - }, - "com.amazonaws.quicksight#StringFormatConfiguration": { - "type": "structure", - "members": { - "NullValueFormatConfiguration": { - "target": "com.amazonaws.quicksight#NullValueFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the null value format configuration.

" - } - }, - "NumericFormatConfiguration": { - "target": "com.amazonaws.quicksight#NumericFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The formatting configuration for numeric strings.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Formatting configuration for string fields.

" - } - }, - "com.amazonaws.quicksight#StringList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#String" - } - }, - "com.amazonaws.quicksight#StringParameter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A display name for a string parameter.

", - "smithy.api#required": {} - } - }, - "Values": { - "target": "com.amazonaws.quicksight#SensitiveStringList", - "traits": { - "smithy.api#documentation": "

The values of a string parameter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A string parameter.

" - } - }, - "com.amazonaws.quicksight#StringParameterDeclaration": { - "type": "structure", - "members": { - "ParameterValueType": { - "target": "com.amazonaws.quicksight#ParameterValueType", - "traits": { - "smithy.api#documentation": "

The value type determines whether the parameter is a single-value or multi-value parameter.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The name of the parameter that is being declared.

", - "smithy.api#required": {} - } - }, - "DefaultValues": { - "target": "com.amazonaws.quicksight#StringDefaultValues", - "traits": { - "smithy.api#documentation": "

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

" - } - }, - "ValueWhenUnset": { - "target": "com.amazonaws.quicksight#StringValueWhenUnsetConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration that defines the default value of a String parameter when a value has not been set.

" - } - }, - "MappedDataSetParameters": { - "target": "com.amazonaws.quicksight#MappedDataSetParameters" - } - }, - "traits": { - "smithy.api#documentation": "

A parameter declaration for the String data type.

" - } - }, - "com.amazonaws.quicksight#StringParameterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#StringParameter" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#StringValueWhenUnsetConfiguration": { - "type": "structure", - "members": { - "ValueWhenUnsetOption": { - "target": "com.amazonaws.quicksight#ValueWhenUnsetOption", - "traits": { - "smithy.api#documentation": "

The built-in options for default values. The value can be one of the following:

\n " - } - }, - "CustomValue": { - "target": "com.amazonaws.quicksight#SensitiveString", - "traits": { - "smithy.api#documentation": "

A custom value that's used when the value of a parameter isn't set.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration that defines the default value of a String parameter when a value has not been set.

" - } - }, - "com.amazonaws.quicksight#StyledCellType": { - "type": "enum", - "members": { - "TOTAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TOTAL" - } - }, - "METRIC_HEADER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "METRIC_HEADER" - } - }, - "VALUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VALUE" - } - } - } - }, - "com.amazonaws.quicksight#SubnetId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^subnet-[0-9a-z]*$" - } - }, - "com.amazonaws.quicksight#SubnetIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SubnetId" - }, - "traits": { - "smithy.api#length": { - "min": 2, - "max": 15 - } - } - }, - "com.amazonaws.quicksight#SubtotalOptions": { - "type": "structure", - "members": { - "TotalsVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility configuration for the subtotal cells.

" - } - }, - "CustomLabel": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The custom label string for the subtotal cells.

" - } - }, - "FieldLevel": { - "target": "com.amazonaws.quicksight#PivotTableSubtotalLevel", - "traits": { - "smithy.api#documentation": "

The field level (all, custom, last) for the subtotal cells.

" - } - }, - "FieldLevelOptions": { - "target": "com.amazonaws.quicksight#PivotTableFieldSubtotalOptionsList", - "traits": { - "smithy.api#documentation": "

The optional configuration of subtotal cells.

" - } - }, - "TotalCellStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The cell styling options for the subtotal cells.

" - } - }, - "ValueCellStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The cell styling options for the subtotals of value cells.

" - } - }, - "MetricHeaderCellStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The cell styling options for the subtotals of header cells.

" - } - }, - "StyleTargets": { - "target": "com.amazonaws.quicksight#TableStyleTargetList", - "traits": { - "smithy.api#documentation": "

The style targets options for subtotals.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The subtotal options.

" - } - }, - "com.amazonaws.quicksight#SucceededTopicReviewedAnswer": { - "type": "structure", - "members": { - "AnswerId": { - "target": "com.amazonaws.quicksight#AnswerId", - "traits": { - "smithy.api#documentation": "

The answer ID for the SucceededTopicReviewedAnswer.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a SucceededTopicReviewedAnswer.

" - } - }, - "com.amazonaws.quicksight#SucceededTopicReviewedAnswers": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SucceededTopicReviewedAnswer" - } - }, - "com.amazonaws.quicksight#SuccessfulKeyRegistrationEntries": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SuccessfulKeyRegistrationEntry" - } - }, - "com.amazonaws.quicksight#SuccessfulKeyRegistrationEntry": { - "type": "structure", - "members": { - "KeyArn": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ARN of the KMS key that is associated with the SuccessfulKeyRegistrationEntry entry.

", - "smithy.api#required": {} - } - }, - "StatusCode": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of a SuccessfulKeyRegistrationEntry entry.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A success entry that occurs when a KeyRegistration job is successfully applied to the Amazon QuickSight account.

" - } - }, - "com.amazonaws.quicksight#Suffix": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#Synonyms": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#LimitedString" - } - }, - "com.amazonaws.quicksight#TableAggregatedFieldWells": { - "type": "structure", - "members": { - "GroupBy": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The group by field well for a pivot table. Values are grouped by group by fields.

" - } - }, - "Values": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The values field well for a pivot table. Values are aggregated based on group by fields.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The aggregated field well for the table.

" - } - }, - "com.amazonaws.quicksight#TableBorderOptions": { - "type": "structure", - "members": { - "Color": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color of a table border.

" - } - }, - "Thickness": { - "target": "com.amazonaws.quicksight#TableBorderThickness", - "traits": { - "smithy.api#documentation": "

The thickness of a table border.

" - } - }, - "Style": { - "target": "com.amazonaws.quicksight#TableBorderStyle", - "traits": { - "smithy.api#documentation": "

The style (none, solid) of a table border.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The border options for a table border.

" - } - }, - "com.amazonaws.quicksight#TableBorderStyle": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "SOLID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOLID" - } - } - } - }, - "com.amazonaws.quicksight#TableBorderThickness": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 4 - } - } - }, - "com.amazonaws.quicksight#TableCellConditionalFormatting": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID of the cell for conditional formatting.

", - "smithy.api#required": {} - } - }, - "TextFormat": { - "target": "com.amazonaws.quicksight#TextConditionalFormat", - "traits": { - "smithy.api#documentation": "

The text format of the cell for conditional formatting.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The cell conditional formatting option for a table.

" - } - }, - "com.amazonaws.quicksight#TableCellImageScalingConfiguration": { - "type": "enum", - "members": { - "FIT_TO_CELL_HEIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIT_TO_CELL_HEIGHT" - } - }, - "FIT_TO_CELL_WIDTH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIT_TO_CELL_WIDTH" - } - }, - "DO_NOT_SCALE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DO_NOT_SCALE" - } - } - } - }, - "com.amazonaws.quicksight#TableCellImageSizingConfiguration": { - "type": "structure", - "members": { - "TableCellImageScalingConfiguration": { - "target": "com.amazonaws.quicksight#TableCellImageScalingConfiguration", - "traits": { - "smithy.api#documentation": "

The cell scaling configuration of the sizing options for the table image configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sizing options for the table image configuration.

" - } - }, - "com.amazonaws.quicksight#TableCellStyle": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the table cells.

" - } - }, - "FontConfiguration": { - "target": "com.amazonaws.quicksight#FontConfiguration", - "traits": { - "smithy.api#documentation": "

The font configuration of the table cells.

" - } - }, - "TextWrap": { - "target": "com.amazonaws.quicksight#TextWrap", - "traits": { - "smithy.api#documentation": "

The text wrap (none, wrap) for the table cells.

" - } - }, - "HorizontalTextAlignment": { - "target": "com.amazonaws.quicksight#HorizontalTextAlignment", - "traits": { - "smithy.api#documentation": "

The horizontal text alignment (left, center, right, auto) for the table cells.

" - } - }, - "VerticalTextAlignment": { - "target": "com.amazonaws.quicksight#VerticalTextAlignment", - "traits": { - "smithy.api#documentation": "

The vertical text alignment (top, middle, bottom) for the table cells.

" - } - }, - "BackgroundColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The background color for the table cells.

" - } - }, - "Height": { - "target": "com.amazonaws.quicksight#TableFieldHeight", - "traits": { - "smithy.api#documentation": "

The height color for the table cells.

" - } - }, - "Border": { - "target": "com.amazonaws.quicksight#GlobalTableBorderOptions", - "traits": { - "smithy.api#documentation": "

The borders for the table cells.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The table cell style for a cell in pivot table or table visual.

" - } - }, - "com.amazonaws.quicksight#TableConditionalFormatting": { - "type": "structure", - "members": { - "ConditionalFormattingOptions": { - "target": "com.amazonaws.quicksight#TableConditionalFormattingOptionList", - "traits": { - "smithy.api#documentation": "

Conditional formatting options for a PivotTableVisual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting for a PivotTableVisual.

" - } - }, - "com.amazonaws.quicksight#TableConditionalFormattingOption": { - "type": "structure", - "members": { - "Cell": { - "target": "com.amazonaws.quicksight#TableCellConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The cell conditional formatting option for a table.

" - } - }, - "Row": { - "target": "com.amazonaws.quicksight#TableRowConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The row conditional formatting option for a table.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Conditional formatting options for a PivotTableVisual.

" - } - }, - "com.amazonaws.quicksight#TableConditionalFormattingOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TableConditionalFormattingOption" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.quicksight#TableConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#TableFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#TableSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration for a TableVisual.

" - } - }, - "TableOptions": { - "target": "com.amazonaws.quicksight#TableOptions", - "traits": { - "smithy.api#documentation": "

The table options for a table visual.

" - } - }, - "TotalOptions": { - "target": "com.amazonaws.quicksight#TotalOptions", - "traits": { - "smithy.api#documentation": "

The total options for a table visual.

" - } - }, - "FieldOptions": { - "target": "com.amazonaws.quicksight#TableFieldOptions", - "traits": { - "smithy.api#documentation": "

The field options for a table visual.

" - } - }, - "PaginatedReportOptions": { - "target": "com.amazonaws.quicksight#TablePaginatedReportOptions", - "traits": { - "smithy.api#documentation": "

The paginated report options for a table visual.

" - } - }, - "TableInlineVisualizations": { - "target": "com.amazonaws.quicksight#TableInlineVisualizationList", - "traits": { - "smithy.api#documentation": "

A collection of inline visualizations to display within a chart.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for a TableVisual.

" - } - }, - "com.amazonaws.quicksight#TableFieldCustomIconContent": { - "type": "structure", - "members": { - "Icon": { - "target": "com.amazonaws.quicksight#TableFieldIconSetType", - "traits": { - "smithy.api#documentation": "

The icon set type (link) of the custom icon content for table URL link content.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The custom icon content for the table link content configuration.

" - } - }, - "com.amazonaws.quicksight#TableFieldCustomTextContent": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The string value of the custom text content for the table URL link content.

" - } - }, - "FontConfiguration": { - "target": "com.amazonaws.quicksight#FontConfiguration", - "traits": { - "smithy.api#documentation": "

The font configuration of the custom text content for the table URL link content.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The custom text content (value, font configuration) for the table link content configuration.

" - } - }, - "com.amazonaws.quicksight#TableFieldHeight": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 8, - "max": 500 - } - } - }, - "com.amazonaws.quicksight#TableFieldIconSetType": { - "type": "enum", - "members": { - "LINK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LINK" - } - } - } - }, - "com.amazonaws.quicksight#TableFieldImageConfiguration": { - "type": "structure", - "members": { - "SizingOptions": { - "target": "com.amazonaws.quicksight#TableCellImageSizingConfiguration", - "traits": { - "smithy.api#documentation": "

The sizing options for the table image configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The image configuration of a table field URL.

" - } - }, - "com.amazonaws.quicksight#TableFieldLinkConfiguration": { - "type": "structure", - "members": { - "Target": { - "target": "com.amazonaws.quicksight#URLTargetConfiguration", - "traits": { - "smithy.api#documentation": "

The URL target (new tab, new window, same tab) for the table link configuration.

", - "smithy.api#required": {} - } - }, - "Content": { - "target": "com.amazonaws.quicksight#TableFieldLinkContentConfiguration", - "traits": { - "smithy.api#documentation": "

The URL content (text, icon) for the table link configuration.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The link configuration of a table field URL.

" - } - }, - "com.amazonaws.quicksight#TableFieldLinkContentConfiguration": { - "type": "structure", - "members": { - "CustomTextContent": { - "target": "com.amazonaws.quicksight#TableFieldCustomTextContent", - "traits": { - "smithy.api#documentation": "

The custom text content (value, font configuration) for the table link content configuration.

" - } - }, - "CustomIconContent": { - "target": "com.amazonaws.quicksight#TableFieldCustomIconContent", - "traits": { - "smithy.api#documentation": "

The custom icon content for the table link content configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The URL content (text, icon) for the table link configuration.

" - } - }, - "com.amazonaws.quicksight#TableFieldOption": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID for a table field.

", - "smithy.api#required": {} - } - }, - "Width": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The width for a table field.

" - } - }, - "CustomLabel": { - "target": "com.amazonaws.quicksight#CustomLabel", - "traits": { - "smithy.api#documentation": "

The custom label for a table field.

" - } - }, - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of a table field.

" - } - }, - "URLStyling": { - "target": "com.amazonaws.quicksight#TableFieldURLConfiguration", - "traits": { - "smithy.api#documentation": "

The URL configuration for a table field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options for a table field.

" - } - }, - "com.amazonaws.quicksight#TableFieldOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TableFieldOption" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#TableFieldOptions": { - "type": "structure", - "members": { - "SelectedFieldOptions": { - "target": "com.amazonaws.quicksight#TableFieldOptionList", - "traits": { - "smithy.api#documentation": "

The field options to be configured to a table.

" - } - }, - "Order": { - "target": "com.amazonaws.quicksight#FieldOrderList", - "traits": { - "smithy.api#documentation": "

The order of the field IDs that are configured as field options for a table visual.

" - } - }, - "PinnedFieldOptions": { - "target": "com.amazonaws.quicksight#TablePinnedFieldOptions", - "traits": { - "smithy.api#documentation": "

The settings for the pinned columns of a table visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field options of a table visual.

" - } - }, - "com.amazonaws.quicksight#TableFieldOrderList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FieldId" - }, - "traits": { - "smithy.api#documentation": "

A list of table field IDs.

", - "smithy.api#length": { - "min": 0, - "max": 201 - } - } - }, - "com.amazonaws.quicksight#TableFieldURLConfiguration": { - "type": "structure", - "members": { - "LinkConfiguration": { - "target": "com.amazonaws.quicksight#TableFieldLinkConfiguration", - "traits": { - "smithy.api#documentation": "

The link configuration of a table field URL.

" - } - }, - "ImageConfiguration": { - "target": "com.amazonaws.quicksight#TableFieldImageConfiguration", - "traits": { - "smithy.api#documentation": "

The image configuration of a table field URL.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The URL configuration for a table field.

" - } - }, - "com.amazonaws.quicksight#TableFieldWells": { - "type": "structure", - "members": { - "TableAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#TableAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field well for the table.

" - } - }, - "TableUnaggregatedFieldWells": { - "target": "com.amazonaws.quicksight#TableUnaggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The unaggregated field well for the table.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field wells for a table visual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#TableInlineVisualization": { - "type": "structure", - "members": { - "DataBars": { - "target": "com.amazonaws.quicksight#DataBarsOptions", - "traits": { - "smithy.api#documentation": "

The configuration of the inline visualization of the data bars within a chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The inline visualization of a specific type to display within a chart.

" - } - }, - "com.amazonaws.quicksight#TableInlineVisualizationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TableInlineVisualization" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#TableOptions": { - "type": "structure", - "members": { - "Orientation": { - "target": "com.amazonaws.quicksight#TableOrientation", - "traits": { - "smithy.api#documentation": "

The orientation (vertical, horizontal) for a table.

" - } - }, - "HeaderStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The table cell style of a table header.

" - } - }, - "CellStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The table cell style of table cells.

" - } - }, - "RowAlternateColorOptions": { - "target": "com.amazonaws.quicksight#RowAlternateColorOptions", - "traits": { - "smithy.api#documentation": "

The row alternate color options (widget status, row alternate colors) for a table.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The table options for a table visual.

" - } - }, - "com.amazonaws.quicksight#TableOrientation": { - "type": "enum", - "members": { - "VERTICAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VERTICAL" - } - }, - "HORIZONTAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HORIZONTAL" - } - } - } - }, - "com.amazonaws.quicksight#TablePaginatedReportOptions": { - "type": "structure", - "members": { - "VerticalOverflowVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of printing table overflow across pages.

" - } - }, - "OverflowColumnHeaderVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of repeating header rows on each page.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The paginated report options for a table visual.

" - } - }, - "com.amazonaws.quicksight#TablePinnedFieldOptions": { - "type": "structure", - "members": { - "PinnedLeftFields": { - "target": "com.amazonaws.quicksight#TableFieldOrderList", - "traits": { - "smithy.api#documentation": "

A list of columns to be pinned to the left of a table visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The settings for the pinned columns of a table visual.

" - } - }, - "com.amazonaws.quicksight#TableRowConditionalFormatting": { - "type": "structure", - "members": { - "BackgroundColor": { - "target": "com.amazonaws.quicksight#ConditionalFormattingColor", - "traits": { - "smithy.api#documentation": "

The conditional formatting color (solid, gradient) of the background for a table row.

" - } - }, - "TextColor": { - "target": "com.amazonaws.quicksight#ConditionalFormattingColor", - "traits": { - "smithy.api#documentation": "

The conditional formatting color (solid, gradient) of the text for a table row.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting of a table row.

" - } - }, - "com.amazonaws.quicksight#TableSideBorderOptions": { - "type": "structure", - "members": { - "InnerVertical": { - "target": "com.amazonaws.quicksight#TableBorderOptions", - "traits": { - "smithy.api#documentation": "

The table border options of the inner vertical border.

" - } - }, - "InnerHorizontal": { - "target": "com.amazonaws.quicksight#TableBorderOptions", - "traits": { - "smithy.api#documentation": "

The table border options of the inner horizontal border.

" - } - }, - "Left": { - "target": "com.amazonaws.quicksight#TableBorderOptions", - "traits": { - "smithy.api#documentation": "

The table border options of the left border.

" - } - }, - "Right": { - "target": "com.amazonaws.quicksight#TableBorderOptions", - "traits": { - "smithy.api#documentation": "

The table border options of the right border.

" - } - }, - "Top": { - "target": "com.amazonaws.quicksight#TableBorderOptions", - "traits": { - "smithy.api#documentation": "

The table border options of the top border.

" - } - }, - "Bottom": { - "target": "com.amazonaws.quicksight#TableBorderOptions", - "traits": { - "smithy.api#documentation": "

The table border options of the bottom border.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The side border options for a table.

" - } - }, - "com.amazonaws.quicksight#TableSortConfiguration": { - "type": "structure", - "members": { - "RowSort": { - "target": "com.amazonaws.quicksight#RowSortList", - "traits": { - "smithy.api#documentation": "

The field sort options for rows in the table.

" - } - }, - "PaginationConfiguration": { - "target": "com.amazonaws.quicksight#PaginationConfiguration", - "traits": { - "smithy.api#documentation": "

The pagination configuration (page size, page number) for the table.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration for a TableVisual.

" - } - }, - "com.amazonaws.quicksight#TableStyleTarget": { - "type": "structure", - "members": { - "CellType": { - "target": "com.amazonaws.quicksight#StyledCellType", - "traits": { - "smithy.api#documentation": "

The cell type of the table style target.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The table style target.

" - } - }, - "com.amazonaws.quicksight#TableStyleTargetList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TableStyleTarget" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 3 - } - } - }, - "com.amazonaws.quicksight#TableTotalsPlacement": { - "type": "enum", - "members": { - "START": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "START" - } - }, - "END": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "END" - } - }, - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - } - } - }, - "com.amazonaws.quicksight#TableTotalsScrollStatus": { - "type": "enum", - "members": { - "PINNED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PINNED" - } - }, - "SCROLLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCROLLED" - } - } - } - }, - "com.amazonaws.quicksight#TableUnaggregatedFieldWells": { - "type": "structure", - "members": { - "Values": { - "target": "com.amazonaws.quicksight#UnaggregatedFieldList", - "traits": { - "smithy.api#documentation": "

The values field well for a pivot table. Values are unaggregated for an unaggregated table.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The unaggregated field well for the table.

" - } - }, - "com.amazonaws.quicksight#TableVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#TableConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the visual.

" - } - }, - "ConditionalFormatting": { - "target": "com.amazonaws.quicksight#TableConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The conditional formatting for a PivotTableVisual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A table visual.

\n

For more information, see Using tables as visuals in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#Tag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.quicksight#TagKey", - "traits": { - "smithy.api#documentation": "

Tag key.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.quicksight#TagValue", - "traits": { - "smithy.api#documentation": "

Tag value.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.

" - } - }, - "com.amazonaws.quicksight#TagColumnOperation": { - "type": "structure", - "members": { - "ColumnName": { - "target": "com.amazonaws.quicksight#ColumnName", - "traits": { - "smithy.api#documentation": "

The column that this operation acts on.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#ColumnTagList", - "traits": { - "smithy.api#documentation": "

The dataset column tag, currently only used for geospatial type tagging.

\n \n

This is not tags for the Amazon Web Services tagging feature.

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A transform operation that tags a column with additional information.

" - } - }, - "com.amazonaws.quicksight#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.quicksight#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Tag" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.

\n

Tags can help you organize and categorize your resources. You can also use them to\n\t\t\tscope user permissions, by granting a user permission to access or change only resources\n\t\t\twith certain tag values. You can use the TagResource operation with a\n\t\t\tresource that already has tags. If you specify a new tag key for the resource, this tag\n\t\t\tis appended to the list of tags associated with the resource. If you specify a tag key\n\t\t\tthat is already associated with the resource, the new tag value that you specify\n\t\t\treplaces the previous value for that tag.

\n

You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data\n\t\t\tset, data source, dashboard, template, topic, and user.

\n

Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for\n\t\t\tthe following:

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/resources/{ResourceArn}/tags", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#TagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to tag.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#TagResourceResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.quicksight#TargetVisualList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#TargetVisualOptions": { - "type": "enum", - "members": { - "ALL_VISUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL_VISUALS" - } - } - } - }, - "com.amazonaws.quicksight#Template": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#TemplateName", - "traits": { - "smithy.api#documentation": "

The display name of the template.

" - } - }, - "Version": { - "target": "com.amazonaws.quicksight#TemplateVersion", - "traits": { - "smithy.api#documentation": "

A structure describing the versions of the template.

" - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

Time when this was last updated.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

Time when this was created.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A template object. A template is an entity in Amazon QuickSight that\n encapsulates the metadata required to create an analysis and that you can use to create\n a dashboard. A template adds a layer of abstraction by using placeholders to replace the\n dataset associated with an analysis. You can use templates to create dashboards by\n replacing dataset placeholders with datasets that follow the same schema that was used\n to create the source analysis and template.

\n

You can share templates across Amazon Web Services accounts by allowing users in other Amazon Web Services accounts to\n create a template or a dashboard from an existing template.

" - } - }, - "com.amazonaws.quicksight#TemplateAlias": { - "type": "structure", - "members": { - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The display name of the template alias.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template alias.

" - } - }, - "TemplateVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the template alias.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The template alias.

" - } - }, - "com.amazonaws.quicksight#TemplateAliasList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TemplateAlias" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#TemplateError": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.quicksight#TemplateErrorType", - "traits": { - "smithy.api#documentation": "

Type of error.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Description of the error type.

" - } - }, - "ViolatedEntities": { - "target": "com.amazonaws.quicksight#EntityList", - "traits": { - "smithy.api#documentation": "

An error path that shows which entities caused the template error.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

List of errors that occurred when the template version creation failed.

" - } - }, - "com.amazonaws.quicksight#TemplateErrorList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TemplateError" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.quicksight#TemplateErrorType": { - "type": "enum", - "members": { - "SOURCE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOURCE_NOT_FOUND" - } - }, - "DATA_SET_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_SET_NOT_FOUND" - } - }, - "INTERNAL_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_FAILURE" - } - }, - "ACCESS_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCESS_DENIED" - } - } - } - }, - "com.amazonaws.quicksight#TemplateName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#TemplateSourceAnalysis": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", - "smithy.api#required": {} - } - }, - "DataSetReferences": { - "target": "com.amazonaws.quicksight#DataSetReferenceList", - "traits": { - "smithy.api#documentation": "

A structure containing information about the dataset references used as placeholders\n in the template.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The source analysis of the template.

" - } - }, - "com.amazonaws.quicksight#TemplateSourceEntity": { - "type": "structure", - "members": { - "SourceAnalysis": { - "target": "com.amazonaws.quicksight#TemplateSourceAnalysis", - "traits": { - "smithy.api#documentation": "

The source analysis, if it is based on an analysis.

" - } - }, - "SourceTemplate": { - "target": "com.amazonaws.quicksight#TemplateSourceTemplate", - "traits": { - "smithy.api#documentation": "

The source template, if it is based on an template.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The source entity of the template.

" - } - }, - "com.amazonaws.quicksight#TemplateSourceTemplate": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The source template of the template.

" - } - }, - "com.amazonaws.quicksight#TemplateSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

A summary of a template.

" - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the template. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#TemplateName", - "traits": { - "smithy.api#documentation": "

A display name for the template.

" - } - }, - "LatestVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

A structure containing a list of version numbers for the template summary.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that this template was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that this template was updated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The template summary.

" - } - }, - "com.amazonaws.quicksight#TemplateSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TemplateSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#TemplateVersion": { - "type": "structure", - "members": { - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that this template version was created.

" - } - }, - "Errors": { - "target": "com.amazonaws.quicksight#TemplateErrorList", - "traits": { - "smithy.api#documentation": "

Errors associated with this template version.

" - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the template version.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The status that is associated with the template.

\n " - } - }, - "DataSetConfigurations": { - "target": "com.amazonaws.quicksight#DataSetConfigurationList", - "traits": { - "smithy.api#documentation": "

Schema of the dataset identified by the placeholder. Any dashboard created from this\n template should be bound to new datasets matching the same schema described through this\n API operation.

" - } - }, - "Description": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

The description of the template.

" - } - }, - "SourceEntityArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an analysis or template that was used to create this\n template.

" - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the theme associated with this version of the template.

" - } - }, - "Sheets": { - "target": "com.amazonaws.quicksight#SheetList", - "traits": { - "smithy.api#documentation": "

A list of the associated sheets with the unique identifier and name of each sheet.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A version of a template.

" - } - }, - "com.amazonaws.quicksight#TemplateVersionDefinition": { - "type": "structure", - "members": { - "DataSetConfigurations": { - "target": "com.amazonaws.quicksight#DataSetConfigurationList", - "traits": { - "smithy.api#documentation": "

An array of dataset configurations. These configurations define the required columns for each dataset used within a template.

", - "smithy.api#required": {} - } - }, - "Sheets": { - "target": "com.amazonaws.quicksight#SheetDefinitionList", - "traits": { - "smithy.api#documentation": "

An array of sheet definitions for a template.

" - } - }, - "CalculatedFields": { - "target": "com.amazonaws.quicksight#CalculatedFields", - "traits": { - "smithy.api#documentation": "

An array of calculated field definitions for the template.

" - } - }, - "ParameterDeclarations": { - "target": "com.amazonaws.quicksight#ParameterDeclarationList", - "traits": { - "smithy.api#documentation": "

An array of parameter declarations for a template.

\n

\n Parameters are named variables that can transfer a value for use by an action or an object.

\n

For more information, see Parameters in Amazon QuickSight in the\n Amazon QuickSight User Guide.\n

" - } - }, - "FilterGroups": { - "target": "com.amazonaws.quicksight#FilterGroupList", - "traits": { - "smithy.api#documentation": "

Filter definitions for a template.

\n

For more information, see Filtering Data in the Amazon QuickSight User Guide.\n

" - } - }, - "ColumnConfigurations": { - "target": "com.amazonaws.quicksight#ColumnConfigurationList", - "traits": { - "smithy.api#documentation": "

An array of template-level column\n configurations. Column configurations are used to set default formatting for a column that's used throughout a template.

" - } - }, - "AnalysisDefaults": { - "target": "com.amazonaws.quicksight#AnalysisDefaults" - }, - "Options": { - "target": "com.amazonaws.quicksight#AssetOptions", - "traits": { - "smithy.api#documentation": "

An array of option definitions for a template.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The detailed definition of a template.

" - } - }, - "com.amazonaws.quicksight#TemplateVersionSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template version.

" - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the template version.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that this template version was created.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The status of the template version.

" - } - }, - "Description": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

The description of the template version.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The template version.

" - } - }, - "com.amazonaws.quicksight#TemplateVersionSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TemplateVersionSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#TeradataParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

Host.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

Port.

", - "smithy.api#required": {} - } - }, - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

Database.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for Teradata.

" - } - }, - "com.amazonaws.quicksight#TextAreaControlDelimiter": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#TextAreaControlDisplayOptions": { - "type": "structure", - "members": { - "TitleOptions": { - "target": "com.amazonaws.quicksight#LabelOptions", - "traits": { - "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" - } - }, - "PlaceholderOptions": { - "target": "com.amazonaws.quicksight#TextControlPlaceholderOptions", - "traits": { - "smithy.api#documentation": "

The configuration of the placeholder options in a text area control.

" - } - }, - "InfoIconLabelOptions": { - "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", - "traits": { - "smithy.api#documentation": "

The configuration of info icon label options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "com.amazonaws.quicksight#TextConditionalFormat": { - "type": "structure", - "members": { - "BackgroundColor": { - "target": "com.amazonaws.quicksight#ConditionalFormattingColor", - "traits": { - "smithy.api#documentation": "

The conditional formatting for the text background color.

" - } - }, - "TextColor": { - "target": "com.amazonaws.quicksight#ConditionalFormattingColor", - "traits": { - "smithy.api#documentation": "

The conditional formatting for the text color.

" - } - }, - "Icon": { - "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", - "traits": { - "smithy.api#documentation": "

The conditional formatting for the icon.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting for the text.

" - } - }, - "com.amazonaws.quicksight#TextControlPlaceholderOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility configuration of the placeholder options in a text control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of the placeholder options in a text control.

" - } - }, - "com.amazonaws.quicksight#TextFieldControlDisplayOptions": { - "type": "structure", - "members": { - "TitleOptions": { - "target": "com.amazonaws.quicksight#LabelOptions", - "traits": { - "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" - } - }, - "PlaceholderOptions": { - "target": "com.amazonaws.quicksight#TextControlPlaceholderOptions", - "traits": { - "smithy.api#documentation": "

The configuration of the placeholder options in a text field control.

" - } - }, - "InfoIconLabelOptions": { - "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", - "traits": { - "smithy.api#documentation": "

The configuration of info icon label options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "com.amazonaws.quicksight#TextQualifier": { - "type": "enum", - "members": { - "DOUBLE_QUOTE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOUBLE_QUOTE" - } - }, - "SINGLE_QUOTE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SINGLE_QUOTE" - } - } - } - }, - "com.amazonaws.quicksight#TextWrap": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "WRAP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WRAP" - } - } - } - }, - "com.amazonaws.quicksight#Theme": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ThemeName", - "traits": { - "smithy.api#documentation": "

The name that the user gives to the theme.

" - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The identifier that the user gives to the theme.

" - } - }, - "Version": { - "target": "com.amazonaws.quicksight#ThemeVersion" - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the theme was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the theme was last updated.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#ThemeType", - "traits": { - "smithy.api#documentation": "

The type of theme, based on how it was created. Valid values include:\n QUICKSIGHT and CUSTOM.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Summary information about a theme.

" - } - }, - "com.amazonaws.quicksight#ThemeAlias": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme alias.

" - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The display name of the theme alias.

" - } - }, - "ThemeVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the theme alias.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An alias for a theme.

" - } - }, - "com.amazonaws.quicksight#ThemeAliasList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ThemeAlias" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#ThemeConfiguration": { - "type": "structure", - "members": { - "DataColorPalette": { - "target": "com.amazonaws.quicksight#DataColorPalette", - "traits": { - "smithy.api#documentation": "

Color properties that apply to chart data colors.

" - } - }, - "UIColorPalette": { - "target": "com.amazonaws.quicksight#UIColorPalette", - "traits": { - "smithy.api#documentation": "

Color properties that apply to the UI and to charts, excluding the colors that apply\n to data.

" - } - }, - "Sheet": { - "target": "com.amazonaws.quicksight#SheetStyle", - "traits": { - "smithy.api#documentation": "

Display options related to sheets.

" - } - }, - "Typography": { - "target": "com.amazonaws.quicksight#Typography" - } - }, - "traits": { - "smithy.api#documentation": "

The theme configuration. This configuration contains all of the display properties for\n a theme.

" - } - }, - "com.amazonaws.quicksight#ThemeError": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.quicksight#ThemeErrorType", - "traits": { - "smithy.api#documentation": "

The type of error.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The error message.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Theme error.

" - } - }, - "com.amazonaws.quicksight#ThemeErrorList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ThemeError" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.quicksight#ThemeErrorType": { - "type": "enum", - "members": { - "INTERNAL_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_FAILURE" - } - } - } - }, - "com.amazonaws.quicksight#ThemeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#ThemeSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ThemeName", - "traits": { - "smithy.api#documentation": "

the display name for the theme.

" - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "LatestVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The latest version number for the theme.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that this theme was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The last date and time that this theme was updated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The theme summary.

" - } - }, - "com.amazonaws.quicksight#ThemeSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ThemeSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#ThemeType": { - "type": "enum", - "members": { - "QUICKSIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT" - } - }, - "CUSTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM" - } - }, - "ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL" - } - } - } - }, - "com.amazonaws.quicksight#ThemeVersion": { - "type": "structure", - "members": { - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the theme.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - }, - "Description": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

The description of the theme.

" - } - }, - "BaseThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All\n themes initially inherit from a default Amazon QuickSight theme.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that this theme version was created.

" - } - }, - "Configuration": { - "target": "com.amazonaws.quicksight#ThemeConfiguration", - "traits": { - "smithy.api#documentation": "

The theme configuration, which contains all the theme display properties.

" - } - }, - "Errors": { - "target": "com.amazonaws.quicksight#ThemeErrorList", - "traits": { - "smithy.api#documentation": "

Errors associated with the theme.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The status of the theme version.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A version of a theme.

" - } - }, - "com.amazonaws.quicksight#ThemeVersionSummary": { - "type": "structure", - "members": { - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the theme version.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme version.

" - } - }, - "Description": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

The description of the theme version.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that this theme version was created.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The status of the theme version.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The theme version.

" - } - }, - "com.amazonaws.quicksight#ThemeVersionSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ThemeVersionSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#ThousandSeparatorOptions": { - "type": "structure", - "members": { - "Symbol": { - "target": "com.amazonaws.quicksight#NumericSeparatorSymbol", - "traits": { - "smithy.api#documentation": "

Determines the thousands separator symbol.

" - } - }, - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines the visibility of the thousands separator.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the thousands separator configuration.

" - } - }, - "com.amazonaws.quicksight#ThrottlingException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Access is throttled.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.quicksight#TileLayoutStyle": { - "type": "structure", - "members": { - "Gutter": { - "target": "com.amazonaws.quicksight#GutterStyle", - "traits": { - "smithy.api#documentation": "

The gutter settings that apply between tiles.

" - } - }, - "Margin": { - "target": "com.amazonaws.quicksight#MarginStyle", - "traits": { - "smithy.api#documentation": "

The margin settings that apply around the outside edge of sheets.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options for the layout of tiles on a sheet.

" - } - }, - "com.amazonaws.quicksight#TileStyle": { - "type": "structure", - "members": { - "Border": { - "target": "com.amazonaws.quicksight#BorderStyle", - "traits": { - "smithy.api#documentation": "

The border around a tile.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Display options related to tiles on a sheet.

" - } - }, - "com.amazonaws.quicksight#TimeBasedForecastProperties": { - "type": "structure", - "members": { - "PeriodsForward": { - "target": "com.amazonaws.quicksight#PeriodsForward", - "traits": { - "smithy.api#documentation": "

The periods forward setup of a forecast computation.

" - } - }, - "PeriodsBackward": { - "target": "com.amazonaws.quicksight#PeriodsBackward", - "traits": { - "smithy.api#documentation": "

The periods backward setup of a forecast computation.

" - } - }, - "UpperBoundary": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The upper boundary setup of a forecast computation.

" - } - }, - "LowerBoundary": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The lower boundary setup of a forecast computation.

" - } - }, - "PredictionInterval": { - "target": "com.amazonaws.quicksight#PredictionInterval", - "traits": { - "smithy.api#documentation": "

The prediction interval setup of a forecast computation.

" - } - }, - "Seasonality": { - "target": "com.amazonaws.quicksight#Seasonality", - "traits": { - "smithy.api#documentation": "

The seasonality setup of a forecast computation. Choose one of the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The forecast properties setup of a forecast in the line chart.

" - } - }, - "com.amazonaws.quicksight#TimeEqualityFilter": { - "type": "structure", - "members": { - "FilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The value of a TimeEquality filter.

\n

This field is mutually exclusive to RollingDate and ParameterName.

" - } - }, - "ParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The parameter whose value should be used for the filter value.

\n

This field is mutually exclusive to Value and RollingDate.

" - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" - } - }, - "RollingDate": { - "target": "com.amazonaws.quicksight#RollingDateConfiguration", - "traits": { - "smithy.api#documentation": "

The rolling date input for the TimeEquality filter.

\n

This field is mutually exclusive to Value and ParameterName.

" - } - }, - "DefaultFilterControlConfiguration": { - "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", - "traits": { - "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A TimeEqualityFilter filters values that are equal to a given value.

" - } - }, - "com.amazonaws.quicksight#TimeGranularity": { - "type": "enum", - "members": { - "YEAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "YEAR" - } - }, - "QUARTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUARTER" - } - }, - "MONTH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MONTH" - } - }, - "WEEK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WEEK" - } - }, - "DAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DAY" - } - }, - "HOUR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOUR" - } - }, - "MINUTE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MINUTE" - } - }, - "SECOND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SECOND" - } - }, - "MILLISECOND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MILLISECOND" - } - } - } - }, - "com.amazonaws.quicksight#TimeRangeDrillDownFilter": { - "type": "structure", - "members": { - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "RangeMinimum": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The minimum value for the filter value range.

", - "smithy.api#required": {} - } - }, - "RangeMaximum": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The maximum value for the filter value range.

", - "smithy.api#required": {} - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The time range drill down filter.

" - } - }, - "com.amazonaws.quicksight#TimeRangeFilter": { - "type": "structure", - "members": { - "FilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "IncludeMinimum": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

Determines whether the minimum value in the filter value range should be included in the filtered results.

" - } - }, - "IncludeMaximum": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

Determines whether the maximum value in the filter value range should be included in the filtered results.

" - } - }, - "RangeMinimumValue": { - "target": "com.amazonaws.quicksight#TimeRangeFilterValue", - "traits": { - "smithy.api#documentation": "

The minimum value for the filter value range.

" - } - }, - "RangeMaximumValue": { - "target": "com.amazonaws.quicksight#TimeRangeFilterValue", - "traits": { - "smithy.api#documentation": "

The maximum value for the filter value range.

" - } - }, - "NullOption": { - "target": "com.amazonaws.quicksight#FilterNullOption", - "traits": { - "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", - "smithy.api#required": {} - } - }, - "ExcludePeriodConfiguration": { - "target": "com.amazonaws.quicksight#ExcludePeriodConfiguration", - "traits": { - "smithy.api#documentation": "

The exclude period of the time range filter.

" - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" - } - }, - "DefaultFilterControlConfiguration": { - "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", - "traits": { - "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A TimeRangeFilter filters values that are between two specified values.

" - } - }, - "com.amazonaws.quicksight#TimeRangeFilterValue": { - "type": "structure", - "members": { - "StaticValue": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The static input value.

" - } - }, - "RollingDate": { - "target": "com.amazonaws.quicksight#RollingDateConfiguration", - "traits": { - "smithy.api#documentation": "

The rolling date input value.

" - } - }, - "Parameter": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The parameter type input value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The value of a time range filter.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#Timestamp": { - "type": "timestamp" - }, - "com.amazonaws.quicksight#TooltipItem": { - "type": "structure", - "members": { - "FieldTooltipItem": { - "target": "com.amazonaws.quicksight#FieldTooltipItem", - "traits": { - "smithy.api#documentation": "

The tooltip item for the fields.

" - } - }, - "ColumnTooltipItem": { - "target": "com.amazonaws.quicksight#ColumnTooltipItem", - "traits": { - "smithy.api#documentation": "

The tooltip item for the columns that are not part of a field well.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The tooltip.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#TooltipItemList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TooltipItem" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#TooltipOptions": { - "type": "structure", - "members": { - "TooltipVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines whether or not the tooltip is visible.

" - } - }, - "SelectedTooltipType": { - "target": "com.amazonaws.quicksight#SelectedTooltipType", - "traits": { - "smithy.api#documentation": "

The selected type for the tooltip. Choose one of the following options:

\n " - } - }, - "FieldBasedTooltip": { - "target": "com.amazonaws.quicksight#FieldBasedTooltip", - "traits": { - "smithy.api#documentation": "

The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options for the visual tooltip.

" - } - }, - "com.amazonaws.quicksight#TooltipTarget": { - "type": "enum", - "members": { - "BOTH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOTH" - } - }, - "BAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BAR" - } - }, - "LINE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LINE" - } - } - } - }, - "com.amazonaws.quicksight#TooltipTitleType": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "PRIMARY_VALUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRIMARY_VALUE" - } - } - } - }, - "com.amazonaws.quicksight#TopBottomComputationType": { - "type": "enum", - "members": { - "TOP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TOP" - } - }, - "BOTTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOTTOM" - } - } - } - }, - "com.amazonaws.quicksight#TopBottomFilter": { - "type": "structure", - "members": { - "FilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "Limit": { - "target": "com.amazonaws.quicksight#Integer", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The number of items to include in the top bottom filter results.

" - } - }, - "AggregationSortConfigurations": { - "target": "com.amazonaws.quicksight#AggregationSortConfigurationList", - "traits": { - "smithy.api#documentation": "

The aggregation and sort configuration of the top bottom filter.

", - "smithy.api#required": {} - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" - } - }, - "ParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The parameter whose value should be used for the filter value.

" - } - }, - "DefaultFilterControlConfiguration": { - "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", - "traits": { - "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A TopBottomFilter filters values that are at the top or the bottom.

" - } - }, - "com.amazonaws.quicksight#TopBottomMoversComputation": { - "type": "structure", - "members": { - "ComputationId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for a computation.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of a computation.

" - } - }, - "Time": { - "target": "com.amazonaws.quicksight#DimensionField", - "traits": { - "smithy.api#documentation": "

The time field that is used in a computation.

" - } - }, - "Category": { - "target": "com.amazonaws.quicksight#DimensionField", - "traits": { - "smithy.api#documentation": "

The category field that is used in a computation.

" - } - }, - "Value": { - "target": "com.amazonaws.quicksight#MeasureField", - "traits": { - "smithy.api#documentation": "

The value field that is used in a computation.

" - } - }, - "MoverSize": { - "target": "com.amazonaws.quicksight#TopBottomMoversComputationMoverSize", - "traits": { - "smithy.api#documentation": "

The mover size setup of the top and bottom movers computation.

" - } - }, - "SortOrder": { - "target": "com.amazonaws.quicksight#TopBottomSortOrder", - "traits": { - "smithy.api#documentation": "

The sort order setup of the top and bottom movers computation.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#TopBottomComputationType", - "traits": { - "smithy.api#documentation": "

The computation type. Choose from the following options:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The top movers and bottom movers computation setup.

" - } - }, - "com.amazonaws.quicksight#TopBottomMoversComputationMoverSize": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#TopBottomRankedComputation": { - "type": "structure", - "members": { - "ComputationId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for a computation.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of a computation.

" - } - }, - "Category": { - "target": "com.amazonaws.quicksight#DimensionField", - "traits": { - "smithy.api#documentation": "

The category field that is used in a computation.

" - } - }, - "Value": { - "target": "com.amazonaws.quicksight#MeasureField", - "traits": { - "smithy.api#documentation": "

The value field that is used in a computation.

" - } - }, - "ResultSize": { - "target": "com.amazonaws.quicksight#TopBottomRankedComputationResultSize", - "traits": { - "smithy.api#documentation": "

The result size of a top and bottom ranked computation.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#TopBottomComputationType", - "traits": { - "smithy.api#documentation": "

The computation type. Choose one of the following options:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The top ranked and bottom ranked computation configuration.

" - } - }, - "com.amazonaws.quicksight#TopBottomRankedComputationResultSize": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#TopBottomSortOrder": { - "type": "enum", - "members": { - "PERCENT_DIFFERENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENT_DIFFERENCE" - } - }, - "ABSOLUTE_DIFFERENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ABSOLUTE_DIFFERENCE" - } - } - } - }, - "com.amazonaws.quicksight#TopicCalculatedField": { - "type": "structure", - "members": { - "CalculatedFieldName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The calculated field name.

", - "smithy.api#required": {} - } - }, - "CalculatedFieldDescription": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The calculated field description.

" - } - }, - "Expression": { - "target": "com.amazonaws.quicksight#Expression", - "traits": { - "smithy.api#documentation": "

The calculated field expression.

", - "smithy.api#required": {} - } - }, - "CalculatedFieldSynonyms": { - "target": "com.amazonaws.quicksight#Synonyms", - "traits": { - "smithy.api#documentation": "

The other names or aliases for the calculated field.

" - } - }, - "IsIncludedInTopic": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A boolean value that indicates if a calculated field is included in the topic.

" - } - }, - "DisableIndexing": { - "target": "com.amazonaws.quicksight#NullableBoolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates if a calculated field is visible in the autocomplete.

" - } - }, - "ColumnDataRole": { - "target": "com.amazonaws.quicksight#ColumnDataRole", - "traits": { - "smithy.api#documentation": "

The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.

" - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TopicTimeGranularity", - "traits": { - "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" - } - }, - "DefaultFormatting": { - "target": "com.amazonaws.quicksight#DefaultFormatting", - "traits": { - "smithy.api#documentation": "

The default formatting definition.

" - } - }, - "Aggregation": { - "target": "com.amazonaws.quicksight#DefaultAggregation", - "traits": { - "smithy.api#documentation": "

The default aggregation. Valid values for this structure are SUM,\n MAX, MIN, COUNT,\n DISTINCT_COUNT,\n and AVERAGE.

" - } - }, - "ComparativeOrder": { - "target": "com.amazonaws.quicksight#ComparativeOrder", - "traits": { - "smithy.api#documentation": "

The order in which data is displayed for the calculated field when\n it's used in a comparative context.

" - } - }, - "SemanticType": { - "target": "com.amazonaws.quicksight#SemanticType", - "traits": { - "smithy.api#documentation": "

The semantic type.

" - } - }, - "AllowedAggregations": { - "target": "com.amazonaws.quicksight#AuthorSpecifiedAggregations", - "traits": { - "smithy.api#documentation": "

The list of aggregation types that are allowed for the calculated field. Valid values\n for this structure are COUNT, DISTINCT_COUNT, MIN,\n MAX, MEDIAN, SUM, AVERAGE,\n STDEV, STDEVP, VAR,\n VARP, and PERCENTILE.

" - } - }, - "NotAllowedAggregations": { - "target": "com.amazonaws.quicksight#AuthorSpecifiedAggregations", - "traits": { - "smithy.api#documentation": "

The list of aggregation types that are not allowed for the calculated field. Valid\n values for this structure are COUNT, DISTINCT_COUNT,\n MIN, MAX, MEDIAN, SUM,\n AVERAGE, STDEV, STDEVP, VAR,\n VARP, and PERCENTILE.

" - } - }, - "NeverAggregateInFilter": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates whether to never aggregate calculated field in filters.

" - } - }, - "CellValueSynonyms": { - "target": "com.amazonaws.quicksight#CellValueSynonyms", - "traits": { - "smithy.api#documentation": "

The other\n names or aliases for the calculated field cell value.

" - } - }, - "NonAdditive": { - "target": "com.amazonaws.quicksight#NullableBoolean", - "traits": { - "smithy.api#documentation": "

The non additive for the table style target.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a calculated field.

" - } - }, - "com.amazonaws.quicksight#TopicCalculatedFields": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicCalculatedField" - } - }, - "com.amazonaws.quicksight#TopicCategoryFilter": { - "type": "structure", - "members": { - "CategoryFilterFunction": { - "target": "com.amazonaws.quicksight#CategoryFilterFunction", - "traits": { - "smithy.api#documentation": "

The category filter function. Valid values for this structure are EXACT and CONTAINS.

" - } - }, - "CategoryFilterType": { - "target": "com.amazonaws.quicksight#CategoryFilterType", - "traits": { - "smithy.api#documentation": "

The category filter type. This element is used to specify whether a filter is a simple category filter or an inverse category filter.

" - } - }, - "Constant": { - "target": "com.amazonaws.quicksight#TopicCategoryFilterConstant", - "traits": { - "smithy.api#documentation": "

The constant used in a category filter.

" - } - }, - "Inverse": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates if the filter is inverse.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a category filter.

" - } - }, - "com.amazonaws.quicksight#TopicCategoryFilterConstant": { - "type": "structure", - "members": { - "ConstantType": { - "target": "com.amazonaws.quicksight#ConstantType", - "traits": { - "smithy.api#documentation": "

The type of category filter constant. This element is used to specify whether a constant is a singular or collective. Valid values are SINGULAR and COLLECTIVE.

" - } - }, - "SingularConstant": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

A singular constant used in a category filter. This element is used to specify a single value for the constant.

" - } - }, - "CollectiveConstant": { - "target": "com.amazonaws.quicksight#CollectiveConstant", - "traits": { - "smithy.api#documentation": "

A collective constant used in a category filter. This element is used to specify a list of values for the constant.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A constant used in a category filter.

", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#TopicColumn": { - "type": "structure", - "members": { - "ColumnName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The name of the column.

", - "smithy.api#required": {} - } - }, - "ColumnFriendlyName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

A user-friendly name for the column.

" - } - }, - "ColumnDescription": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

A description of the column and its contents.

" - } - }, - "ColumnSynonyms": { - "target": "com.amazonaws.quicksight#Synonyms", - "traits": { - "smithy.api#documentation": "

The other names or aliases for the column.

" - } - }, - "ColumnDataRole": { - "target": "com.amazonaws.quicksight#ColumnDataRole", - "traits": { - "smithy.api#documentation": "

The role of the column in the data. Valid values are DIMENSION and MEASURE.

" - } - }, - "Aggregation": { - "target": "com.amazonaws.quicksight#DefaultAggregation", - "traits": { - "smithy.api#documentation": "

The type of aggregation that is performed on the column data when\n it's queried.

" - } - }, - "IsIncludedInTopic": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates whether the column is included in the query results.

" - } - }, - "DisableIndexing": { - "target": "com.amazonaws.quicksight#NullableBoolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether the column shows in the autocomplete functionality.

" - } - }, - "ComparativeOrder": { - "target": "com.amazonaws.quicksight#ComparativeOrder", - "traits": { - "smithy.api#documentation": "

The order in which data is displayed for the column when\n it's used in a comparative context.

" - } - }, - "SemanticType": { - "target": "com.amazonaws.quicksight#SemanticType", - "traits": { - "smithy.api#documentation": "

The semantic type of data contained in the column.

" - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TopicTimeGranularity", - "traits": { - "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" - } - }, - "AllowedAggregations": { - "target": "com.amazonaws.quicksight#AuthorSpecifiedAggregations", - "traits": { - "smithy.api#documentation": "

The list of aggregation types that are allowed for the column. Valid values for this\n structure are COUNT, DISTINCT_COUNT, MIN,\n MAX, MEDIAN, SUM, AVERAGE,\n STDEV, STDEVP, VAR,\n VARP,\n and PERCENTILE.

" - } - }, - "NotAllowedAggregations": { - "target": "com.amazonaws.quicksight#AuthorSpecifiedAggregations", - "traits": { - "smithy.api#documentation": "

The list of aggregation types that are not allowed for the column. Valid values for this\n structure are COUNT, DISTINCT_COUNT, MIN,\n MAX, MEDIAN, SUM, AVERAGE,\n STDEV, STDEVP, VAR,\n VARP,\n and PERCENTILE.

" - } - }, - "DefaultFormatting": { - "target": "com.amazonaws.quicksight#DefaultFormatting", - "traits": { - "smithy.api#documentation": "

The default formatting used for values in the column.

" - } - }, - "NeverAggregateInFilter": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean\n value that indicates whether to aggregate the column data when\n it's used in a filter context.

" - } - }, - "CellValueSynonyms": { - "target": "com.amazonaws.quicksight#CellValueSynonyms", - "traits": { - "smithy.api#documentation": "

The other names or aliases for the column cell value.

" - } - }, - "NonAdditive": { - "target": "com.amazonaws.quicksight#NullableBoolean", - "traits": { - "smithy.api#documentation": "

The non additive value for the column.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a column in a dataset.

" - } - }, - "com.amazonaws.quicksight#TopicColumns": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicColumn" - } - }, - "com.amazonaws.quicksight#TopicConstantValue": { - "type": "structure", - "members": { - "ConstantType": { - "target": "com.amazonaws.quicksight#ConstantType", - "traits": { - "smithy.api#documentation": "

The constant type of a TopicConstantValue.

" - } - }, - "Value": { - "target": "com.amazonaws.quicksight#ConstantValueString", - "traits": { - "smithy.api#documentation": "

The value of the TopicConstantValue.

" - } - }, - "Minimum": { - "target": "com.amazonaws.quicksight#ConstantValueString", - "traits": { - "smithy.api#documentation": "

The minimum for the TopicConstantValue.

" - } - }, - "Maximum": { - "target": "com.amazonaws.quicksight#ConstantValueString", - "traits": { - "smithy.api#documentation": "

The maximum for the TopicConstantValue.

" - } - }, - "ValueList": { - "target": "com.amazonaws.quicksight#CollectiveConstantEntryList", - "traits": { - "smithy.api#documentation": "

The value list of the TopicConstantValue.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a TopicConstantValue.

" - } - }, - "com.amazonaws.quicksight#TopicDateRangeFilter": { - "type": "structure", - "members": { - "Inclusive": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates whether the date range filter should include the boundary values. If\n set to true, the filter includes the start and end dates. If set to false, the filter\n excludes them.

" - } - }, - "Constant": { - "target": "com.amazonaws.quicksight#TopicRangeFilterConstant", - "traits": { - "smithy.api#documentation": "

The constant used in a date range filter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A filter used to restrict data based on a range of dates or times.

" - } - }, - "com.amazonaws.quicksight#TopicDetails": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the topic.

" - } - }, - "Description": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The description of the topic.

" - } - }, - "UserExperienceVersion": { - "target": "com.amazonaws.quicksight#TopicUserExperienceVersion", - "traits": { - "smithy.api#documentation": "

The user experience version of a topic.

" - } - }, - "DataSets": { - "target": "com.amazonaws.quicksight#Datasets", - "traits": { - "smithy.api#documentation": "

The data sets that the topic is associated with.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that describes the details of a topic, such as its name, description, and associated data sets.

" - } - }, - "com.amazonaws.quicksight#TopicFilter": { - "type": "structure", - "members": { - "FilterDescription": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

A description of the filter used to select items for a topic.

" - } - }, - "FilterClass": { - "target": "com.amazonaws.quicksight#FilterClass", - "traits": { - "smithy.api#documentation": "

The class of the filter. Valid values for this structure are\n ENFORCED_VALUE_FILTER,\n CONDITIONAL_VALUE_FILTER,\n and NAMED_VALUE_FILTER.

" - } - }, - "FilterName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The name of the filter.

", - "smithy.api#required": {} - } - }, - "FilterSynonyms": { - "target": "com.amazonaws.quicksight#Synonyms", - "traits": { - "smithy.api#documentation": "

The other names or aliases for the filter.

" - } - }, - "OperandFieldName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The name of the field that the filter operates on.

", - "smithy.api#required": {} - } - }, - "FilterType": { - "target": "com.amazonaws.quicksight#NamedFilterType", - "traits": { - "smithy.api#documentation": "

The type of the filter. Valid values for this structure are\n CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER,\n NUMERIC_RANGE_FILTER,\n DATE_RANGE_FILTER,\n and RELATIVE_DATE_FILTER.

" - } - }, - "CategoryFilter": { - "target": "com.amazonaws.quicksight#TopicCategoryFilter", - "traits": { - "smithy.api#documentation": "

The category filter that is associated with this filter.

" - } - }, - "NumericEqualityFilter": { - "target": "com.amazonaws.quicksight#TopicNumericEqualityFilter", - "traits": { - "smithy.api#documentation": "

The numeric equality filter.

" - } - }, - "NumericRangeFilter": { - "target": "com.amazonaws.quicksight#TopicNumericRangeFilter", - "traits": { - "smithy.api#documentation": "

The numeric range filter.

" - } - }, - "DateRangeFilter": { - "target": "com.amazonaws.quicksight#TopicDateRangeFilter", - "traits": { - "smithy.api#documentation": "

The date range filter.

" - } - }, - "RelativeDateFilter": { - "target": "com.amazonaws.quicksight#TopicRelativeDateFilter", - "traits": { - "smithy.api#documentation": "

The relative date filter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a filter used to select items for a topic.

" - } - }, - "com.amazonaws.quicksight#TopicFilters": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicFilter" - } - }, - "com.amazonaws.quicksight#TopicIR": { - "type": "structure", - "members": { - "Metrics": { - "target": "com.amazonaws.quicksight#TopicIRMetricList", - "traits": { - "smithy.api#documentation": "

The metrics for the TopicIR.

" - } - }, - "GroupByList": { - "target": "com.amazonaws.quicksight#TopicIRGroupByList", - "traits": { - "smithy.api#documentation": "

The GroupBy list for the TopicIR.

" - } - }, - "Filters": { - "target": "com.amazonaws.quicksight#TopicIRFilterList", - "traits": { - "smithy.api#documentation": "

The filters for the TopicIR.

" - } - }, - "Sort": { - "target": "com.amazonaws.quicksight#TopicSortClause", - "traits": { - "smithy.api#documentation": "

The sort for the TopicIR.

" - } - }, - "ContributionAnalysis": { - "target": "com.amazonaws.quicksight#TopicIRContributionAnalysis", - "traits": { - "smithy.api#documentation": "

The contribution analysis for the TopicIR.

" - } - }, - "Visual": { - "target": "com.amazonaws.quicksight#VisualOptions", - "traits": { - "smithy.api#documentation": "

The visual for the TopicIR.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a TopicIR.

" - } - }, - "com.amazonaws.quicksight#TopicIRComparisonMethod": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.quicksight#ComparisonMethodType", - "traits": { - "smithy.api#documentation": "

The type for the TopicIRComparisonMethod.

" - } - }, - "Period": { - "target": "com.amazonaws.quicksight#TopicTimeGranularity", - "traits": { - "smithy.api#documentation": "

The period for the TopicIRComparisonMethod.

" - } - }, - "WindowSize": { - "target": "com.amazonaws.quicksight#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The window size for the TopicIRComparisonMethod.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition of a TopicIRComparisonMethod.

" - } - }, - "com.amazonaws.quicksight#TopicIRContributionAnalysis": { - "type": "structure", - "members": { - "Factors": { - "target": "com.amazonaws.quicksight#ContributionAnalysisFactorsList", - "traits": { - "smithy.api#documentation": "

The factors for a TopicIRContributionAnalysis.

" - } - }, - "TimeRanges": { - "target": "com.amazonaws.quicksight#ContributionAnalysisTimeRanges", - "traits": { - "smithy.api#documentation": "

The time ranges for the TopicIRContributionAnalysis.

" - } - }, - "Direction": { - "target": "com.amazonaws.quicksight#ContributionAnalysisDirection", - "traits": { - "smithy.api#documentation": "

The direction for the TopicIRContributionAnalysis.

" - } - }, - "SortType": { - "target": "com.amazonaws.quicksight#ContributionAnalysisSortType", - "traits": { - "smithy.api#documentation": "

The sort type for the TopicIRContributionAnalysis.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a TopicIRContributionAnalysis.

" - } - }, - "com.amazonaws.quicksight#TopicIRFilterEntry": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicIRFilterOption" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2000 - } - } - }, - "com.amazonaws.quicksight#TopicIRFilterFunction": { - "type": "enum", - "members": { - "CONTAINS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTAINS" - } - }, - "EXACT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXACT" - } - }, - "STARTS_WITH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTS_WITH" - } - }, - "ENDS_WITH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENDS_WITH" - } - }, - "CONTAINS_STRING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTAINS_STRING" - } - }, - "PREVIOUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PREVIOUS" - } - }, - "THIS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THIS" - } - }, - "LAST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAST" - } - }, - "NEXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEXT" - } - }, - "NOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOW" - } - } - } - }, - "com.amazonaws.quicksight#TopicIRFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicIRFilterEntry" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2000 - } - } - }, - "com.amazonaws.quicksight#TopicIRFilterOption": { - "type": "structure", - "members": { - "FilterType": { - "target": "com.amazonaws.quicksight#TopicIRFilterType", - "traits": { - "smithy.api#documentation": "

The filter type for the TopicIRFilterOption.

" - } - }, - "FilterClass": { - "target": "com.amazonaws.quicksight#FilterClass", - "traits": { - "smithy.api#documentation": "

The filter class for the TopicIRFilterOption.

" - } - }, - "OperandField": { - "target": "com.amazonaws.quicksight#Identifier", - "traits": { - "smithy.api#documentation": "

The operand field for the TopicIRFilterOption.

" - } - }, - "Function": { - "target": "com.amazonaws.quicksight#TopicIRFilterFunction", - "traits": { - "smithy.api#documentation": "

The function for the TopicIRFilterOption.

" - } - }, - "Constant": { - "target": "com.amazonaws.quicksight#TopicConstantValue", - "traits": { - "smithy.api#documentation": "

The constant for the TopicIRFilterOption.

" - } - }, - "Inverse": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The inverse for the TopicIRFilterOption.

" - } - }, - "NullFilter": { - "target": "com.amazonaws.quicksight#NullFilterOption", - "traits": { - "smithy.api#documentation": "

The null filter for the TopicIRFilterOption.

" - } - }, - "Aggregation": { - "target": "com.amazonaws.quicksight#AggType", - "traits": { - "smithy.api#documentation": "

The aggregation for the TopicIRFilterOption.

" - } - }, - "AggregationFunctionParameters": { - "target": "com.amazonaws.quicksight#AggFunctionParamMap", - "traits": { - "smithy.api#documentation": "

The aggregation function parameters for the TopicIRFilterOption.

" - } - }, - "AggregationPartitionBy": { - "target": "com.amazonaws.quicksight#AggregationPartitionByList", - "traits": { - "smithy.api#documentation": "

The AggregationPartitionBy for the TopicIRFilterOption.

" - } - }, - "Range": { - "target": "com.amazonaws.quicksight#TopicConstantValue", - "traits": { - "smithy.api#documentation": "

The range for the TopicIRFilterOption.

" - } - }, - "Inclusive": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The inclusive for the TopicIRFilterOption.

" - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The time granularity for the TopicIRFilterOption.

" - } - }, - "LastNextOffset": { - "target": "com.amazonaws.quicksight#TopicConstantValue", - "traits": { - "smithy.api#documentation": "

The last next offset for the TopicIRFilterOption.

" - } - }, - "AggMetrics": { - "target": "com.amazonaws.quicksight#FilterAggMetricsList", - "traits": { - "smithy.api#documentation": "

The agg metrics for the TopicIRFilterOption.

" - } - }, - "TopBottomLimit": { - "target": "com.amazonaws.quicksight#TopicConstantValue", - "traits": { - "smithy.api#documentation": "

The TopBottomLimit for the TopicIRFilterOption.

" - } - }, - "SortDirection": { - "target": "com.amazonaws.quicksight#TopicSortDirection", - "traits": { - "smithy.api#documentation": "

The sort direction for the TopicIRFilterOption.

" - } - }, - "Anchor": { - "target": "com.amazonaws.quicksight#Anchor", - "traits": { - "smithy.api#documentation": "

The anchor for the TopicIRFilterOption.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a TopicIRFilterOption.

" - } - }, - "com.amazonaws.quicksight#TopicIRFilterType": { - "type": "enum", - "members": { - "CATEGORY_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CATEGORY_FILTER" - } - }, - "NUMERIC_EQUALITY_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NUMERIC_EQUALITY_FILTER" - } - }, - "NUMERIC_RANGE_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NUMERIC_RANGE_FILTER" - } - }, - "DATE_RANGE_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATE_RANGE_FILTER" - } - }, - "RELATIVE_DATE_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RELATIVE_DATE_FILTER" - } - }, - "TOP_BOTTOM_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TOP_BOTTOM_FILTER" - } - }, - "EQUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EQUALS" - } - }, - "RANK_LIMIT_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RANK_LIMIT_FILTER" - } - }, - "ACCEPT_ALL_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCEPT_ALL_FILTER" - } - } - } - }, - "com.amazonaws.quicksight#TopicIRGroupBy": { - "type": "structure", - "members": { - "FieldName": { - "target": "com.amazonaws.quicksight#Identifier", - "traits": { - "smithy.api#documentation": "

The field name for the TopicIRGroupBy.

" - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TopicTimeGranularity", - "traits": { - "smithy.api#documentation": "

The time granularity for the TopicIRGroupBy.

" - } - }, - "Sort": { - "target": "com.amazonaws.quicksight#TopicSortClause", - "traits": { - "smithy.api#documentation": "

The sort for the TopicIRGroupBy.

" - } - }, - "DisplayFormat": { - "target": "com.amazonaws.quicksight#DisplayFormat", - "traits": { - "smithy.api#documentation": "

The display format for the TopicIRGroupBy.

" - } - }, - "DisplayFormatOptions": { - "target": "com.amazonaws.quicksight#DisplayFormatOptions" - }, - "NamedEntity": { - "target": "com.amazonaws.quicksight#NamedEntityRef", - "traits": { - "smithy.api#documentation": "

The named entity for the TopicIRGroupBy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a TopicIRGroupBy.

" - } - }, - "com.amazonaws.quicksight#TopicIRGroupByList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicIRGroupBy" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2000 - } - } - }, - "com.amazonaws.quicksight#TopicIRMetric": { - "type": "structure", - "members": { - "MetricId": { - "target": "com.amazonaws.quicksight#Identifier", - "traits": { - "smithy.api#documentation": "

The metric ID for the TopicIRMetric.

" - } - }, - "Function": { - "target": "com.amazonaws.quicksight#AggFunction", - "traits": { - "smithy.api#documentation": "

The function for the TopicIRMetric.

" - } - }, - "Operands": { - "target": "com.amazonaws.quicksight#OperandList", - "traits": { - "smithy.api#documentation": "

The operands for the TopicIRMetric.

" - } - }, - "ComparisonMethod": { - "target": "com.amazonaws.quicksight#TopicIRComparisonMethod", - "traits": { - "smithy.api#documentation": "

The comparison method for the TopicIRMetric.

" - } - }, - "Expression": { - "target": "com.amazonaws.quicksight#Expression", - "traits": { - "smithy.api#documentation": "

The expression for the TopicIRMetric.

" - } - }, - "CalculatedFieldReferences": { - "target": "com.amazonaws.quicksight#CalculatedFieldReferenceList", - "traits": { - "smithy.api#documentation": "

The calculated field references for the TopicIRMetric.

" - } - }, - "DisplayFormat": { - "target": "com.amazonaws.quicksight#DisplayFormat", - "traits": { - "smithy.api#documentation": "

The display format for the TopicIRMetric.

" - } - }, - "DisplayFormatOptions": { - "target": "com.amazonaws.quicksight#DisplayFormatOptions" - }, - "NamedEntity": { - "target": "com.amazonaws.quicksight#NamedEntityRef", - "traits": { - "smithy.api#documentation": "

The named entity for the TopicIRMetric.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a TopicIRMetric.

" - } - }, - "com.amazonaws.quicksight#TopicIRMetricList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicIRMetric" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2000 - } - } - }, - "com.amazonaws.quicksight#TopicId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[A-Za-z0-9-_.\\\\+]*$" - } - }, - "com.amazonaws.quicksight#TopicNamedEntities": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicNamedEntity" - } - }, - "com.amazonaws.quicksight#TopicNamedEntity": { - "type": "structure", - "members": { - "EntityName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The name of the named entity.

", - "smithy.api#required": {} - } - }, - "EntityDescription": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The description of the named entity.

" - } - }, - "EntitySynonyms": { - "target": "com.amazonaws.quicksight#Synonyms", - "traits": { - "smithy.api#documentation": "

The other\n names or aliases for the named entity.

" - } - }, - "SemanticEntityType": { - "target": "com.amazonaws.quicksight#SemanticEntityType", - "traits": { - "smithy.api#documentation": "

The type of named entity that a topic represents.

" - } - }, - "Definition": { - "target": "com.amazonaws.quicksight#NamedEntityDefinitions", - "traits": { - "smithy.api#documentation": "

The definition of a named entity.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a named entity.

" - } - }, - "com.amazonaws.quicksight#TopicNumericEqualityFilter": { - "type": "structure", - "members": { - "Constant": { - "target": "com.amazonaws.quicksight#TopicSingularFilterConstant", - "traits": { - "smithy.api#documentation": "

The constant used in a numeric equality filter.

" - } - }, - "Aggregation": { - "target": "com.amazonaws.quicksight#NamedFilterAggType", - "traits": { - "smithy.api#documentation": "

An aggregation function that specifies how to calculate the value of a numeric field for\n a topic. Valid values for this structure are NO_AGGREGATION, SUM,\n AVERAGE, COUNT, DISTINCT_COUNT, MAX,\n MEDIAN, MIN, STDEV, STDEVP,\n VAR,\n and VARP.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value matches the specified value.

" - } - }, - "com.amazonaws.quicksight#TopicNumericRangeFilter": { - "type": "structure", - "members": { - "Inclusive": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates whether the endpoints of the numeric range are included in the filter.\n If set to true, topics whose numeric field value is equal to the endpoint values will be\n included in the filter. If set to false, topics whose numeric field value is equal to the\n endpoint values will be excluded from the filter.

" - } - }, - "Constant": { - "target": "com.amazonaws.quicksight#TopicRangeFilterConstant", - "traits": { - "smithy.api#documentation": "

The constant used in a\n numeric range filter.

" - } - }, - "Aggregation": { - "target": "com.amazonaws.quicksight#NamedFilterAggType", - "traits": { - "smithy.api#documentation": "

An aggregation function that specifies how to calculate the value of a numeric field for\n a topic, Valid values for this structure are NO_AGGREGATION, SUM,\n AVERAGE, COUNT, DISTINCT_COUNT, MAX,\n MEDIAN, MIN, STDEV, STDEVP,\n VAR,\n and VARP.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value falls within the specified range.

" - } - }, - "com.amazonaws.quicksight#TopicNumericSeparatorSymbol": { - "type": "enum", - "members": { - "COMMA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMMA" - } - }, - "DOT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOT" - } - } - } - }, - "com.amazonaws.quicksight#TopicRangeFilterConstant": { - "type": "structure", - "members": { - "ConstantType": { - "target": "com.amazonaws.quicksight#ConstantType", - "traits": { - "smithy.api#documentation": "

The data type of the constant value that is used in a range filter. Valid values for this structure are RANGE.

" - } - }, - "RangeConstant": { - "target": "com.amazonaws.quicksight#RangeConstant", - "traits": { - "smithy.api#documentation": "

The value of the constant that is used to specify the endpoints of a range filter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A constant value that is used in a range filter to specify the endpoints of the range.

", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#TopicRefreshDetails": { - "type": "structure", - "members": { - "RefreshArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic refresh.

" - } - }, - "RefreshId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the refresh, which occurs as a result of topic creation or topic update.

" - } - }, - "RefreshStatus": { - "target": "com.amazonaws.quicksight#TopicRefreshStatus", - "traits": { - "smithy.api#documentation": "

The status of the refresh job that indicates whether the job is still running, completed successfully, or failed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The details about the refresh of a topic.

" - } - }, - "com.amazonaws.quicksight#TopicRefreshSchedule": { - "type": "structure", - "members": { - "IsEnabled": { - "target": "com.amazonaws.quicksight#NullableBoolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that controls whether to schedule is enabled.

", - "smithy.api#required": {} - } - }, - "BasedOnSpiceSchedule": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that controls whether to schedule runs at the same schedule that is specified in\n SPICE dataset.

", - "smithy.api#required": {} - } - }, - "StartingAt": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The starting date and time for the refresh schedule.

" - } - }, - "Timezone": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The timezone that you want the refresh schedule to use.

" - } - }, - "RepeatAt": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The time of day when the refresh should run, for\n example, Monday-Sunday.

" - } - }, - "TopicScheduleType": { - "target": "com.amazonaws.quicksight#TopicScheduleType", - "traits": { - "smithy.api#documentation": "

The type of refresh schedule. Valid values for this structure are HOURLY,\n DAILY,\n WEEKLY,\n and MONTHLY.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a topic refresh schedule.

" - } - }, - "com.amazonaws.quicksight#TopicRefreshScheduleSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicRefreshScheduleSummary" - } - }, - "com.amazonaws.quicksight#TopicRefreshScheduleSummary": { - "type": "structure", - "members": { - "DatasetId": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

" - } - }, - "DatasetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "DatasetName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The name of the dataset.

" - } - }, - "RefreshSchedule": { - "target": "com.amazonaws.quicksight#TopicRefreshSchedule", - "traits": { - "smithy.api#documentation": "

The definition of a refresh schedule.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A summary of the refresh schedule details for a dataset.

" - } - }, - "com.amazonaws.quicksight#TopicRefreshStatus": { - "type": "enum", - "members": { - "INITIALIZED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INITIALIZED" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLED" - } - } - } - }, - "com.amazonaws.quicksight#TopicRelativeDateFilter": { - "type": "structure", - "members": { - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TopicTimeGranularity", - "traits": { - "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" - } - }, - "RelativeDateFilterFunction": { - "target": "com.amazonaws.quicksight#TopicRelativeDateFilterFunction", - "traits": { - "smithy.api#documentation": "

The function to be used in a relative date filter to determine the range of dates to include in the results. Valid values for this structure are BEFORE, AFTER, and BETWEEN.

" - } - }, - "Constant": { - "target": "com.amazonaws.quicksight#TopicSingularFilterConstant", - "traits": { - "smithy.api#documentation": "

The constant used in a\n relative date filter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a relative date filter.

" - } - }, - "com.amazonaws.quicksight#TopicRelativeDateFilterFunction": { - "type": "enum", - "members": { - "PREVIOUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PREVIOUS" - } - }, - "THIS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THIS" - } - }, - "LAST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAST" - } - }, - "NEXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEXT" - } - }, - "NOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOW" - } - } - } - }, - "com.amazonaws.quicksight#TopicReviewedAnswer": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the reviewed answer.

" - } - }, - "AnswerId": { - "target": "com.amazonaws.quicksight#AnswerId", - "traits": { - "smithy.api#documentation": "

The answer ID of the reviewed answer.

", - "smithy.api#required": {} - } - }, - "DatasetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Dataset ARN for the TopicReviewedAnswer.

", - "smithy.api#required": {} - } - }, - "Question": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The question for the TopicReviewedAnswer.

", - "smithy.api#required": {} - } - }, - "Mir": { - "target": "com.amazonaws.quicksight#TopicIR", - "traits": { - "smithy.api#documentation": "

The mir for the TopicReviewedAnswer.

" - } - }, - "PrimaryVisual": { - "target": "com.amazonaws.quicksight#TopicVisual", - "traits": { - "smithy.api#documentation": "

The primary visual for the TopicReviewedAnswer.

" - } - }, - "Template": { - "target": "com.amazonaws.quicksight#TopicTemplate", - "traits": { - "smithy.api#documentation": "

The template for the TopicReviewedAnswer.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The deinition for a TopicReviewedAnswer.

" - } - }, - "com.amazonaws.quicksight#TopicReviewedAnswers": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicReviewedAnswer" - } - }, - "com.amazonaws.quicksight#TopicScheduleType": { - "type": "enum", - "members": { - "HOURLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOURLY" - } - }, - "DAILY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DAILY" - } - }, - "WEEKLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WEEKLY" - } - }, - "MONTHLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MONTHLY" - } - } - } - }, - "com.amazonaws.quicksight#TopicSingularFilterConstant": { - "type": "structure", - "members": { - "ConstantType": { - "target": "com.amazonaws.quicksight#ConstantType", - "traits": { - "smithy.api#documentation": "

The type of the singular filter constant. Valid values for this structure are SINGULAR.

" - } - }, - "SingularConstant": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The value of the singular filter constant.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a singular filter constant, used in filters to specify a single value to match against.

", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#TopicSortClause": { - "type": "structure", - "members": { - "Operand": { - "target": "com.amazonaws.quicksight#Identifier", - "traits": { - "smithy.api#documentation": "

The operand for a TopicSortClause.

" - } - }, - "SortDirection": { - "target": "com.amazonaws.quicksight#TopicSortDirection", - "traits": { - "smithy.api#documentation": "

The sort direction for the TopicSortClause.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a TopicSortClause.

" - } - }, - "com.amazonaws.quicksight#TopicSortDirection": { - "type": "enum", - "members": { - "ASCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASCENDING" - } - }, - "DESCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DESCENDING" - } - } - } - }, - "com.amazonaws.quicksight#TopicSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicSummary" - } - }, - "com.amazonaws.quicksight#TopicSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID for the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the topic.

" - } - }, - "UserExperienceVersion": { - "target": "com.amazonaws.quicksight#TopicUserExperienceVersion", - "traits": { - "smithy.api#documentation": "

The user experience version of the topic.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A topic summary.

" - } - }, - "com.amazonaws.quicksight#TopicTemplate": { - "type": "structure", - "members": { - "TemplateType": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The template type for the TopicTemplate.

" - } - }, - "Slots": { - "target": "com.amazonaws.quicksight#Slots", - "traits": { - "smithy.api#documentation": "

The slots for the TopicTemplate.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a TopicTemplate.

" - } - }, - "com.amazonaws.quicksight#TopicTimeGranularity": { - "type": "enum", - "members": { - "SECOND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SECOND" - } - }, - "MINUTE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MINUTE" - } - }, - "HOUR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOUR" - } - }, - "DAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DAY" - } - }, - "WEEK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WEEK" - } - }, - "MONTH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MONTH" - } - }, - "QUARTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUARTER" - } - }, - "YEAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "YEAR" - } - } - } - }, - "com.amazonaws.quicksight#TopicUserExperienceVersion": { - "type": "enum", - "members": { - "LEGACY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LEGACY" - } - }, - "NEW_READER_EXPERIENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEW_READER_EXPERIENCE" - } - } - } - }, - "com.amazonaws.quicksight#TopicVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The visual ID for the TopicVisual.

" - } - }, - "Role": { - "target": "com.amazonaws.quicksight#VisualRole", - "traits": { - "smithy.api#documentation": "

The role for the TopicVisual.

" - } - }, - "Ir": { - "target": "com.amazonaws.quicksight#TopicIR", - "traits": { - "smithy.api#documentation": "

The ir for the TopicVisual.

" - } - }, - "SupportingVisuals": { - "target": "com.amazonaws.quicksight#TopicVisuals", - "traits": { - "smithy.api#documentation": "

The supporting visuals for the TopicVisual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a TopicVisual.

" - } - }, - "com.amazonaws.quicksight#TopicVisuals": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicVisual" - } - }, - "com.amazonaws.quicksight#TotalAggregationComputation": { - "type": "structure", - "members": { - "ComputationId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for a computation.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of a computation.

" - } - }, - "Value": { - "target": "com.amazonaws.quicksight#MeasureField", - "traits": { - "smithy.api#documentation": "

The value field that is used in a computation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The total aggregation computation configuration.

" - } - }, - "com.amazonaws.quicksight#TotalAggregationFunction": { - "type": "structure", - "members": { - "SimpleTotalAggregationFunction": { - "target": "com.amazonaws.quicksight#SimpleTotalAggregationFunction", - "traits": { - "smithy.api#documentation": "

A built in aggregation function for total values.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An aggregation function that aggregates the total values of a measure.

" - } - }, - "com.amazonaws.quicksight#TotalAggregationOption": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field id that's associated with the total aggregation option.

", - "smithy.api#required": {} - } - }, - "TotalAggregationFunction": { - "target": "com.amazonaws.quicksight#TotalAggregationFunction", - "traits": { - "smithy.api#documentation": "

The total aggregation function that you want to set for a specified field id.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The total aggregation settings map of a field id.

" - } - }, - "com.amazonaws.quicksight#TotalAggregationOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TotalAggregationOption" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#TotalOptions": { - "type": "structure", - "members": { - "TotalsVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility configuration for the total cells.

" - } - }, - "Placement": { - "target": "com.amazonaws.quicksight#TableTotalsPlacement", - "traits": { - "smithy.api#documentation": "

The placement (start, end) for the total cells.

" - } - }, - "ScrollStatus": { - "target": "com.amazonaws.quicksight#TableTotalsScrollStatus", - "traits": { - "smithy.api#documentation": "

The scroll status (pinned, scrolled) for the total cells.

" - } - }, - "CustomLabel": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The custom label string for the total cells.

" - } - }, - "TotalCellStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

Cell styling options for the total cells.

" - } - }, - "TotalAggregationOptions": { - "target": "com.amazonaws.quicksight#TotalAggregationOptionList", - "traits": { - "smithy.api#documentation": "

The total aggregation settings for each value field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The total options for a table visual.

" - } - }, - "com.amazonaws.quicksight#TransformOperation": { - "type": "union", - "members": { - "ProjectOperation": { - "target": "com.amazonaws.quicksight#ProjectOperation", - "traits": { - "smithy.api#documentation": "

An operation that projects columns. Operations that come after a projection can only\n refer to projected columns.

" - } - }, - "FilterOperation": { - "target": "com.amazonaws.quicksight#FilterOperation", - "traits": { - "smithy.api#documentation": "

An operation that filters rows based on some condition.

" - } - }, - "CreateColumnsOperation": { - "target": "com.amazonaws.quicksight#CreateColumnsOperation", - "traits": { - "smithy.api#documentation": "

An operation that creates calculated columns. Columns created in one such operation\n form a lexical closure.

" - } - }, - "RenameColumnOperation": { - "target": "com.amazonaws.quicksight#RenameColumnOperation", - "traits": { - "smithy.api#documentation": "

An operation that renames a column.

" - } - }, - "CastColumnTypeOperation": { - "target": "com.amazonaws.quicksight#CastColumnTypeOperation", - "traits": { - "smithy.api#documentation": "

A transform operation that casts a column to a different type.

" - } - }, - "TagColumnOperation": { - "target": "com.amazonaws.quicksight#TagColumnOperation", - "traits": { - "smithy.api#documentation": "

An operation that tags a column with additional information.

" - } - }, - "UntagColumnOperation": { - "target": "com.amazonaws.quicksight#UntagColumnOperation" - }, - "OverrideDatasetParameterOperation": { - "target": "com.amazonaws.quicksight#OverrideDatasetParameterOperation" - } - }, - "traits": { - "smithy.api#documentation": "

A data transformation on a logical table. This is a variant type structure. For this\n structure to be valid, only one of the attributes can be non-null.

" - } - }, - "com.amazonaws.quicksight#TransformOperationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TransformOperation" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#TreeMapAggregatedFieldWells": { - "type": "structure", - "members": { - "Groups": { - "target": "com.amazonaws.quicksight#TreeMapDimensionFieldList", - "traits": { - "smithy.api#documentation": "

The group by field well of a tree map. Values are grouped based on group by fields.

" - } - }, - "Sizes": { - "target": "com.amazonaws.quicksight#TreeMapMeasureFieldList", - "traits": { - "smithy.api#documentation": "

The size field well of a tree map. Values are aggregated based on group by fields.

" - } - }, - "Colors": { - "target": "com.amazonaws.quicksight#TreeMapMeasureFieldList", - "traits": { - "smithy.api#documentation": "

The color field well of a tree map. Values are grouped by aggregations based on group by fields.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Aggregated field wells of a tree map.

" - } - }, - "com.amazonaws.quicksight#TreeMapConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#TreeMapFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#TreeMapSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a tree map.

" - } - }, - "GroupLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility) of the groups that are displayed in a tree map.

" - } - }, - "SizeLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility) of the sizes that are displayed in a tree map.

" - } - }, - "ColorLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility) for the colors displayed in a tree map.

" - } - }, - "ColorScale": { - "target": "com.amazonaws.quicksight#ColorScale", - "traits": { - "smithy.api#documentation": "

The color options (gradient color, point of divergence) of a tree map.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "

The legend display setup of the visual.

" - } - }, - "DataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The tooltip display setup of the visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a tree map.

" - } - }, - "com.amazonaws.quicksight#TreeMapDimensionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DimensionField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#TreeMapFieldWells": { - "type": "structure", - "members": { - "TreeMapAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#TreeMapAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a tree map.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field wells of a tree map.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#TreeMapMeasureFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MeasureField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#TreeMapSortConfiguration": { - "type": "structure", - "members": { - "TreeMapSort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of group by fields.

" - } - }, - "TreeMapGroupItemsLimitConfiguration": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of groups that are displayed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a tree map.

" - } - }, - "com.amazonaws.quicksight#TreeMapVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#TreeMapConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the visual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A tree map.

\n

For more information, see Using tree maps in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#TrendArrowOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the trend arrows.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of trend arrows in a KPI visual.

" - } - }, - "com.amazonaws.quicksight#TrinoParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

The host name of the Trino data source.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

The port for the Trino data source.

", - "smithy.api#required": {} - } - }, - "Catalog": { - "target": "com.amazonaws.quicksight#Catalog", - "traits": { - "smithy.api#documentation": "

The catalog name for the Trino data source.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters that are required to connect to a Trino data source.

" - } - }, - "com.amazonaws.quicksight#TwitterParameters": { - "type": "structure", - "members": { - "Query": { - "target": "com.amazonaws.quicksight#Query", - "traits": { - "smithy.api#documentation": "

Twitter query string.

", - "smithy.api#required": {} - } - }, - "MaxRows": { - "target": "com.amazonaws.quicksight#PositiveInteger", - "traits": { - "smithy.api#documentation": "

Maximum number of rows to query Twitter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for Twitter.

" - } - }, - "com.amazonaws.quicksight#TypeCastFormat": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 32 - } - } - }, - "com.amazonaws.quicksight#TypeParameters": { - "type": "map", - "key": { - "target": "com.amazonaws.quicksight#LimitedString" - }, - "value": { - "target": "com.amazonaws.quicksight#LimitedString" - } - }, - "com.amazonaws.quicksight#Typography": { - "type": "structure", - "members": { - "FontFamilies": { - "target": "com.amazonaws.quicksight#FontList", - "traits": { - "smithy.api#documentation": "

Determines the list of font families.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines the typography options.

" - } - }, - "com.amazonaws.quicksight#UIColorPalette": { - "type": "structure", - "members": { - "PrimaryForeground": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color of text and other foreground elements that appear over the primary\n background regions, such as grid lines, borders, table banding, icons, and so on.

" - } - }, - "PrimaryBackground": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The background color that applies to visuals and other high emphasis UI.

" - } - }, - "SecondaryForeground": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The foreground color that applies to any sheet title, sheet control text, or UI that\n appears over the secondary background.

" - } - }, - "SecondaryBackground": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The background color that applies to the sheet background and sheet controls.

" - } - }, - "Accent": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

This color is that applies to selected states and buttons.

" - } - }, - "AccentForeground": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n accent color.

" - } - }, - "Danger": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color that applies to error messages.

" - } - }, - "DangerForeground": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n error color.

" - } - }, - "Warning": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

This color that applies to warning and informational messages.

" - } - }, - "WarningForeground": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n warning color.

" - } - }, - "Success": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color that applies to success messages, for example the check mark for a\n successful download.

" - } - }, - "SuccessForeground": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n success color.

" - } - }, - "Dimension": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color that applies to the names of fields that are identified as\n dimensions.

" - } - }, - "DimensionForeground": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n dimension color.

" - } - }, - "Measure": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color that applies to the names of fields that are identified as measures.

" - } - }, - "MeasureForeground": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n measure color.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The theme colors that apply to UI and to charts, excluding data colors. The colors\n description is a hexadecimal color code that consists of six alphanumerical characters,\n prefixed with #, for example #37BFF5. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User\n Guide.\n

" - } - }, - "com.amazonaws.quicksight#URLOperationTemplate": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#URLTargetConfiguration": { - "type": "enum", - "members": { - "NEW_TAB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEW_TAB" - } - }, - "NEW_WINDOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEW_WINDOW" - } - }, - "SAME_TAB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SAME_TAB" - } - } - } - }, - "com.amazonaws.quicksight#UnaggregatedField": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The custom field ID.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that is used in the UnaggregatedField.

", - "smithy.api#required": {} - } - }, - "FormatConfiguration": { - "target": "com.amazonaws.quicksight#FormatConfiguration", - "traits": { - "smithy.api#documentation": "

The format configuration of the field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The unaggregated field for a table.

" - } - }, - "com.amazonaws.quicksight#UnaggregatedFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#UnaggregatedField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#UndefinedSpecifiedValueType": { - "type": "enum", - "members": { - "LEAST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LEAST" - } - }, - "MOST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MOST" - } - } - } - }, - "com.amazonaws.quicksight#UnicodeIcon": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[^\\u0000-\\u00FF]$" - } - }, - "com.amazonaws.quicksight#UniqueValuesComputation": { - "type": "structure", - "members": { - "ComputationId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for a computation.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of a computation.

" - } - }, - "Category": { - "target": "com.amazonaws.quicksight#DimensionField", - "traits": { - "smithy.api#documentation": "

The category field that is used in a computation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The unique values computation configuration.

" - } - }, - "com.amazonaws.quicksight#UnlimitedPixelLength": { - "type": "string", - "traits": { - "smithy.api#documentation": "String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value" - } - }, - "com.amazonaws.quicksight#UnsupportedPricingPlanException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This error indicates that you are calling an embedding operation in Amazon QuickSight\n\t\t\twithout the required pricing plan on your Amazon Web Services account. Before you can use embedding \n\t\t\tfor anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You \n\t\t can do this on the Manage Amazon QuickSight page.

\n

After capacity pricing is added, you can use the \n \n GetDashboardEmbedUrl\n API operation with the \n --identity-type ANONYMOUS option.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.quicksight#UnsupportedUserEditionException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This error indicates that you are calling an operation on an Amazon QuickSight\n\t\t\tsubscription where the edition doesn't include support for that operation. Amazon\n\t\t\tAmazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and\n\t\t\tcapability is available in every edition.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.quicksight#UntagColumnOperation": { - "type": "structure", - "members": { - "ColumnName": { - "target": "com.amazonaws.quicksight#ColumnName", - "traits": { - "smithy.api#documentation": "

The column that this operation acts on.

", - "smithy.api#required": {} - } - }, - "TagNames": { - "target": "com.amazonaws.quicksight#ColumnTagNames", - "traits": { - "smithy.api#documentation": "

The column tags to remove from this column.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A transform operation that removes tags associated with a column.

" - } - }, - "com.amazonaws.quicksight#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes a tag or tags from a resource.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/resources/{ResourceArn}/tags", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UntagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to untag.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.quicksight#TagKeyList", - "traits": { - "smithy.api#documentation": "

The keys of the key-value pairs for the resource tag or tags assigned to the resource.

", - "smithy.api#httpQuery": "keys", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UntagResourceResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateAccountCustomization": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateAccountCustomizationRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateAccountCustomizationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.

\n

You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a\n Amazon QuickSight namespace instead. Customizations that apply to a namespace override\n customizations that apply to an Amazon Web Services account. To find out which customizations apply, use\n the DescribeAccountCustomization API operation.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/customizations", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateAccountCustomizationRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations\n for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that you want to update Amazon QuickSight customizations for.

", - "smithy.api#httpQuery": "namespace" - } - }, - "AccountCustomization": { - "target": "com.amazonaws.quicksight#AccountCustomization", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateAccountCustomizationResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.

" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations\n for.

" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace associated with the customization that you're updating.

" - } - }, - "AccountCustomization": { - "target": "com.amazonaws.quicksight#AccountCustomization", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateAccountSettings": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateAccountSettingsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateAccountSettingsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the Amazon QuickSight settings in your Amazon Web Services account.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/settings", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateAccountSettingsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to\n list.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DefaultNamespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The default namespace for this Amazon Web Services account. Currently, the default is\n default. IAM users that\n register for the first time with Amazon QuickSight provide an email address that becomes\n associated with the default namespace.\n

", - "smithy.api#required": {} - } - }, - "NotificationEmail": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The email address that you want Amazon QuickSight to send notifications to regarding your\n Amazon Web Services account or Amazon QuickSight subscription.

" - } - }, - "TerminationProtectionEnabled": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription request. A False value will allow the account to be deleted.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateAccountSettingsResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateAnalysis": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateAnalysisRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateAnalysisResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an analysis in Amazon QuickSight

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateAnalysisPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateAnalysisPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateAnalysisPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the read and write permissions for an analysis.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateAnalysisPermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis whose permissions you're\n updating. You must be using the Amazon Web Services account that the analysis is in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis whose permissions you're updating. The ID is part of the\n analysis URL.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "GrantPermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A structure that describes the permissions to add and the principal to add them\n to.

" - } - }, - "RevokePermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A structure that describes the permissions to remove and the principal to remove them\n from.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateAnalysisPermissionsResponse": { - "type": "structure", - "members": { - "AnalysisArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the analysis that you updated.

" - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis that you updated permissions for.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A structure that describes the principals and the resource-level permissions on an\n analysis.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateAnalysisRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis that you're updating.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the analysis that you're updating. This ID displays in the URL of the\n analysis.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#AnalysisName", - "traits": { - "smithy.api#documentation": "

A descriptive name for the analysis that you're updating. This name displays for the\n analysis in the Amazon QuickSight console.

", - "smithy.api#required": {} - } - }, - "Parameters": { - "target": "com.amazonaws.quicksight#Parameters", - "traits": { - "smithy.api#documentation": "

The parameter names and override values that you want to use. An analysis can have \n any parameter type, and some parameters might accept multiple values.

" - } - }, - "SourceEntity": { - "target": "com.amazonaws.quicksight#AnalysisSourceEntity", - "traits": { - "smithy.api#documentation": "

A source entity to use for the analysis that you're updating. This metadata structure\n contains details that describe a source template and one or more datasets.

" - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're\n creating. To see the theme in the Amazon QuickSight console, make sure that you have access to\n it.

" - } - }, - "Definition": { - "target": "com.amazonaws.quicksight#AnalysisDefinition", - "traits": { - "smithy.api#documentation": "

The definition of an analysis.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" - } - }, - "ValidationStrategy": { - "target": "com.amazonaws.quicksight#ValidationStrategy", - "traits": { - "smithy.api#documentation": "

The option to relax the validation needed to update an analysis with definition objects. This skips the validation step for specific errors.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateAnalysisResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the analysis that you're updating.

" - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis.

" - } - }, - "UpdateStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The update status of the last update that was made to the analysis.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateDashboard": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateDashboardRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateDashboardResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a dashboard in an Amazon Web Services account.

\n \n

Updating a Dashboard creates a new dashboard version but does not immediately publish\n the new version. You can update the published version of a dashboard by\n using the \n UpdateDashboardPublishedVersion\n API operation.

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateDashboardLinks": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateDashboardLinksRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateDashboardLinksResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the linked analyses on a dashboard.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/linked-entities", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateDashboardLinksRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard whose links you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LinkEntities": { - "target": "com.amazonaws.quicksight#LinkEntityArnList", - "traits": { - "smithy.api#documentation": "

list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateDashboardLinksResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "DashboardArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dashboard.

" - } - }, - "LinkEntities": { - "target": "com.amazonaws.quicksight#LinkEntityArnList", - "traits": { - "smithy.api#documentation": "

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateDashboardPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateDashboardPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateDashboardPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates read and write permissions on a dashboard.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateDashboardPermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard whose permissions you're\n updating.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "GrantPermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", - "traits": { - "smithy.api#documentation": "

The permissions that you want to grant on this resource.

" - } - }, - "RevokePermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", - "traits": { - "smithy.api#documentation": "

The permissions that you want to revoke from this resource.

" - } - }, - "GrantLinkPermissions": { - "target": "com.amazonaws.quicksight#UpdateLinkPermissionList", - "traits": { - "smithy.api#documentation": "

Grants link permissions to all users in a defined namespace.

" - } - }, - "RevokeLinkPermissions": { - "target": "com.amazonaws.quicksight#UpdateLinkPermissionList", - "traits": { - "smithy.api#documentation": "

Revokes link permissions from all users in a defined namespace.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateDashboardPermissionsResponse": { - "type": "structure", - "members": { - "DashboardArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dashboard.

" - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

Information about the permissions on the dashboard.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "LinkSharingConfiguration": { - "target": "com.amazonaws.quicksight#LinkSharingConfiguration", - "traits": { - "smithy.api#documentation": "

Updates the permissions of a shared link to an Amazon QuickSight dashboard.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateDashboardPublishedVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateDashboardPublishedVersionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateDashboardPublishedVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the published version of a dashboard.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/versions/{VersionNumber}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateDashboardPublishedVersionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're\n updating.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the dashboard.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateDashboardPublishedVersionResponse": { - "type": "structure", - "members": { - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

" - } - }, - "DashboardArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dashboard.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateDashboardRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're\n updating.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DashboardName", - "traits": { - "smithy.api#documentation": "

The display name of the dashboard.

", - "smithy.api#required": {} - } - }, - "SourceEntity": { - "target": "com.amazonaws.quicksight#DashboardSourceEntity", - "traits": { - "smithy.api#documentation": "

The entity that you are using as a source when you update the dashboard. In\n SourceEntity, you specify the type of object you're using as source. You\n can only update a dashboard from a template, so you use a SourceTemplate\n entity. If you need to update a dashboard from an analysis, first convert the analysis\n to a template by using the \n CreateTemplate\n API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplate ARN can contain any Amazon Web Services account and any\n Amazon QuickSight-supported Amazon Web Services Region.

\n

Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.

" - } - }, - "Parameters": { - "target": "com.amazonaws.quicksight#Parameters", - "traits": { - "smithy.api#documentation": "

A structure that contains the parameters of the dashboard. These are parameter\n overrides for a dashboard. A dashboard can have any type of parameters, and some\n parameters might accept multiple values.

" - } - }, - "VersionDescription": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

A description for the first version of the dashboard being created.

" - } - }, - "DashboardPublishOptions": { - "target": "com.amazonaws.quicksight#DashboardPublishOptions", - "traits": { - "smithy.api#documentation": "

Options for publishing the dashboard when you create it:

\n " - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If\n you add a value for this field, it overrides the value that was originally associated\n with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the\n dashboard.

" - } - }, - "Definition": { - "target": "com.amazonaws.quicksight#DashboardVersionDefinition", - "traits": { - "smithy.api#documentation": "

The definition of a dashboard.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" - } - }, - "ValidationStrategy": { - "target": "com.amazonaws.quicksight#ValidationStrategy", - "traits": { - "smithy.api#documentation": "

The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateDashboardResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - }, - "VersionArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the dashboard, including the version number.

" - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

" - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The creation status of the request.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateDataSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateDataSetRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateDataSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateDataSetPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateDataSetPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateDataSetPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the permissions on a dataset.

\n

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateDataSetPermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dataset whose permissions you want to update. This ID is unique per\n\t\t\tAmazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "GrantPermissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

The resource permissions that you want to grant to the dataset.

" - } - }, - "RevokePermissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

The resource permissions that you want to revoke from the dataset.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateDataSetPermissionsResponse": { - "type": "structure", - "members": { - "DataSetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dataset whose permissions you want to update. This ID is unique per\n\t\t\tAmazon Web Services Region for each Amazon Web Services account.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateDataSetRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each\n\t\t\tAmazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

The display name for the dataset.

", - "smithy.api#required": {} - } - }, - "PhysicalTableMap": { - "target": "com.amazonaws.quicksight#PhysicalTableMap", - "traits": { - "smithy.api#documentation": "

Declares the physical tables that are available in the underlying data sources.

", - "smithy.api#required": {} - } - }, - "LogicalTableMap": { - "target": "com.amazonaws.quicksight#LogicalTableMap", - "traits": { - "smithy.api#documentation": "

Configures the combination and transformation of the data from the physical tables.

" - } - }, - "ImportMode": { - "target": "com.amazonaws.quicksight#DataSetImportMode", - "traits": { - "smithy.api#documentation": "

Indicates whether you want to import the data into SPICE.

", - "smithy.api#required": {} - } - }, - "ColumnGroups": { - "target": "com.amazonaws.quicksight#ColumnGroupList", - "traits": { - "smithy.api#documentation": "

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

" - } - }, - "FieldFolders": { - "target": "com.amazonaws.quicksight#FieldFolderMap", - "traits": { - "smithy.api#documentation": "

The folder that contains fields and nested subfolders for your dataset.

" - } - }, - "RowLevelPermissionDataSet": { - "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", - "traits": { - "smithy.api#documentation": "

The row-level security configuration for the data you want to create.

" - } - }, - "RowLevelPermissionTagConfiguration": { - "target": "com.amazonaws.quicksight#RowLevelPermissionTagConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

" - } - }, - "ColumnLevelPermissionRules": { - "target": "com.amazonaws.quicksight#ColumnLevelPermissionRuleList", - "traits": { - "smithy.api#documentation": "

A set of one or more definitions of a \n ColumnLevelPermissionRule\n .

" - } - }, - "DataSetUsageConfiguration": { - "target": "com.amazonaws.quicksight#DataSetUsageConfiguration" - }, - "DatasetParameters": { - "target": "com.amazonaws.quicksight#DatasetParameterList", - "traits": { - "smithy.api#documentation": "

The parameter declarations of the dataset.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateDataSetResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "IngestionArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the ingestion, which is triggered as a result of dataset creation if the import\n\t\t\tmode is SPICE.

" - } - }, - "IngestionId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the ingestion, which is triggered as a result of dataset creation if the import\n\t\t\tmode is SPICE.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateDataSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateDataSourceRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateDataSourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#CustomerManagedKeyUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a data source.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateDataSourcePermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateDataSourcePermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateDataSourcePermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the permissions to a data source.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateDataSourcePermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "GrantPermissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions that you want to grant on the data source.

" - } - }, - "RevokePermissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions that you want to revoke on the data source.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateDataSourcePermissionsResponse": { - "type": "structure", - "members": { - "DataSourceArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateDataSourceRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

A display name for the data source.

", - "smithy.api#required": {} - } - }, - "DataSourceParameters": { - "target": "com.amazonaws.quicksight#DataSourceParameters", - "traits": { - "smithy.api#documentation": "

The parameters that Amazon QuickSight uses to connect to your underlying source.

" - } - }, - "Credentials": { - "target": "com.amazonaws.quicksight#DataSourceCredentials", - "traits": { - "smithy.api#documentation": "

The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently,\n\t\t\tonly credentials based on user name and password are supported.

" - } - }, - "VpcConnectionProperties": { - "target": "com.amazonaws.quicksight#VpcConnectionProperties", - "traits": { - "smithy.api#documentation": "

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to\n\t\t\tyour underlying source.

" - } - }, - "SslProperties": { - "target": "com.amazonaws.quicksight#SslProperties", - "traits": { - "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying\n\t\t\tsource.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateDataSourceResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "UpdateStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The update status of the data source's last update.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateFolder": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateFolderRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateFolderResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the name of a folder.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/folders/{FolderId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateFolderPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateFolderPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateFolderPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates permissions of a folder.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateFolderPermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "GrantPermissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

The permissions that you want to grant on a resource. Namespace ARNs are not supported Principal values for folder permissions.

" - } - }, - "RevokePermissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

The permissions that you want to revoke from a resource. Namespace ARNs are not supported Principal values for folder permissions.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateFolderPermissionsResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the folder.

" - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

Information about the permissions for the folder.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateFolderRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#FolderName", - "traits": { - "smithy.api#documentation": "

The name of the folder.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateFolderResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the folder.

" - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateGroupRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Changes a group description.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateGroupRequest": { - "type": "structure", - "members": { - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

The name of the group that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.quicksight#GroupDescription", - "traits": { - "smithy.api#documentation": "

The description for the group that you want to update.

" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace of the group that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateGroupResponse": { - "type": "structure", - "members": { - "Group": { - "target": "com.amazonaws.quicksight#Group", - "traits": { - "smithy.api#documentation": "

The name of the group.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateIAMPolicyAssignment": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateIAMPolicyAssignmentRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateIAMPolicyAssignmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConcurrentUpdatingException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an existing IAM policy assignment. This operation updates only\n\t\t\tthe optional parameter or parameters that are specified in the request. This overwrites\n\t\t\tall of the users included in Identities.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/{AssignmentName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateIAMPolicyAssignmentRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the IAM policy\n\t\t\tassignment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "

The name of the assignment, also called a rule.\n\t\t\tThe\n\t\t\tname must be unique within the\n\t\t\tAmazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace of the assignment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", - "traits": { - "smithy.api#documentation": "

The status of the assignment. Possible values are as follows:

\n " - } - }, - "PolicyArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the IAM policy to apply to the Amazon QuickSight users and\n\t\t\tgroups specified in this assignment.

" - } - }, - "Identities": { - "target": "com.amazonaws.quicksight#IdentityMap", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight users, groups, or both that you want to assign the policy\n\t\t\tto.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateIAMPolicyAssignmentResponse": { - "type": "structure", - "members": { - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "

The name of the assignment or rule.

" - } - }, - "AssignmentId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the assignment.

" - } - }, - "PolicyArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the IAM policy applied to the Amazon QuickSight users and\n\t\t\tgroups specified in this assignment.

" - } - }, - "Identities": { - "target": "com.amazonaws.quicksight#IdentityMap", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight users, groups, or both that the IAM policy is\n\t\t\tassigned to.

" - } - }, - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", - "traits": { - "smithy.api#documentation": "

The status of the assignment. Possible values are as follows:

\n " - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateIdentityPropagationConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateIdentityPropagationConfigRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateIdentityPropagationConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.

\n

This operation is only supported for Amazon QuickSight accounts using IAM Identity Center

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/identity-propagation-config/{Service}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateIdentityPropagationConfigRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the identity propagation configuration that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Service": { - "target": "com.amazonaws.quicksight#ServiceType", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Web Services service that contains the authorized targets that you want to add or update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AuthorizedTargets": { - "target": "com.amazonaws.quicksight#AuthorizedTargetsList", - "traits": { - "smithy.api#documentation": "

Specifies a list of application ARNs that represent the authorized targets for a service.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateIdentityPropagationConfigResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateIpRestriction": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateIpRestrictionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateIpRestrictionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the IpRestrictionRule, VpcIdRestrictionRule, or VpcEndpointIdRestrictionRule. To use this operation, you must provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/ip-restriction", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateIpRestrictionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the IP rules.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "IpRestrictionRuleMap": { - "target": "com.amazonaws.quicksight#IpRestrictionRuleMap", - "traits": { - "smithy.api#documentation": "

A map that describes the updated IP rules with CIDR ranges and descriptions.

" - } - }, - "VpcIdRestrictionRuleMap": { - "target": "com.amazonaws.quicksight#VpcIdRestrictionRuleMap", - "traits": { - "smithy.api#documentation": "

A map of VPC IDs and their corresponding rules. When you configure this parameter, traffic from all VPC endpoints that are present in the specified VPC is allowed.

" - } - }, - "VpcEndpointIdRestrictionRuleMap": { - "target": "com.amazonaws.quicksight#VpcEndpointIdRestrictionRuleMap", - "traits": { - "smithy.api#documentation": "

A map of allowed VPC endpoint IDs and their corresponding rule descriptions.

" - } - }, - "Enabled": { - "target": "com.amazonaws.quicksight#NullableBoolean", - "traits": { - "smithy.api#documentation": "

A value that specifies whether IP rules are turned on.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateIpRestrictionResponse": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the IP rules.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateKeyRegistration": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateKeyRegistrationRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateKeyRegistrationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a customer managed key in a Amazon QuickSight account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/key-registration", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateKeyRegistrationRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the customer managed key registration that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "KeyRegistration": { - "target": "com.amazonaws.quicksight#KeyRegistration", - "traits": { - "smithy.api#documentation": "

A list of RegisteredCustomerManagedKey objects to be updated to the Amazon QuickSight account.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateKeyRegistrationResponse": { - "type": "structure", - "members": { - "FailedKeyRegistration": { - "target": "com.amazonaws.quicksight#FailedKeyRegistrationEntries", - "traits": { - "smithy.api#documentation": "

A list of all customer managed key registrations that failed to update.

" - } - }, - "SuccessfulKeyRegistration": { - "target": "com.amazonaws.quicksight#SuccessfulKeyRegistrationEntries", - "traits": { - "smithy.api#documentation": "

A list of all customer managed key registrations that were successfully updated.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateLinkPermissionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ResourcePermission" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#UpdatePublicSharingSettings": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdatePublicSharingSettingsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdatePublicSharingSettingsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedPricingPlanException" - } - ], - "traits": { - "smithy.api#documentation": "

Use the UpdatePublicSharingSettings operation to turn on or turn off the\n public sharing settings of an Amazon QuickSight dashboard.

\n

To use this operation, turn on session capacity pricing for your Amazon QuickSight\n account.

\n

Before you can turn on public sharing on your account, make sure to give public sharing\n permissions to an administrative user in the Identity and Access Management (IAM)\n console. For more information on using IAM with Amazon QuickSight, see\n Using Amazon QuickSight with IAM in the Amazon QuickSight\n User Guide.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/public-sharing-settings", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdatePublicSharingSettingsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID associated with your Amazon QuickSight subscription.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "PublicSharingEnabled": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdatePublicSharingSettingsResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateRefreshSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateRefreshScheduleRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateRefreshScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a refresh schedule for a dataset.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateRefreshScheduleRequest": { - "type": "structure", - "members": { - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Schedule": { - "target": "com.amazonaws.quicksight#RefreshSchedule", - "traits": { - "smithy.api#documentation": "

The refresh schedule.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateRefreshScheduleResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "ScheduleId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the refresh schedule.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the refresh schedule.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateResourcePermissionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ResourcePermission" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#UpdateRoleCustomPermission": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateRoleCustomPermissionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateRoleCustomPermissionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the custom permissions that are associated with a role.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateRoleCustomPermissionRequest": { - "type": "structure", - "members": { - "CustomPermissionsName": { - "target": "com.amazonaws.quicksight#RoleName", - "traits": { - "smithy.api#documentation": "

The name of the custom permission that you want to update the role with.

", - "smithy.api#required": {} - } - }, - "Role": { - "target": "com.amazonaws.quicksight#Role", - "traits": { - "smithy.api#documentation": "

The name of role tht you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that contains the role that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateRoleCustomPermissionResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateSPICECapacityConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateSPICECapacityConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateSPICECapacityConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the SPICE capacity configuration for a Amazon QuickSight account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/spice-capacity-configuration", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateSPICECapacityConfigurationRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the SPICE configuration that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "PurchaseMode": { - "target": "com.amazonaws.quicksight#PurchaseMode", - "traits": { - "smithy.api#documentation": "

Determines how SPICE capacity can be purchased. The following options are available.

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateSPICECapacityConfigurationResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateTemplateRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a template from an existing Amazon QuickSight analysis or another template.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateTemplateAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateTemplateAliasRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateTemplateAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the template alias of a template.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateTemplateAliasRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template alias that you're updating.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The alias of the template that you want to update. If you name a specific alias, you update\n\t\t\tthe version that the alias points to. You can specify the latest version of the template\n\t\t\tby providing the keyword $LATEST in the AliasName parameter.\n\t\t\tThe keyword $PUBLISHED doesn't apply to templates.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the template.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateTemplateAliasResponse": { - "type": "structure", - "members": { - "TemplateAlias": { - "target": "com.amazonaws.quicksight#TemplateAlias", - "traits": { - "smithy.api#documentation": "

The template alias.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateTemplatePermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateTemplatePermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateTemplatePermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the resource permissions for a template.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateTemplatePermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "GrantPermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions to be granted on the template.

" - } - }, - "RevokePermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions to be revoked from the template.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateTemplatePermissionsResponse": { - "type": "structure", - "members": { - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template.

" - } - }, - "TemplateArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions to be set on the template.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateTemplateRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template that you're updating.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SourceEntity": { - "target": "com.amazonaws.quicksight#TemplateSourceEntity", - "traits": { - "smithy.api#documentation": "

The entity that you are using as a source when you update the template. In\n\t\t\tSourceEntity, you specify the type of object you're using as source:\n\t\t\tSourceTemplate for a template or SourceAnalysis for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate, specify the ARN of the source template. For\n\t\t\tSourceAnalysis, specify the ARN of the source analysis. The SourceTemplate\n\t\t\tARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;.

\n

Use the DataSetReferences entity within SourceTemplate or\n\t\t\tSourceAnalysis to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.

" - } - }, - "VersionDescription": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

A description of the current template version that is being updated. Every time you call\n\t\t\t\tUpdateTemplate, you create a new version of the template. Each version\n\t\t\tof the template maintains a description of the version in the\n\t\t\t\tVersionDescription field.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#TemplateName", - "traits": { - "smithy.api#documentation": "

The name for the template.

" - } - }, - "Definition": { - "target": "com.amazonaws.quicksight#TemplateVersionDefinition", - "traits": { - "smithy.api#documentation": "

The definition of a template.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" - } - }, - "ValidationStrategy": { - "target": "com.amazonaws.quicksight#ValidationStrategy", - "traits": { - "smithy.api#documentation": "

The option to relax the validation needed to update a template with definition objects. This skips the validation step for specific errors.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateTemplateResponse": { - "type": "structure", - "members": { - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the template.

" - } - }, - "VersionArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the template, including the version information of the first version.

" - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The creation status of the template.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateTheme": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateThemeRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateThemeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a theme.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateThemeAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateThemeAliasRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateThemeAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an alias of a theme.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateThemeAliasRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme alias that you're updating.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The name of the theme alias that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the theme that the alias should reference.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateThemeAliasResponse": { - "type": "structure", - "members": { - "ThemeAlias": { - "target": "com.amazonaws.quicksight#ThemeAlias", - "traits": { - "smithy.api#documentation": "

Information about the theme alias.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateThemePermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateThemePermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateThemePermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the resource permissions for a theme. Permissions apply to the action to grant or\n\t\t\trevoke permissions on, for example \"quicksight:DescribeTheme\".

\n

Theme permissions apply in groupings. Valid groupings include the following for the three\n\t\t\tlevels of permissions, which are user, owner, or no permissions:

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateThemePermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "GrantPermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions to be granted for the theme.

" - } - }, - "RevokePermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions to be revoked from the theme.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateThemePermissionsResponse": { - "type": "structure", - "members": { - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme.

" - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

The resulting list of resource permissions for the theme.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateThemeRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme that you're updating.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ThemeName", - "traits": { - "smithy.api#documentation": "

The name for the theme.

" - } - }, - "BaseThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The theme ID, defined by Amazon QuickSight, that a custom theme inherits from.\n\t\tAll themes initially inherit from a default Amazon QuickSight theme.

", - "smithy.api#required": {} - } - }, - "VersionDescription": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

A description of the theme version that you're updating Every time that you call\n\t\t\t\tUpdateTheme, you create a new version of the theme. Each version of the\n\t\t\ttheme maintains a description of the version in VersionDescription.

" - } - }, - "Configuration": { - "target": "com.amazonaws.quicksight#ThemeConfiguration", - "traits": { - "smithy.api#documentation": "

The theme configuration, which contains the theme display properties.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateThemeResponse": { - "type": "structure", - "members": { - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the theme.

" - } - }, - "VersionArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the new version of the theme.

" - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The creation status of the theme.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateTopic": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateTopicRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateTopicResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a topic.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateTopicPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateTopicPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateTopicPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the permissions of a topic.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateTopicPermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic that you want to update\n the permissions for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "GrantPermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", - "traits": { - "smithy.api#documentation": "

The resource permissions that you want to grant to the topic.

" - } - }, - "RevokePermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", - "traits": { - "smithy.api#documentation": "

The resource permissions that you want to revoke from the topic.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateTopicPermissionsResponse": { - "type": "structure", - "members": { - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "TopicArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions on the topic.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateTopicRefreshSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateTopicRefreshScheduleRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateTopicRefreshScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a topic refresh schedule.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules/{DatasetId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateTopicRefreshScheduleRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic whose refresh schedule\n you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DatasetId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RefreshSchedule": { - "target": "com.amazonaws.quicksight#TopicRefreshSchedule", - "traits": { - "smithy.api#documentation": "

The definition of a refresh schedule.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateTopicRefreshScheduleResponse": { - "type": "structure", - "members": { - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "TopicArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "DatasetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateTopicRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic that you want to\n update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Topic": { - "target": "com.amazonaws.quicksight#TopicDetails", - "traits": { - "smithy.api#documentation": "

The definition of the topic that you want to update.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateTopicResponse": { - "type": "structure", - "members": { - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "RefreshArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic refresh.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateUserRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an Amazon QuickSight user.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateUserRequest": { - "type": "structure", - "members": { - "UserName": { - "target": "com.amazonaws.quicksight#UserName", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight user name that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Email": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The email address of the user that you want to update.

", - "smithy.api#required": {} - } - }, - "Role": { - "target": "com.amazonaws.quicksight#UserRole", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight role of the user. The role can be one of the\n\t\t\tfollowing default security cohorts:

\n \n

The name of the Amazon QuickSight role is invisible to the user except for the console\n\t screens dealing with permissions.

", - "smithy.api#required": {} - } - }, - "CustomPermissionsName": { - "target": "com.amazonaws.quicksight#RoleName", - "traits": { - "smithy.api#documentation": "

(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:

\n \n

A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the Amazon QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a Amazon QuickSight user.

\n

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning Amazon QuickSight users to one of the\n default security cohorts in Amazon QuickSight (admin, author, reader).

\n

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

" - } - }, - "UnapplyCustomPermissions": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A flag that you use to indicate that you want to remove all custom permissions\n from this user. Using this parameter resets the user to the state\n it was in before a custom permissions profile was applied. This parameter defaults to\n NULL and it doesn't accept any other value.

" - } - }, - "ExternalLoginFederationProviderType": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

\n " - } - }, - "CustomFederationProviderUrl": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate\n into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should\n only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

" - } - }, - "ExternalLoginId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The identity ID for a user in the external login provider.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateUserResponse": { - "type": "structure", - "members": { - "User": { - "target": "com.amazonaws.quicksight#User", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight user.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UpdateVPCConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateVPCConnectionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateVPCConnectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a VPC connection.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#UpdateVPCConnectionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the account that contains the VPC connection that\n\t\t\tyou want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VPCConnectionId": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", - "traits": { - "smithy.api#documentation": "

The ID of the VPC connection that\n\t\t\tyou're updating. This ID is a unique identifier for each Amazon Web Services Region in an\n\t\t\t\tAmazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

The display name for the VPC connection.

", - "smithy.api#required": {} - } - }, - "SubnetIds": { - "target": "com.amazonaws.quicksight#SubnetIdList", - "traits": { - "smithy.api#documentation": "

A list of subnet IDs for the VPC connection.

", - "smithy.api#required": {} - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.quicksight#SecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of security group IDs for the VPC connection.

", - "smithy.api#required": {} - } - }, - "DnsResolvers": { - "target": "com.amazonaws.quicksight#DnsResolverList", - "traits": { - "smithy.api#documentation": "

A list of IP addresses of DNS resolver endpoints for the VPC connection.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.quicksight#RoleArn", - "traits": { - "smithy.api#documentation": "

An IAM role associated with the VPC connection.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#UpdateVPCConnectionResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC connection.

" - } - }, - "VPCConnectionId": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", - "traits": { - "smithy.api#documentation": "

The ID of the VPC connection that you are updating. This ID is a unique identifier for each Amazon Web Services Region in anAmazon Web Services account.

" - } - }, - "UpdateStatus": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", - "traits": { - "smithy.api#documentation": "

The update status of the VPC connection's last update.

" - } - }, - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", - "traits": { - "smithy.api#documentation": "

The availability status of the VPC connection.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#UploadSettings": { - "type": "structure", - "members": { - "Format": { - "target": "com.amazonaws.quicksight#FileFormat", - "traits": { - "smithy.api#documentation": "

File format.

" - } - }, - "StartFromRow": { - "target": "com.amazonaws.quicksight#PositiveInteger", - "traits": { - "smithy.api#documentation": "

A row number to start reading data from.

" - } - }, - "ContainsHeader": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

Whether the file has a header row, or the files each have a header row.

" - } - }, - "TextQualifier": { - "target": "com.amazonaws.quicksight#TextQualifier", - "traits": { - "smithy.api#documentation": "

Text qualifier.

" - } - }, - "Delimiter": { - "target": "com.amazonaws.quicksight#Delimiter", - "traits": { - "smithy.api#documentation": "

The delimiter between values in the file.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the format for a source file or files.

" - } - }, - "com.amazonaws.quicksight#User": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the user.

" - } - }, - "UserName": { - "target": "com.amazonaws.quicksight#UserName", - "traits": { - "smithy.api#documentation": "

The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is\n N/A when the value for IdentityType is IAM\n and the corresponding IAM user is deleted.

" - } - }, - "Email": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The user's email address.

" - } - }, - "Role": { - "target": "com.amazonaws.quicksight#UserRole", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight role for the user. The user role can be one of the\n following:.

\n " - } - }, - "IdentityType": { - "target": "com.amazonaws.quicksight#IdentityType", - "traits": { - "smithy.api#documentation": "

The type of identity authentication used by the user.

" - } - }, - "Active": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a\n password.

" - } - }, - "PrincipalId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The principal ID of the user.

" - } - }, - "CustomPermissionsName": { - "target": "com.amazonaws.quicksight#RoleName", - "traits": { - "smithy.api#documentation": "

The custom permissions profile associated with this user.

" - } - }, - "ExternalLoginFederationProviderType": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The type of supported external login provider that provides identity to let the user\n federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.

\n " - } - }, - "ExternalLoginFederationProviderUrl": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The URL of the external login provider.

" - } - }, - "ExternalLoginId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The identity ID for the user in the external login provider.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A registered user of Amazon QuickSight.

" - } - }, - "com.amazonaws.quicksight#UserList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#User" - } - }, - "com.amazonaws.quicksight#UserName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - }, - "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" - } - }, - "com.amazonaws.quicksight#UserRole": { - "type": "enum", - "members": { - "ADMIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ADMIN" - } - }, - "AUTHOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTHOR" - } - }, - "READER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READER" - } - }, - "RESTRICTED_AUTHOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESTRICTED_AUTHOR" - } - }, - "RESTRICTED_READER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESTRICTED_READER" - } - }, - "ADMIN_PRO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ADMIN_PRO" - } - }, - "AUTHOR_PRO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTHOR_PRO" - } - }, - "READER_PRO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READER_PRO" - } - } - } - }, - "com.amazonaws.quicksight#VPCConnection": { - "type": "structure", - "members": { - "VPCConnectionId": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", - "traits": { - "smithy.api#documentation": "

The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an\n Amazon Web Services account.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC connection.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

The display name for the VPC connection.

" - } - }, - "VPCId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon EC2 VPC ID associated with the VPC connection.

" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.quicksight#SecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

The Amazon EC2 security group IDs associated with the VPC connection.

" - } - }, - "DnsResolvers": { - "target": "com.amazonaws.quicksight#StringList", - "traits": { - "smithy.api#documentation": "

A list of IP addresses of DNS resolver endpoints for the VPC connection.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", - "traits": { - "smithy.api#documentation": "

The status of the VPC connection.

" - } - }, - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", - "traits": { - "smithy.api#documentation": "

The availability status of the VPC connection.

" - } - }, - "NetworkInterfaces": { - "target": "com.amazonaws.quicksight#NetworkInterfaceList", - "traits": { - "smithy.api#documentation": "

A list of network interfaces.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ARN of the\n IAM role associated with the VPC\n connection.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the VPC connection was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the VPC connection was last updated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The structure of a VPC connection.

" - } - }, - "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus": { - "type": "enum", - "members": { - "AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVAILABLE" - } - }, - "UNAVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNAVAILABLE" - } - }, - "PARTIALLY_AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARTIALLY_AVAILABLE" - } - } - } - }, - "com.amazonaws.quicksight#VPCConnectionResourceIdRestricted": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": "^[\\w\\-]+$" - } - }, - "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.quicksight#VPCConnectionResourceStatus": { - "type": "enum", - "members": { - "CREATION_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_IN_PROGRESS" - } - }, - "CREATION_SUCCESSFUL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_SUCCESSFUL" - } - }, - "CREATION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_FAILED" - } - }, - "UPDATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_IN_PROGRESS" - } - }, - "UPDATE_SUCCESSFUL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_SUCCESSFUL" - } - }, - "UPDATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_FAILED" - } - }, - "DELETION_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETION_IN_PROGRESS" - } - }, - "DELETION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETION_FAILED" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - } - } - }, - "com.amazonaws.quicksight#VPCConnectionSummary": { - "type": "structure", - "members": { - "VPCConnectionId": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", - "traits": { - "smithy.api#documentation": "

The ID of the VPC connection that\n you're\n creating. This ID is a unique identifier for each Amazon Web Services Region in an\n Amazon Web Services account.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC connection.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

The display name for the VPC connection.

" - } - }, - "VPCId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon EC2 VPC ID associated with the VPC connection.

" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.quicksight#SecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

The Amazon EC2 security group IDs associated with the VPC connection.

" - } - }, - "DnsResolvers": { - "target": "com.amazonaws.quicksight#StringList", - "traits": { - "smithy.api#documentation": "

A list of IP addresses of DNS resolver endpoints for the VPC connection.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", - "traits": { - "smithy.api#documentation": "

The status of the VPC connection.

" - } - }, - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", - "traits": { - "smithy.api#documentation": "

The availability status of the VPC connection.

" - } - }, - "NetworkInterfaces": { - "target": "com.amazonaws.quicksight#NetworkInterfaceList", - "traits": { - "smithy.api#documentation": "

A list of network interfaces.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ARN of the IAM role associated\n with the VPC connection.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the VPC connection was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the VPC connection was last updated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The summary metadata that describes a VPC connection.

" - } - }, - "com.amazonaws.quicksight#VPCConnectionSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#VPCConnectionSummary" - } - }, - "com.amazonaws.quicksight#ValidationStrategy": { - "type": "structure", - "members": { - "Mode": { - "target": "com.amazonaws.quicksight#ValidationStrategyMode", - "traits": { - "smithy.api#documentation": "

The mode of validation for the asset to be created or updated. When you set this value to STRICT, strict validation for every error is enforced. When you set this value to LENIENT, validation is skipped for specific UI errors.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

" - } - }, - "com.amazonaws.quicksight#ValidationStrategyMode": { - "type": "enum", - "members": { - "STRICT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STRICT" - } - }, - "LENIENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LENIENT" - } - } - } - }, - "com.amazonaws.quicksight#ValueWhenUnsetOption": { - "type": "enum", - "members": { - "RECOMMENDED_VALUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RECOMMENDED_VALUE" - } - }, - "NULL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NULL" - } - } - } - }, - "com.amazonaws.quicksight#VersionDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.quicksight#VersionNumber": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.quicksight#VerticalTextAlignment": { - "type": "enum", - "members": { - "TOP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TOP" - } - }, - "MIDDLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MIDDLE" - } - }, - "BOTTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOTTOM" - } - }, - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - } - } - }, - "com.amazonaws.quicksight#Visibility": { - "type": "enum", - "members": { - "HIDDEN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HIDDEN" - } - }, - "VISIBLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VISIBLE" - } - } - } - }, - "com.amazonaws.quicksight#VisiblePanelColumns": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#VisiblePanelRows": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#VisibleRangeOptions": { - "type": "structure", - "members": { - "PercentRange": { - "target": "com.amazonaws.quicksight#PercentVisibleRange", - "traits": { - "smithy.api#documentation": "

The percent range in the visible range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The range options for the data zoom scroll bar.

" - } - }, - "com.amazonaws.quicksight#Visual": { - "type": "structure", - "members": { - "TableVisual": { - "target": "com.amazonaws.quicksight#TableVisual", - "traits": { - "smithy.api#documentation": "

A table visual.

\n

For more information, see Using tables as visuals in the Amazon QuickSight User Guide.

" - } - }, - "PivotTableVisual": { - "target": "com.amazonaws.quicksight#PivotTableVisual", - "traits": { - "smithy.api#documentation": "

A pivot table.

\n

For more information, see Using pivot tables in the Amazon QuickSight User Guide.

" - } - }, - "BarChartVisual": { - "target": "com.amazonaws.quicksight#BarChartVisual", - "traits": { - "smithy.api#documentation": "

A bar chart.

\n

For more information, see Using bar charts in the Amazon QuickSight User Guide.

" - } - }, - "KPIVisual": { - "target": "com.amazonaws.quicksight#KPIVisual", - "traits": { - "smithy.api#documentation": "

A key performance indicator (KPI).

\n

For more information, see Using KPIs in the Amazon QuickSight User Guide.

" - } - }, - "PieChartVisual": { - "target": "com.amazonaws.quicksight#PieChartVisual", - "traits": { - "smithy.api#documentation": "

A pie or donut chart.

\n

For more information, see Using pie charts in the Amazon QuickSight User Guide.

" - } - }, - "GaugeChartVisual": { - "target": "com.amazonaws.quicksight#GaugeChartVisual", - "traits": { - "smithy.api#documentation": "

A gauge chart.

\n

For more information, see Using gauge charts in the Amazon QuickSight User Guide.

" - } - }, - "LineChartVisual": { - "target": "com.amazonaws.quicksight#LineChartVisual", - "traits": { - "smithy.api#documentation": "

A line chart.

\n

For more information, see Using line charts in the Amazon QuickSight User Guide.

" - } - }, - "HeatMapVisual": { - "target": "com.amazonaws.quicksight#HeatMapVisual", - "traits": { - "smithy.api#documentation": "

A heat map.

\n

For more information, see Using heat maps in the Amazon QuickSight User Guide.

" - } - }, - "TreeMapVisual": { - "target": "com.amazonaws.quicksight#TreeMapVisual", - "traits": { - "smithy.api#documentation": "

A tree map.

\n

For more information, see Using tree maps in the Amazon QuickSight User Guide.

" - } - }, - "GeospatialMapVisual": { - "target": "com.amazonaws.quicksight#GeospatialMapVisual", - "traits": { - "smithy.api#documentation": "

A geospatial map or a points on map visual.

\n

For more information, see Creating point maps in the Amazon QuickSight User Guide.

" - } - }, - "FilledMapVisual": { - "target": "com.amazonaws.quicksight#FilledMapVisual", - "traits": { - "smithy.api#documentation": "

A filled map.

\n

For more information, see Creating filled maps in the Amazon QuickSight User Guide.

" - } - }, - "FunnelChartVisual": { - "target": "com.amazonaws.quicksight#FunnelChartVisual", - "traits": { - "smithy.api#documentation": "

A funnel chart.

\n

For more information, see Using funnel charts in the Amazon QuickSight User Guide.

" - } - }, - "ScatterPlotVisual": { - "target": "com.amazonaws.quicksight#ScatterPlotVisual", - "traits": { - "smithy.api#documentation": "

A scatter plot.

\n

For more information, see Using scatter plots in the Amazon QuickSight User Guide.

" - } - }, - "ComboChartVisual": { - "target": "com.amazonaws.quicksight#ComboChartVisual", - "traits": { - "smithy.api#documentation": "

A combo chart.

\n

For more information, see Using combo charts in the Amazon QuickSight User Guide.

" - } - }, - "BoxPlotVisual": { - "target": "com.amazonaws.quicksight#BoxPlotVisual", - "traits": { - "smithy.api#documentation": "

A box plot.

\n

For more information, see Using box plots in the Amazon QuickSight User Guide.

" - } - }, - "WaterfallVisual": { - "target": "com.amazonaws.quicksight#WaterfallVisual", - "traits": { - "smithy.api#documentation": "

A waterfall chart.

\n

For more information, see Using waterfall charts in the Amazon QuickSight User Guide.

" - } - }, - "HistogramVisual": { - "target": "com.amazonaws.quicksight#HistogramVisual", - "traits": { - "smithy.api#documentation": "

A histogram.

\n

For more information, see Using histograms in the Amazon QuickSight User Guide.

" - } - }, - "WordCloudVisual": { - "target": "com.amazonaws.quicksight#WordCloudVisual", - "traits": { - "smithy.api#documentation": "

A word cloud.

\n

For more information, see Using word clouds in the Amazon QuickSight User Guide.

" - } - }, - "InsightVisual": { - "target": "com.amazonaws.quicksight#InsightVisual", - "traits": { - "smithy.api#documentation": "

An insight visual.

\n

For more information, see Working with insights in the Amazon QuickSight User Guide.

" - } - }, - "SankeyDiagramVisual": { - "target": "com.amazonaws.quicksight#SankeyDiagramVisual", - "traits": { - "smithy.api#documentation": "

A sankey diagram.

\n

For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.

" - } - }, - "CustomContentVisual": { - "target": "com.amazonaws.quicksight#CustomContentVisual", - "traits": { - "smithy.api#documentation": "

A visual that contains custom content.

\n

For more information, see Using custom visual content in the Amazon QuickSight User Guide.

" - } - }, - "EmptyVisual": { - "target": "com.amazonaws.quicksight#EmptyVisual", - "traits": { - "smithy.api#documentation": "

An empty visual.

" - } - }, - "RadarChartVisual": { - "target": "com.amazonaws.quicksight#RadarChartVisual", - "traits": { - "smithy.api#documentation": "

A radar chart visual.

\n

For more information, see Using radar charts in the Amazon QuickSight User Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A visual displayed on a sheet in an analysis, dashboard, or template.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#VisualAxisSortOption": { - "type": "structure", - "members": { - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#DashboardBehavior", - "traits": { - "smithy.api#documentation": "

The availaiblity status of a visual's axis sort options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The axis sort options for a visual.

" - } - }, - "com.amazonaws.quicksight#VisualCustomAction": { - "type": "structure", - "members": { - "CustomActionId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the VisualCustomAction.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#VisualCustomActionName", - "traits": { - "smithy.api#documentation": "

The name of the VisualCustomAction.

", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.quicksight#WidgetStatus", - "traits": { - "smithy.api#documentation": "

The status of the VisualCustomAction.

" - } - }, - "Trigger": { - "target": "com.amazonaws.quicksight#VisualCustomActionTrigger", - "traits": { - "smithy.api#documentation": "

The trigger of the VisualCustomAction.

\n

Valid values are defined as follows:

\n ", - "smithy.api#required": {} - } - }, - "ActionOperations": { - "target": "com.amazonaws.quicksight#VisualCustomActionOperationList", - "traits": { - "smithy.api#documentation": "

A list of VisualCustomActionOperations.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A custom action defined on a visual.

" - } - }, - "com.amazonaws.quicksight#VisualCustomActionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#VisualCustomAction" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#VisualCustomActionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.quicksight#VisualCustomActionOperation": { - "type": "structure", - "members": { - "FilterOperation": { - "target": "com.amazonaws.quicksight#CustomActionFilterOperation", - "traits": { - "smithy.api#documentation": "

The filter operation that filters data included in a visual or in an entire sheet.

" - } - }, - "NavigationOperation": { - "target": "com.amazonaws.quicksight#CustomActionNavigationOperation", - "traits": { - "smithy.api#documentation": "

The navigation operation that navigates between different sheets in the same analysis.

" - } - }, - "URLOperation": { - "target": "com.amazonaws.quicksight#CustomActionURLOperation", - "traits": { - "smithy.api#documentation": "

The URL operation that opens a link to another webpage.

" - } - }, - "SetParametersOperation": { - "target": "com.amazonaws.quicksight#CustomActionSetParametersOperation", - "traits": { - "smithy.api#documentation": "

The set parameter operation that sets parameters in custom action.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The operation that is defined by the custom action.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#VisualCustomActionOperationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#VisualCustomActionOperation" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2 - } - } - }, - "com.amazonaws.quicksight#VisualCustomActionTrigger": { - "type": "enum", - "members": { - "DATA_POINT_CLICK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_POINT_CLICK" - } - }, - "DATA_POINT_MENU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_POINT_MENU" - } - } - } - }, - "com.amazonaws.quicksight#VisualInteractionOptions": { - "type": "structure", - "members": { - "VisualMenuOption": { - "target": "com.amazonaws.quicksight#VisualMenuOption", - "traits": { - "smithy.api#documentation": "

The on-visual menu options for a visual.

" - } - }, - "ContextMenuOption": { - "target": "com.amazonaws.quicksight#ContextMenuOption", - "traits": { - "smithy.api#documentation": "

The context menu options for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for visual publish options

" - } - }, - "com.amazonaws.quicksight#VisualList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Visual" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#VisualMenuOption": { - "type": "structure", - "members": { - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#DashboardBehavior", - "traits": { - "smithy.api#documentation": "

The availaiblity status of a visual's menu options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The menu options for a visual.

" - } - }, - "com.amazonaws.quicksight#VisualOptions": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The type for a VisualOptions.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a VisualOptions.

" - } - }, - "com.amazonaws.quicksight#VisualPalette": { - "type": "structure", - "members": { - "ChartColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The chart color options for the visual palette.

" - } - }, - "ColorMap": { - "target": "com.amazonaws.quicksight#DataPathColorList", - "traits": { - "smithy.api#documentation": "

The color map options for the visual palette.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The visual display options for the visual palette.

" - } - }, - "com.amazonaws.quicksight#VisualRole": { - "type": "enum", - "members": { - "PRIMARY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRIMARY" - } - }, - "COMPLIMENTARY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLIMENTARY" - } - }, - "MULTI_INTENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MULTI_INTENT" - } - }, - "FALLBACK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FALLBACK" - } - }, - "FRAGMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FRAGMENT" - } - } - } - }, - "com.amazonaws.quicksight#VisualSubtitleLabelOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the subtitle label.

" - } - }, - "FormatText": { - "target": "com.amazonaws.quicksight#LongFormatText", - "traits": { - "smithy.api#documentation": "

The long text format of the subtitle label, such as plain text or rich text.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The subtitle label options for a visual.

" - } - }, - "com.amazonaws.quicksight#VisualTitleLabelOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the title label.

" - } - }, - "FormatText": { - "target": "com.amazonaws.quicksight#ShortFormatText", - "traits": { - "smithy.api#documentation": "

The short text format of the title label, such as plain text or rich text.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The title label options for a visual.

" - } - }, - "com.amazonaws.quicksight#VpcConnectionProperties": { - "type": "structure", - "members": { - "VpcConnectionArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the VPC connection.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

VPC connection properties.

" - } - }, - "com.amazonaws.quicksight#VpcEndpointId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^vpce-[0-9a-z]*$" - } - }, - "com.amazonaws.quicksight#VpcEndpointIdRestrictionRuleDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 150 - } - } - }, - "com.amazonaws.quicksight#VpcEndpointIdRestrictionRuleMap": { - "type": "map", - "key": { - "target": "com.amazonaws.quicksight#VpcEndpointId" - }, - "value": { - "target": "com.amazonaws.quicksight#VpcEndpointIdRestrictionRuleDescription" - } - }, - "com.amazonaws.quicksight#VpcId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^vpc-[0-9a-z]*$" - } - }, - "com.amazonaws.quicksight#VpcIdRestrictionRuleDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 150 - } - } - }, - "com.amazonaws.quicksight#VpcIdRestrictionRuleMap": { - "type": "map", - "key": { - "target": "com.amazonaws.quicksight#VpcId" - }, - "value": { - "target": "com.amazonaws.quicksight#VpcIdRestrictionRuleDescription" - } - }, - "com.amazonaws.quicksight#Warehouse": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - } - } - }, - "com.amazonaws.quicksight#WaterfallChartAggregatedFieldWells": { - "type": "structure", - "members": { - "Categories": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The category field wells of a waterfall visual.

" - } - }, - "Values": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The value field wells of a waterfall visual.

" - } - }, - "Breakdowns": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The breakdown field wells of a waterfall visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a waterfall visual.

" - } - }, - "com.amazonaws.quicksight#WaterfallChartColorConfiguration": { - "type": "structure", - "members": { - "GroupColorConfiguration": { - "target": "com.amazonaws.quicksight#WaterfallChartGroupColorConfiguration", - "traits": { - "smithy.api#documentation": "

The color configuration for individual groups within a waterfall visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The color configuration of a waterfall visual.

" - } - }, - "com.amazonaws.quicksight#WaterfallChartConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#WaterfallChartFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a waterfall visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#WaterfallChartSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a waterfall visual.

" - } - }, - "WaterfallChartOptions": { - "target": "com.amazonaws.quicksight#WaterfallChartOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of a waterfall visual.

" - } - }, - "CategoryAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the category axis label.

" - } - }, - "CategoryAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the category axis.

" - } - }, - "PrimaryYAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the y-axis label.

" - } - }, - "PrimaryYAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the y-axis.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "

The legend configuration of a waterfall visual.

" - } - }, - "DataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The data label configuration of a waterfall visual.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "

The visual palette configuration of a waterfall visual.

" - } - }, - "ColorConfiguration": { - "target": "com.amazonaws.quicksight#WaterfallChartColorConfiguration", - "traits": { - "smithy.api#documentation": "

The color configuration of a waterfall visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for a waterfall visual.

" - } - }, - "com.amazonaws.quicksight#WaterfallChartFieldWells": { - "type": "structure", - "members": { - "WaterfallChartAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#WaterfallChartAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a waterfall visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a waterfall visual.

" - } - }, - "com.amazonaws.quicksight#WaterfallChartGroupColorConfiguration": { - "type": "structure", - "members": { - "PositiveBarColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

Defines the color for the positive bars of a waterfall chart.

" - } - }, - "NegativeBarColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

Defines the color for the negative bars of a waterfall chart.

" - } - }, - "TotalBarColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

Defines the color for the total bars of a waterfall chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The color configuration for individual groups within a waterfall visual.

" - } - }, - "com.amazonaws.quicksight#WaterfallChartOptions": { - "type": "structure", - "members": { - "TotalBarLabel": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

This option determines the total bar label of a waterfall visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of a waterfall visual.

" - } - }, - "com.amazonaws.quicksight#WaterfallChartSortConfiguration": { - "type": "structure", - "members": { - "CategorySort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the category fields.

" - } - }, - "BreakdownItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of bar groups that are displayed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a waterfall visual.

" - } - }, - "com.amazonaws.quicksight#WaterfallVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#WaterfallChartConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration for a waterfall visual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A waterfall chart.

\n

For more information, see Using waterfall charts in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#WhatIfPointScenario": { - "type": "structure", - "members": { - "Date": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that you need the forecast results for.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The target value that you want to meet for the provided date.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides the forecast to meet the target for a particular date.

" - } - }, - "com.amazonaws.quicksight#WhatIfRangeScenario": { - "type": "structure", - "members": { - "StartDate": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The start date in the date range that you need the forecast results for.

", - "smithy.api#required": {} - } - }, - "EndDate": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The end date in the date range that you need the forecast results for.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The target value that you want to meet for the provided date range.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Provides the forecast to meet the target for a particular date range.

" - } - }, - "com.amazonaws.quicksight#WidgetStatus": { - "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.quicksight#WordCloudAggregatedFieldWells": { - "type": "structure", - "members": { - "GroupBy": { - "target": "com.amazonaws.quicksight#WordCloudDimensionFieldList", - "traits": { - "smithy.api#documentation": "

The group by field well of a word cloud. Values are grouped by group by fields.

" - } - }, - "Size": { - "target": "com.amazonaws.quicksight#WordCloudMeasureFieldList", - "traits": { - "smithy.api#documentation": "

The size field well of a word cloud. Values are aggregated based on group by fields.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a word cloud.

" - } - }, - "com.amazonaws.quicksight#WordCloudChartConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#WordCloudFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#WordCloudSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a word cloud visual.

" - } - }, - "CategoryLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) for the word cloud category.

" - } - }, - "WordCloudOptions": { - "target": "com.amazonaws.quicksight#WordCloudOptions", - "traits": { - "smithy.api#documentation": "

The options for a word cloud visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a word cloud visual.

" - } - }, - "com.amazonaws.quicksight#WordCloudCloudLayout": { - "type": "enum", - "members": { - "FLUID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FLUID" - } - }, - "NORMAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NORMAL" - } - } - } - }, - "com.amazonaws.quicksight#WordCloudDimensionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DimensionField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#WordCloudFieldWells": { - "type": "structure", - "members": { - "WordCloudAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#WordCloudAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a word cloud.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field wells of a word cloud visual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#WordCloudMaximumStringLength": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#WordCloudMeasureFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MeasureField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#WordCloudOptions": { - "type": "structure", - "members": { - "WordOrientation": { - "target": "com.amazonaws.quicksight#WordCloudWordOrientation", - "traits": { - "smithy.api#documentation": "

The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.

" - } - }, - "WordScaling": { - "target": "com.amazonaws.quicksight#WordCloudWordScaling", - "traits": { - "smithy.api#documentation": "

The word scaling options (emphasize, normal) for the words in a word cloud.

" - } - }, - "CloudLayout": { - "target": "com.amazonaws.quicksight#WordCloudCloudLayout", - "traits": { - "smithy.api#documentation": "

The cloud layout options (fluid, normal) of a word cloud.

" - } - }, - "WordCasing": { - "target": "com.amazonaws.quicksight#WordCloudWordCasing", - "traits": { - "smithy.api#documentation": "

The word casing options (lower_case, existing_case) for the words in a word cloud.

" - } - }, - "WordPadding": { - "target": "com.amazonaws.quicksight#WordCloudWordPadding", - "traits": { - "smithy.api#documentation": "

The word padding options (none, small, medium, large) for the words in a word cloud.

" - } - }, - "MaximumStringLength": { - "target": "com.amazonaws.quicksight#WordCloudMaximumStringLength", - "traits": { - "smithy.api#documentation": "

The length limit of each word from 1-100.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The word cloud options for a word cloud visual.

" - } - }, - "com.amazonaws.quicksight#WordCloudSortConfiguration": { - "type": "structure", - "members": { - "CategoryItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of groups that are displayed in a word cloud.

" - } - }, - "CategorySort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of group by fields.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a word cloud visual.

" - } - }, - "com.amazonaws.quicksight#WordCloudVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#WordCloudChartConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the visual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A word cloud.

\n

For more information, see Using word clouds in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#WordCloudWordCasing": { - "type": "enum", - "members": { - "LOWER_CASE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LOWER_CASE" - } - }, - "EXISTING_CASE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXISTING_CASE" - } - } - } - }, - "com.amazonaws.quicksight#WordCloudWordOrientation": { - "type": "enum", - "members": { - "HORIZONTAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HORIZONTAL" - } - }, - "HORIZONTAL_AND_VERTICAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HORIZONTAL_AND_VERTICAL" - } - } - } - }, - "com.amazonaws.quicksight#WordCloudWordPadding": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "SMALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SMALL" - } - }, - "MEDIUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIUM" - } - }, - "LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LARGE" - } - } - } - }, - "com.amazonaws.quicksight#WordCloudWordScaling": { - "type": "enum", - "members": { - "EMPHASIZE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EMPHASIZE" - } - }, - "NORMAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NORMAL" - } - } - } - }, - "com.amazonaws.quicksight#WorkGroup": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.quicksight#YAxisOptions": { - "type": "structure", - "members": { - "YAxis": { - "target": "com.amazonaws.quicksight#SingleYAxisOption", - "traits": { - "smithy.api#documentation": "

The Y axis type to be used in the chart.

\n

If you choose PRIMARY_Y_AXIS, the primary Y Axis is located on the leftmost vertical axis of the chart.

", - "smithy.api#required": {} - } + "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.quicksight#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

You don't have access to this item. The provided credentials couldn't be\n\t\t\tvalidated. You might not be authorized to carry out the request. Make sure that your\n\t\t\taccount is authorized to use the Amazon QuickSight service, that your policies have the\n\t\t\tcorrect permissions, and that you are using the correct credentials.

", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + }, + "com.amazonaws.quicksight#AccountCustomization": { + "type": "structure", + "members": { + "DefaultTheme": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The default theme for this Amazon QuickSight subscription.

" + } + }, + "DefaultEmailCustomizationTemplate": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The default email customization template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight customizations associated with your Amazon Web Services account or a QuickSight namespace in a specific Amazon Web Services Region.

" + } + }, + "com.amazonaws.quicksight#AccountInfo": { + "type": "structure", + "members": { + "AccountName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The account name that you provided for the Amazon QuickSight subscription in your\n Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It's unique over all of Amazon Web Services, and it appears only when\n users sign in.

" + } + }, + "Edition": { + "target": "com.amazonaws.quicksight#Edition", + "traits": { + "smithy.api#documentation": "

The edition of your Amazon QuickSight account.

" + } + }, + "NotificationEmail": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The email address that will be used for Amazon QuickSight to send notifications regarding your Amazon Web Services account or Amazon QuickSight subscription.

" + } + }, + "AuthenticationType": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The way that your Amazon QuickSight account is authenticated.

" + } + }, + "AccountSubscriptionStatus": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The status of your account subscription.

" + } + }, + "IAMIdentityCenterInstanceArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM Identity Center instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the following account information\n elements:

\n " + } + }, + "com.amazonaws.quicksight#AccountName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 62 + }, + "smithy.api#pattern": "^(?!D-|d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*$" + } + }, + "com.amazonaws.quicksight#AccountSettings": { + "type": "structure", + "members": { + "AccountName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The \"account name\" you provided for the Amazon QuickSight subscription in your Amazon Web Services account.\n You create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web Services and\n it appears only when users sign in.

" + } + }, + "Edition": { + "target": "com.amazonaws.quicksight#Edition", + "traits": { + "smithy.api#documentation": "

The edition of Amazon QuickSight that you're currently subscribed to:\n Enterprise edition or Standard edition.

" + } + }, + "DefaultNamespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The default Amazon QuickSight namespace for your Amazon Web Services account.

" + } + }, + "NotificationEmail": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The main notification email for your Amazon QuickSight subscription.

" + } + }, + "PublicSharingEnabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For more information about turning on public sharing, see UpdatePublicSharingSettings.

" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubsctiption request. A False value will allow the ccount to be deleted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight settings associated with your Amazon Web Services account.

" + } + }, + "com.amazonaws.quicksight#ActionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#String" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#ActiveIAMPolicyAssignment": { + "type": "structure", + "members": { + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "traits": { + "smithy.api#documentation": "

A name for the IAM policy assignment.

" + } + }, + "PolicyArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The active Identity and Access Management (IAM) policy assignment.

" + } + }, + "com.amazonaws.quicksight#ActiveIAMPolicyAssignmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ActiveIAMPolicyAssignment" + } + }, + "com.amazonaws.quicksight#AdHocFilteringOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

Availability status.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An ad hoc (one-time) filtering option.

" + } + }, + "com.amazonaws.quicksight#AdditionalDashboardIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#AggFunction": { + "type": "structure", + "members": { + "Aggregation": { + "target": "com.amazonaws.quicksight#AggType", + "traits": { + "smithy.api#documentation": "

The aggregation of an Agg function.

" + } + }, + "AggregationFunctionParameters": { + "target": "com.amazonaws.quicksight#AggFunctionParamMap", + "traits": { + "smithy.api#documentation": "

The aggregation parameters for an Agg function.

" + } + }, + "Period": { + "target": "com.amazonaws.quicksight#TopicTimeGranularity", + "traits": { + "smithy.api#documentation": "

The period of an Agg function.

" + } + }, + "PeriodField": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The period field for an Agg function.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition of an Agg function.

" + } + }, + "com.amazonaws.quicksight#AggFunctionParamKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#AggFunctionParamMap": { + "type": "map", + "key": { + "target": "com.amazonaws.quicksight#AggFunctionParamKey" + }, + "value": { + "target": "com.amazonaws.quicksight#AggFunctionParamValue" + } + }, + "com.amazonaws.quicksight#AggFunctionParamValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.quicksight#AggType": { + "type": "enum", + "members": { + "SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM" + } + }, + "MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIN" + } + }, + "MAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX" + } + }, + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVERAGE" + } + }, + "DISTINCT_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTINCT_COUNT" + } + }, + "STDEV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEV" + } + }, + "STDEVP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEVP" + } + }, + "VAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VAR" + } + }, + "VARP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARP" + } + }, + "PERCENTILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENTILE" + } + }, + "MEDIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIAN" + } + }, + "PTD_SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PTD_SUM" + } + }, + "PTD_MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PTD_MIN" + } + }, + "PTD_MAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PTD_MAX" + } + }, + "PTD_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PTD_COUNT" + } + }, + "PTD_DISTINCT_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PTD_DISTINCT_COUNT" + } + }, + "PTD_AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PTD_AVERAGE" + } + }, + "COLUMN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLUMN" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } + } + }, + "com.amazonaws.quicksight#AggregationFunction": { + "type": "structure", + "members": { + "NumericalAggregationFunction": { + "target": "com.amazonaws.quicksight#NumericalAggregationFunction", + "traits": { + "smithy.api#documentation": "

Aggregation for numerical values.

" + } + }, + "CategoricalAggregationFunction": { + "target": "com.amazonaws.quicksight#CategoricalAggregationFunction", + "traits": { + "smithy.api#documentation": "

Aggregation for categorical values.

\n " + } + }, + "DateAggregationFunction": { + "target": "com.amazonaws.quicksight#DateAggregationFunction", + "traits": { + "smithy.api#documentation": "

Aggregation for date values.

\n " + } + }, + "AttributeAggregationFunction": { + "target": "com.amazonaws.quicksight#AttributeAggregationFunction", + "traits": { + "smithy.api#documentation": "

Aggregation for attributes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An aggregation function aggregates values from a dimension or measure.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#AggregationFunctionParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.quicksight#LimitedString" + }, + "value": { + "target": "com.amazonaws.quicksight#LimitedString" + } + }, + "com.amazonaws.quicksight#AggregationPartitionBy": { + "type": "structure", + "members": { + "FieldName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The field Name for an AggregationPartitionBy.

" + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The TimeGranularity for an AggregationPartitionBy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition of an AggregationPartitionBy.

" + } + }, + "com.amazonaws.quicksight#AggregationPartitionByList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AggregationPartitionBy" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AggregationSortConfiguration": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that determines the sort order of aggregated values.

", + "smithy.api#required": {} + } + }, + "SortDirection": { + "target": "com.amazonaws.quicksight#SortDirection", + "traits": { + "smithy.api#documentation": "

The sort direction of values.

\n ", + "smithy.api#required": {} + } + }, + "AggregationFunction": { + "target": "com.amazonaws.quicksight#AggregationFunction", + "traits": { + "smithy.api#documentation": "

The function that aggregates the values in Column.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration options to sort aggregated values.

" + } + }, + "com.amazonaws.quicksight#AggregationSortConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AggregationSortConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#AliasName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[\\w\\-]+|(\\$LATEST)|(\\$PUBLISHED)$" + } + }, + "com.amazonaws.quicksight#AllSheetsFilterScopeConfiguration": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

An empty object that represents that the AllSheets option is the chosen value for the FilterScopeConfiguration parameter. This structure applies the filter to all visuals on all sheets of an Analysis, Dashboard, or Template.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#AmazonElasticsearchParameters": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.quicksight#Domain", + "traits": { + "smithy.api#documentation": "

The OpenSearch domain.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for OpenSearch.

" + } + }, + "com.amazonaws.quicksight#AmazonOpenSearchParameters": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.quicksight#Domain", + "traits": { + "smithy.api#documentation": "

The OpenSearch domain.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for OpenSearch.

" + } + }, + "com.amazonaws.quicksight#Analysis": { + "type": "structure", + "members": { + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the analysis.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#AnalysisName", + "traits": { + "smithy.api#documentation": "

The descriptive name of the analysis.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

Status associated with the analysis.

" + } + }, + "Errors": { + "target": "com.amazonaws.quicksight#AnalysisErrorList", + "traits": { + "smithy.api#documentation": "

Errors associated with the analysis.

" + } + }, + "DataSetArns": { + "target": "com.amazonaws.quicksight#DataSetArnsList", + "traits": { + "smithy.api#documentation": "

The ARNs of the datasets of the analysis.

" + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the theme of the analysis.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the analysis was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the analysis was last updated.

" + } + }, + "Sheets": { + "target": "com.amazonaws.quicksight#SheetList", + "traits": { + "smithy.api#documentation": "

A list of the associated sheets with the unique identifier and name of each sheet.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata structure for an analysis in Amazon QuickSight

" + } + }, + "com.amazonaws.quicksight#AnalysisDefaults": { + "type": "structure", + "members": { + "DefaultNewSheetConfiguration": { + "target": "com.amazonaws.quicksight#DefaultNewSheetConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for default new sheet settings.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for default analysis settings.

" + } + }, + "com.amazonaws.quicksight#AnalysisDefinition": { + "type": "structure", + "members": { + "DataSetIdentifierDeclarations": { + "target": "com.amazonaws.quicksight#DataSetIdentifierDeclarationList", + "traits": { + "smithy.api#documentation": "

An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead\n of dataset ARNs throughout analysis sub-structures.

", + "smithy.api#required": {} + } + }, + "Sheets": { + "target": "com.amazonaws.quicksight#SheetDefinitionList", + "traits": { + "smithy.api#documentation": "

An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about\n a sheet within this analysis.

" + } + }, + "CalculatedFields": { + "target": "com.amazonaws.quicksight#CalculatedFields", + "traits": { + "smithy.api#documentation": "

An array of calculated field definitions for the analysis.

" + } + }, + "ParameterDeclarations": { + "target": "com.amazonaws.quicksight#ParameterDeclarationList", + "traits": { + "smithy.api#documentation": "

An array of parameter declarations for an analysis.

\n

Parameters are named variables that can transfer a value for use by an action or an object.

\n

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

" + } + }, + "FilterGroups": { + "target": "com.amazonaws.quicksight#FilterGroupList", + "traits": { + "smithy.api#documentation": "

Filter definitions for an analysis.

\n

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.

" + } + }, + "ColumnConfigurations": { + "target": "com.amazonaws.quicksight#ColumnConfigurationList", + "traits": { + "smithy.api#documentation": "

\n An array of analysis-level column configurations. Column configurations can be used to set default\n formatting for a column to be used throughout an analysis.\n

" + } + }, + "AnalysisDefaults": { + "target": "com.amazonaws.quicksight#AnalysisDefaults" + }, + "Options": { + "target": "com.amazonaws.quicksight#AssetOptions", + "traits": { + "smithy.api#documentation": "

An array of option definitions for an analysis.

" + } + }, + "QueryExecutionOptions": { + "target": "com.amazonaws.quicksight#QueryExecutionOptions" + } + }, + "traits": { + "smithy.api#documentation": "

The definition of an analysis.

" + } + }, + "com.amazonaws.quicksight#AnalysisError": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#AnalysisErrorType", + "traits": { + "smithy.api#documentation": "

The type of the analysis error.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The message associated with the analysis error.

" + } + }, + "ViolatedEntities": { + "target": "com.amazonaws.quicksight#EntityList", + "traits": { + "smithy.api#documentation": "

Lists the violated entities that caused the analysis error

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Analysis error.

" + } + }, + "com.amazonaws.quicksight#AnalysisErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AnalysisError" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.quicksight#AnalysisErrorType": { + "type": "enum", + "members": { + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_DENIED" + } + }, + "SOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOURCE_NOT_FOUND" + } + }, + "DATA_SET_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SET_NOT_FOUND" + } + }, + "INTERNAL_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_FAILURE" + } + }, + "PARAMETER_VALUE_INCOMPATIBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARAMETER_VALUE_INCOMPATIBLE" + } + }, + "PARAMETER_TYPE_INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARAMETER_TYPE_INVALID" + } + }, + "PARAMETER_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARAMETER_NOT_FOUND" + } + }, + "COLUMN_TYPE_MISMATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLUMN_TYPE_MISMATCH" + } + }, + "COLUMN_GEOGRAPHIC_ROLE_MISMATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLUMN_GEOGRAPHIC_ROLE_MISMATCH" + } + }, + "COLUMN_REPLACEMENT_MISSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLUMN_REPLACEMENT_MISSING" + } + } + } + }, + "com.amazonaws.quicksight#AnalysisFilterAttribute": { + "type": "enum", + "members": { + "QUICKSIGHT_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_USER" + } + }, + "QUICKSIGHT_VIEWER_OR_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_VIEWER_OR_OWNER" + } + }, + "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" + } + }, + "QUICKSIGHT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_OWNER" + } + }, + "DIRECT_QUICKSIGHT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_OWNER" + } + }, + "DIRECT_QUICKSIGHT_SOLE_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_SOLE_OWNER" + } + }, + "ANALYSIS_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANALYSIS_NAME" + } + } + } + }, + "com.amazonaws.quicksight#AnalysisName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#AnalysisSearchFilter": { + "type": "structure", + "members": { + "Operator": { + "target": "com.amazonaws.quicksight#FilterOperator", + "traits": { + "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\": \"StringEquals\". Valid values are \"StringEquals\" and \"StringLike\".

\n

If you set the operator value to \"StringEquals\", you need to provide an ownership related filter in the \"NAME\" field and the arn of the user or group whose folders you want to search in the \"Value\" field. For example, \"Name\":\"DIRECT_QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

\n

If you set the value to \"StringLike\", you need to provide the name of the folders you are searching for. For example, \"Name\":\"ANALYSIS_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\". The \"StringLike\" operator only supports the NAME value ANALYSIS_NAME.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#AnalysisFilterAttribute", + "traits": { + "smithy.api#documentation": "

The name of the value that you want to use as a filter, for example \"Name\":\n \"QUICKSIGHT_OWNER\".

\n

Valid values are defined as follows:

\n " + } + }, + "Value": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The value of the named item, in this case QUICKSIGHT_USER, that you want\n to use as a filter, for example \"Value\". An example is\n \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter that you apply when searching for one or more analyses.

" + } + }, + "com.amazonaws.quicksight#AnalysisSearchFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AnalysisSearchFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#AnalysisSourceEntity": { + "type": "structure", + "members": { + "SourceTemplate": { + "target": "com.amazonaws.quicksight#AnalysisSourceTemplate", + "traits": { + "smithy.api#documentation": "

The source template for the source entity of the analysis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The source entity of an analysis.

" + } + }, + "com.amazonaws.quicksight#AnalysisSourceTemplate": { + "type": "structure", + "members": { + "DataSetReferences": { + "target": "com.amazonaws.quicksight#DataSetReferenceList", + "traits": { + "smithy.api#documentation": "

The dataset references of the source template of an analysis.

", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source template of an analysis.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The source template of an analysis.

" + } + }, + "com.amazonaws.quicksight#AnalysisSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the analysis.

" + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis. This ID displays in the URL.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#AnalysisName", + "traits": { + "smithy.api#documentation": "

The name of the analysis. This name is displayed in the Amazon QuickSight console.\n

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The last known status for the analysis.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the analysis was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the analysis was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The summary metadata that describes an analysis.

" + } + }, + "com.amazonaws.quicksight#AnalysisSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AnalysisSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#Anchor": { + "type": "structure", + "members": { + "AnchorType": { + "target": "com.amazonaws.quicksight#AnchorType", + "traits": { + "smithy.api#documentation": "

The AnchorType for the Anchor.

" + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The TimeGranularity of the Anchor.

" + } + }, + "Offset": { + "target": "com.amazonaws.quicksight#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The offset of the Anchor.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition of the Anchor.

" + } + }, + "com.amazonaws.quicksight#AnchorDateConfiguration": { + "type": "structure", + "members": { + "AnchorOption": { + "target": "com.amazonaws.quicksight#AnchorOption", + "traits": { + "smithy.api#documentation": "

The options for the date configuration. Choose one of the options below:

\n " + } + }, + "ParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The name of the parameter that is used for the anchor date configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The date configuration of the filter.

" + } + }, + "com.amazonaws.quicksight#AnchorOption": { + "type": "enum", + "members": { + "NOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOW" + } + } + } + }, + "com.amazonaws.quicksight#AnchorType": { + "type": "enum", + "members": { + "TODAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TODAY" + } + } + } + }, + "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfiguration": { + "type": "structure", + "members": { + "InitialDashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard.

\n

The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

", + "smithy.api#required": {} + } + }, + "EnabledFeatures": { + "target": "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationEnabledFeatures", + "traits": { + "smithy.api#documentation": "

A list of all enabled features of a specified anonymous dashboard.

" + } + }, + "DisabledFeatures": { + "target": "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationDisabledFeatures", + "traits": { + "smithy.api#documentation": "

A list of all disabled features of a specified anonymous dashboard.

" + } + }, + "FeatureConfigurations": { + "target": "com.amazonaws.quicksight#AnonymousUserDashboardFeatureConfigurations", + "traits": { + "smithy.api#documentation": "

The feature configuration for an embedded dashboard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the dashboard that you want to embed.

" + } + }, + "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationDisabledFeature": { + "type": "enum", + "members": { + "SHARED_VIEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED_VIEW" + } + } + } + }, + "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationDisabledFeatures": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationDisabledFeature" + } + }, + "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationEnabledFeature": { + "type": "enum", + "members": { + "SHARED_VIEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED_VIEW" + } + } + } + }, + "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationEnabledFeatures": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationEnabledFeature" + } + }, + "com.amazonaws.quicksight#AnonymousUserDashboardFeatureConfigurations": { + "type": "structure", + "members": { + "SharedView": { + "target": "com.amazonaws.quicksight#SharedViewConfigurations", + "traits": { + "smithy.api#documentation": "

The shared view settings of an embedded dashboard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The feature configuration for an embedded dashboard.

" + } + }, + "com.amazonaws.quicksight#AnonymousUserDashboardVisualEmbeddingConfiguration": { + "type": "structure", + "members": { + "InitialDashboardVisualId": { + "target": "com.amazonaws.quicksight#DashboardVisualId", + "traits": { + "smithy.api#documentation": "

The visual ID for the visual that you want the user to see. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.

\n

The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.

" + } + }, + "com.amazonaws.quicksight#AnonymousUserEmbeddingExperienceConfiguration": { + "type": "structure", + "members": { + "Dashboard": { + "target": "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfiguration", + "traits": { + "smithy.api#documentation": "

The type of embedding experience. In this case, Amazon QuickSight dashboards.

" + } + }, + "DashboardVisual": { + "target": "com.amazonaws.quicksight#AnonymousUserDashboardVisualEmbeddingConfiguration", + "traits": { + "smithy.api#documentation": "

The type of embedding experience. In this case, Amazon QuickSight visuals.

" + } + }, + "QSearchBar": { + "target": "com.amazonaws.quicksight#AnonymousUserQSearchBarEmbeddingConfiguration", + "traits": { + "smithy.api#documentation": "

The Q search bar that you want to use for anonymous user embedding.

" + } + }, + "GenerativeQnA": { + "target": "com.amazonaws.quicksight#AnonymousUserGenerativeQnAEmbeddingConfiguration", + "traits": { + "smithy.api#documentation": "

The Generative Q&A experience that you want to use for anonymous user embedding.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The type of experience you want to embed. For anonymous users, you can embed Amazon QuickSight dashboards.

" + } + }, + "com.amazonaws.quicksight#AnonymousUserGenerativeQnAEmbeddingConfiguration": { + "type": "structure", + "members": { + "InitialTopicId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight Q topic ID of the new reader experience topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Generative Q&A experience with this new reader experience topic pre selected.

\n

The Amazon Resource Name (ARN) of this Q new reader experience topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The settings that you want to use for the Generative Q&A experience.

" + } + }, + "com.amazonaws.quicksight#AnonymousUserQSearchBarEmbeddingConfiguration": { + "type": "structure", + "members": { + "InitialTopicId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight Q topic ID of the legacy topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this legacy topic pre-selected.

\n

The Amazon Resource Name (ARN) of this Q legacy topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The settings that you want to use with the Q search bar.

" + } + }, + "com.amazonaws.quicksight#AnonymousUserSnapshotJobResult": { + "type": "structure", + "members": { + "FileGroups": { + "target": "com.amazonaws.quicksight#SnapshotJobResultFileGroupList", + "traits": { + "smithy.api#documentation": "

A list of SnapshotJobResultFileGroup objects that contain information on the files that are requested during a StartDashboardSnapshotJob API call. If the job succeeds, these objects contain the location where the snapshot artifacts are stored. If the job fails, the objects contain information about the error that caused the job to fail.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the file groups that are requested for the artifact generation in a StartDashboardSnapshotJob API call.\n

" + } + }, + "com.amazonaws.quicksight#AnonymousUserSnapshotJobResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AnonymousUserSnapshotJobResult" + } + }, + "com.amazonaws.quicksight#AnswerId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9-_.\\\\+]*$" + } + }, + "com.amazonaws.quicksight#AnswerIds": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AnswerId" + } + }, + "com.amazonaws.quicksight#ArcAxisConfiguration": { + "type": "structure", + "members": { + "Range": { + "target": "com.amazonaws.quicksight#ArcAxisDisplayRange", + "traits": { + "smithy.api#documentation": "

The arc axis range of a GaugeChartVisual.

" + } + }, + "ReserveRange": { + "target": "com.amazonaws.quicksight#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The reserved range of the arc axis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The arc axis configuration of a GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#ArcAxisDisplayRange": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The minimum value of the arc axis range.

" + } + }, + "Max": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum value of the arc axis range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The arc axis range of a GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#ArcConfiguration": { + "type": "structure", + "members": { + "ArcAngle": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The option that determines the arc angle of a GaugeChartVisual.

" + } + }, + "ArcThickness": { + "target": "com.amazonaws.quicksight#ArcThicknessOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the arc thickness of a GaugeChartVisual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The arc configuration of a GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#ArcOptions": { + "type": "structure", + "members": { + "ArcThickness": { + "target": "com.amazonaws.quicksight#ArcThickness", + "traits": { + "smithy.api#documentation": "

The arc thickness of a GaugeChartVisual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the arc thickness of a GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#ArcThickness": { + "type": "enum", + "members": { + "SMALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMALL" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LARGE" + } + }, + "WHOLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WHOLE" + } + } + } + }, + "com.amazonaws.quicksight#ArcThicknessOptions": { + "type": "enum", + "members": { + "SMALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMALL" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LARGE" + } + } + } + }, + "com.amazonaws.quicksight#Arn": { + "type": "string" + }, + "com.amazonaws.quicksight#ArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Arn" + } + }, + "com.amazonaws.quicksight#AssetBundleCloudFormationOverridePropertyConfiguration": { + "type": "structure", + "members": { + "ResourceIdOverrideConfiguration": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobResourceIdOverrideConfiguration", + "traits": { + "smithy.api#documentation": "

An optional list of structures that control how resource IDs are parameterized in the returned CloudFormation template.

" + } + }, + "VPCConnections": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionOverridePropertiesList", + "traits": { + "smithy.api#documentation": "

An optional list of structures that control how VPCConnection resources are parameterized in the returned CloudFormation template.

" + } + }, + "RefreshSchedules": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobRefreshScheduleOverridePropertiesList", + "traits": { + "smithy.api#documentation": "

An optional list of structures that control how RefreshSchedule resources are parameterized in the returned CloudFormation template.

" + } + }, + "DataSources": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSourceOverridePropertiesList", + "traits": { + "smithy.api#documentation": "

An optional list of structures that control how DataSource resources are parameterized in the returned CloudFormation template.

" + } + }, + "DataSets": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSetOverridePropertiesList", + "traits": { + "smithy.api#documentation": "

An optional list of structures that control how DataSet resources are parameterized in the returned CloudFormation template.

" + } + }, + "Themes": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobThemeOverridePropertiesList", + "traits": { + "smithy.api#documentation": "

An optional list of structures that control how Theme resources are parameterized in the returned CloudFormation template.

" + } + }, + "Analyses": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobAnalysisOverridePropertiesList", + "traits": { + "smithy.api#documentation": "

An optional list of structures that control how Analysis resources are parameterized in the returned CloudFormation template.

" + } + }, + "Dashboards": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDashboardOverridePropertiesList", + "traits": { + "smithy.api#documentation": "

An optional list of structures that control how Dashboard resources are parameterized in the returned CloudFormation template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An optional collection of CloudFormation property configurations that control how the export job is generated.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportFormat": { + "type": "enum", + "members": { + "CLOUDFORMATION_JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDFORMATION_JSON" + } + }, + "QUICKSIGHT_JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_JSON" + } + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobAnalysisOverrideProperties": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the specific Analysis resource whose override properties are configured in this structure.

", + "smithy.api#required": {} + } + }, + "Properties": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobAnalysisPropertyToOverrideList", + "traits": { + "smithy.api#documentation": "

A list of Analysis resource properties to generate variables for in the returned CloudFormation template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Controls how a specific Analysis resource is parameterized in the returned CloudFormation template.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobAnalysisOverridePropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobAnalysisOverrideProperties" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobAnalysisPropertyToOverride": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobAnalysisPropertyToOverrideList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobAnalysisPropertyToOverride" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDashboardOverrideProperties": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the specific Dashboard resource whose override properties are configured in this structure.

", + "smithy.api#required": {} + } + }, + "Properties": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDashboardPropertyToOverrideList", + "traits": { + "smithy.api#documentation": "

A list of Dashboard resource properties to generate variables for in the returned CloudFormation template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Controls how a specific Dashboard resource is parameterized in the returned CloudFormation template.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDashboardOverridePropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDashboardOverrideProperties" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDashboardPropertyToOverride": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDashboardPropertyToOverrideList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDashboardPropertyToOverride" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDataSetOverrideProperties": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the specific DataSet resource whose override properties are configured in this structure.

", + "smithy.api#required": {} + } + }, + "Properties": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSetPropertyToOverrideList", + "traits": { + "smithy.api#documentation": "

A list of DataSet resource properties to generate variables for in the returned CloudFormation template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Controls how a specific DataSet resource is parameterized in the returned CloudFormation template.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDataSetOverridePropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSetOverrideProperties" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDataSetPropertyToOverride": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDataSetPropertyToOverrideList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSetPropertyToOverride" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDataSourceOverrideProperties": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the specific DataSource resource whose override properties are configured in this structure.

", + "smithy.api#required": {} + } + }, + "Properties": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSourcePropertyToOverrideList", + "traits": { + "smithy.api#documentation": "

A list of DataSource resource properties to generate variables for in the returned CloudFormation template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Controls how a specific DataSource resource is parameterized in the returned CloudFormation template.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDataSourceOverridePropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSourceOverrideProperties" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDataSourcePropertyToOverride": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "DISABLE_SSL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DisableSsl" + } + }, + "SECRET_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SecretArn" + } + }, + "USERNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Username" + } + }, + "PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Password" + } + }, + "DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Domain" + } + }, + "WORK_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WorkGroup" + } + }, + "HOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Host" + } + }, + "PORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Port" + } + }, + "DATABASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Database" + } + }, + "DATA_SET_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DataSetName" + } + }, + "CATALOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Catalog" + } + }, + "INSTANCE_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceId" + } + }, + "CLUSTER_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClusterId" + } + }, + "MANIFEST_FILE_LOCATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ManifestFileLocation" + } + }, + "WAREHOUSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Warehouse" + } + }, + "ROLE_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RoleArn" + } + }, + "PRODUCT_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ProductType" + } + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDataSourcePropertyToOverrideList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSourcePropertyToOverride" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobError": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource whose processing caused an error.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The specific error type of the error that occurred.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an error that occurred during an Asset Bundle export job.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobError" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobRefreshScheduleOverrideProperties": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the specific RefreshSchedule resource whose override properties are configured in this structure.

", + "smithy.api#required": {} + } + }, + "Properties": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobRefreshSchedulePropertyToOverrideList", + "traits": { + "smithy.api#documentation": "

A list of RefreshSchedule resource properties to generate variables for in the returned CloudFormation template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Controls how a specific RefreshSchedule resource is parameterized in the returned CloudFormation template.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobRefreshScheduleOverridePropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobRefreshScheduleOverrideProperties" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobRefreshSchedulePropertyToOverride": { + "type": "enum", + "members": { + "START_AFTER_DATE_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartAfterDateTime" + } + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobRefreshSchedulePropertyToOverrideList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobRefreshSchedulePropertyToOverride" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobResourceIdOverrideConfiguration": { + "type": "structure", + "members": { + "PrefixForAllResources": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An optional structure that configures resource ID overrides for the export job.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobStatus": { + "type": "enum", + "members": { + "QUEUED_FOR_IMMEDIATE_EXECUTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUED_FOR_IMMEDIATE_EXECUTION" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESSFUL" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobSummary": { + "type": "structure", + "members": { + "JobStatus": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the export job.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the export job.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the export job was created.

" + } + }, + "AssetBundleExportJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the export job.

" + } + }, + "IncludeAllDependencies": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The flag that determines the inclusion of resource dependencies in the returned asset bundle.

" + } + }, + "ExportFormat": { + "target": "com.amazonaws.quicksight#AssetBundleExportFormat", + "traits": { + "smithy.api#documentation": "

The format for the export job.

" + } + }, + "IncludePermissions": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The flag that determines the inclusion of permissions associated with each resource ARN.

" + } + }, + "IncludeTags": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The flag that determines the inclusion of tags associated with each resource ARN.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the export job that includes details of the job's configuration and its current status.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobSummary" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobThemeOverrideProperties": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the specific Theme resource whose override properties are configured in this structure.

", + "smithy.api#required": {} + } + }, + "Properties": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobThemePropertyToOverrideList", + "traits": { + "smithy.api#documentation": "

A list of Theme resource properties to generate variables for in the returned CloudFormation template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Controls how a specific Theme resource is parameterized in the returned CloudFormation template.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobThemeOverridePropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobThemeOverrideProperties" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobThemePropertyToOverride": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobThemePropertyToOverrideList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobThemePropertyToOverride" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionOverrideProperties": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the specific VPCConnection resource whose override properties are configured in this structure.

", + "smithy.api#required": {} + } + }, + "Properties": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionPropertyToOverrideList", + "traits": { + "smithy.api#documentation": "

A list of VPCConnection resource properties to generate variables for in the returned CloudFormation template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Controls how a specific VPCConnection resource is parameterized in the outputted CloudFormation template.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionOverridePropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionOverrideProperties" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionPropertyToOverride": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "DNS_RESOLVERS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DnsResolvers" + } + }, + "ROLE_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RoleArn" + } + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionPropertyToOverrideList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionPropertyToOverride" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobValidationStrategy": { + "type": "structure", + "members": { + "StrictModeForAllResources": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that indicates whether to export resources under strict or lenient mode.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The option to relax the validation that is required to export each asset. When StrictModeForAllResource is set to false, validation is skipped for specific UI errors.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobWarning": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource whose processing caused a warning.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the warning.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a warning that occurred during an Asset Bundle export job.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobWarningList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobWarning" + } + }, + "com.amazonaws.quicksight#AssetBundleImportBodyBlob": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20971520 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#AssetBundleImportFailureAction": { + "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" + } + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideParameters": { + "type": "structure", + "members": { + "AnalysisId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis that you ant to apply overrides to.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

A new name for the analysis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The override parameters for a single analysis that is being imported.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideParameters" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverridePermissions": { + "type": "structure", + "members": { + "AnalysisIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", + "traits": { + "smithy.api#documentation": "

A list of permissions for the analyses that you want to apply overrides to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of permissions to be applied to a list of analysis IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverridePermissionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverridePermissions" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideTags": { + "type": "structure", + "members": { + "AnalysisIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags for the analyses that you want to apply overrides to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of analysis IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideTags" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideParameters": { + "type": "structure", + "members": { + "DashboardId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dashboard that you want to apply overrides to.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

A new name for the dashboard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The override parameters for a single dashboard that is being imported.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideParameters" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverridePermissions": { + "type": "structure", + "members": { + "DashboardIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", + "traits": { + "smithy.api#documentation": "

A list of permissions for the dashboards that you want to apply overrides to.

" + } + }, + "LinkSharingConfiguration": { + "target": "com.amazonaws.quicksight#AssetBundleResourceLinkSharingConfiguration", + "traits": { + "smithy.api#documentation": "

A structure that contains the link sharing configurations that you want to apply overrides to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of permissions to be applied to a list of dashboard IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverridePermissionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverridePermissions" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideTags": { + "type": "structure", + "members": { + "DashboardIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags for the dashboards that you want to apply overrides to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of dashboard IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideTags" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideParameters": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset to apply overrides to.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

A new name for the dataset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The override parameters for a single dataset that is being imported.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideParameters" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverridePermissions": { + "type": "structure", + "members": { + "DataSetIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", + "traits": { + "smithy.api#documentation": "

A list of permissions for the datasets that you want to apply overrides to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of permissions to be applied to a list of dataset IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverridePermissionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverridePermissions" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideTags": { + "type": "structure", + "members": { + "DataSetIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags for the datasets that you want to apply overrides to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of dataset IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideTags" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSourceCredentialPair": { + "type": "structure", + "members": { + "Username": { + "target": "com.amazonaws.quicksight#DbUsername", + "traits": { + "smithy.api#documentation": "

The username for the data source connection.

", + "smithy.api#required": {} + } + }, + "Password": { + "target": "com.amazonaws.quicksight#Password", + "traits": { + "smithy.api#documentation": "

The password for the data source connection.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A username and password credential pair to use to import a data source resource.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSourceCredentials": { + "type": "structure", + "members": { + "CredentialPair": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceCredentialPair", + "traits": { + "smithy.api#documentation": "

A username and password credential pair to be used to create the imported data source. Keep this field blank if you are using a Secrets Manager secret to provide credentials.

" + } + }, + "SecretArn": { + "target": "com.amazonaws.quicksight#SecretArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Secrets Manager secret that's used to create the imported data source. Keep this field blank, unless you are using a secret in place of a credential pair.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The login credentials to use to import a data source resource.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideParameters": { + "type": "structure", + "members": { + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source to apply overrides to.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

A new name for the data source.

" + } + }, + "DataSourceParameters": { + "target": "com.amazonaws.quicksight#DataSourceParameters" + }, + "VpcConnectionProperties": { + "target": "com.amazonaws.quicksight#VpcConnectionProperties" + }, + "SslProperties": { + "target": "com.amazonaws.quicksight#SslProperties" + }, + "Credentials": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceCredentials", + "traits": { + "smithy.api#documentation": "

An optional structure that provides the credentials to be used to create the imported data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The override parameters for a single data source that is being imported.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideParameters" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverridePermissions": { + "type": "structure", + "members": { + "DataSourceIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", + "traits": { + "smithy.api#documentation": "

A list of permissions for the data source that you want to apply overrides to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of permissions to be applied to a list of data source IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverridePermissionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverridePermissions" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideTags": { + "type": "structure", + "members": { + "DataSourceIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags for the data source that you want to apply overrides to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of data source IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideTags" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobError": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource whose processing caused an error.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The specific error type or the error that occurred.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an error that occurred within an Asset Bundle import execution.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobError" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobOverrideParameters": { + "type": "structure", + "members": { + "ResourceIdOverrideConfiguration": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobResourceIdOverrideConfiguration", + "traits": { + "smithy.api#documentation": "

An optional structure that configures resource ID overrides to be applied within the import job.

" + } + }, + "VPCConnections": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideParametersList", + "traits": { + "smithy.api#documentation": "

A list of overrides for any VPCConnection resources that are present in the asset bundle that is imported.

" + } + }, + "RefreshSchedules": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobRefreshScheduleOverrideParametersList", + "traits": { + "smithy.api#documentation": "

A list of overrides for any RefreshSchedule resources that are present in the asset bundle that is imported.

" + } + }, + "DataSources": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideParametersList", + "traits": { + "smithy.api#documentation": "

A list of overrides for any DataSource resources that are present in the asset bundle that is imported.

" + } + }, + "DataSets": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideParametersList", + "traits": { + "smithy.api#documentation": "

A list of overrides for any DataSet resources that are present in the asset bundle that is imported.

" + } + }, + "Themes": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideParametersList", + "traits": { + "smithy.api#documentation": "

A list of overrides for any Theme resources that are present in the asset bundle that is imported.

" + } + }, + "Analyses": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideParametersList", + "traits": { + "smithy.api#documentation": "

A list of overrides for any Analysis resources that are present in the asset bundle that is imported.

" + } + }, + "Dashboards": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideParametersList", + "traits": { + "smithy.api#documentation": "

A list of overrides for any Dashboard resources that are present in the asset bundle that is imported.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of overrides that modify the asset bundle resource configuration before the resource is imported.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobOverridePermissions": { + "type": "structure", + "members": { + "DataSources": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverridePermissionsList", + "traits": { + "smithy.api#documentation": "

A list of permissions overrides for any DataSource resources that are present in the asset bundle that is imported.

" + } + }, + "DataSets": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverridePermissionsList", + "traits": { + "smithy.api#documentation": "

A list of permissions overrides for any DataSet resources that are present in the asset bundle that is imported.

" + } + }, + "Themes": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverridePermissionsList", + "traits": { + "smithy.api#documentation": "

A list of permissions overrides for any Theme resources that are present in the asset bundle that is imported.

" + } + }, + "Analyses": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverridePermissionsList", + "traits": { + "smithy.api#documentation": "

A list of permissions overrides for any Analysis resources that are present in the asset bundle that is imported.

" + } + }, + "Dashboards": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverridePermissionsList", + "traits": { + "smithy.api#documentation": "

A list of permissions overrides for any Dashboard resources that are present in the asset bundle that is imported.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the override permission configurations that modify the permissions for specified resources before the resource is imported.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobOverrideTags": { + "type": "structure", + "members": { + "VPCConnections": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideTagsList", + "traits": { + "smithy.api#documentation": "

A list of tag overrides for any VPCConnection resources that are present in the asset bundle that is imported.

" + } + }, + "DataSources": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideTagsList", + "traits": { + "smithy.api#documentation": "

A list of tag overrides for any DataSource resources that are present in the asset bundle that is imported.

" + } + }, + "DataSets": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideTagsList", + "traits": { + "smithy.api#documentation": "

A list of tag overrides for any DataSet resources that are present in the asset bundle that is imported.

" + } + }, + "Themes": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideTagsList", + "traits": { + "smithy.api#documentation": "

A list of tag overrides for any Theme resources that are present in the asset bundle that is imported.

" + } + }, + "Analyses": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideTagsList", + "traits": { + "smithy.api#documentation": "

A list of tag overrides for any Analysis resources that are present in the asset bundle that is imported.

" + } + }, + "Dashboards": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideTagsList", + "traits": { + "smithy.api#documentation": "

A list of tag overrides for any Dashboard resources that are present in the asset bundle that is imported.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the override tag configuration that modify the tags that are assigned to specified resources before the resource is imported.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobOverrideValidationStrategy": { + "type": "structure", + "members": { + "StrictModeForAllResources": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An optional parameter that overrides the validation strategy for all analyses and dashboards before the resource is imported.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobRefreshScheduleOverrideParameters": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

A partial identifier for the specific RefreshSchedule resource that is being overridden. This structure is used together with the ScheduleID structure.

", + "smithy.api#required": {} + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A partial identifier for the specific RefreshSchedule resource being overridden. This structure is used together with the DataSetId structure.

", + "smithy.api#required": {} + } + }, + "StartAfterDateTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

An override for the StartAfterDateTime of a RefreshSchedule. Make\n sure that the StartAfterDateTime is set to a time that takes\n place in the future.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of overrides for a specific RefreshsSchedule resource that is present in the asset bundle that is imported.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobRefreshScheduleOverrideParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobRefreshScheduleOverrideParameters" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobResourceIdOverrideConfiguration": { + "type": "structure", + "members": { + "PrefixForAllResources": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An optional structure that configures resource ID overrides for the import job.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobStatus": { + "type": "enum", + "members": { + "QUEUED_FOR_IMMEDIATE_EXECUTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUED_FOR_IMMEDIATE_EXECUTION" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESSFUL" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "FAILED_ROLLBACK_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_ROLLBACK_IN_PROGRESS" + } + }, + "FAILED_ROLLBACK_COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_ROLLBACK_COMPLETED" + } + }, + "FAILED_ROLLBACK_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_ROLLBACK_ERROR" + } + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobSummary": { + "type": "structure", + "members": { + "JobStatus": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the import job.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the import job.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the import job was created.

" + } + }, + "AssetBundleImportJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

" + } + }, + "FailureAction": { + "target": "com.amazonaws.quicksight#AssetBundleImportFailureAction", + "traits": { + "smithy.api#documentation": "

The failure action for the import job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the import job that includes details of the requested job's configuration and its current status.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobSummary" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideParameters": { + "type": "structure", + "members": { + "ThemeId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the theme to apply overrides to.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

A new name for the theme.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The override parameters for a single theme that is imported.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideParameters" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobThemeOverridePermissions": { + "type": "structure", + "members": { + "ThemeIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", + "traits": { + "smithy.api#documentation": "

A list of permissions for the themes that you want to apply overrides to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of permissions to be applied to a list of theme IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobThemeOverridePermissionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverridePermissions" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideTags": { + "type": "structure", + "members": { + "ThemeIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags for the themes that you want to apply overrides to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of theme IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideTags" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideParameters": { + "type": "structure", + "members": { + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", + "traits": { + "smithy.api#documentation": "

The ID of the VPC Connection to apply overrides to.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

A new name for the VPC connection.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.quicksight#SubnetIdList", + "traits": { + "smithy.api#documentation": "

A list of new subnet IDs for the VPC connection you are importing. This field is\n required if you are importing the VPC connection from another Amazon Web Services account or Region.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.quicksight#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A new security group ID for the VPC connection you are importing. This field is required\n if you are importing the VPC connection from another Amazon Web Services account or Region.

" + } + }, + "DnsResolvers": { + "target": "com.amazonaws.quicksight#DnsResolverList", + "traits": { + "smithy.api#documentation": "

An optional override of DNS resolvers to be used by the VPC connection.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.quicksight#RoleArn", + "traits": { + "smithy.api#documentation": "

An optional override of the role ARN to be used by the VPC connection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The override parameters for a single VPC connection that is imported.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideParameters" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideTags": { + "type": "structure", + "members": { + "VPCConnectionIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of VPC connection IDs that you want to apply overrides to. You can use * to override all VPC connections in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags for the VPC connections that you want to apply overrides to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of VPC connection IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideTags" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobWarning": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource that the warning occurred for.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the warning that occurred during an Asset Bundle import job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a warning that occurred during an Asset Bundle import job.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobWarningList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobWarning" + } + }, + "com.amazonaws.quicksight#AssetBundleImportSource": { + "type": "structure", + "members": { + "Body": { + "target": "com.amazonaws.quicksight#AssetBundleImportBodyBlob", + "traits": { + "smithy.api#documentation": "

The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB.

\n

If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or\n PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using\n an SDK for a different language or receiving related errors, try to base64 encode your data.

" + } + }, + "S3Uri": { + "target": "com.amazonaws.quicksight#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller\n has read access to. The file must be a zip format file and can't exceed 20 MB.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportSourceDescription": { + "type": "structure", + "members": { + "Body": { + "target": "com.amazonaws.quicksight#SensitiveS3Uri", + "traits": { + "smithy.api#documentation": "

An HTTPS download URL for the provided asset bundle that you optionally provided at the start of the import job. This URL is valid for five minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed. The downloaded asset bundle is a .qs zip file.

" + } + }, + "S3Uri": { + "target": "com.amazonaws.quicksight#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI that you provided at the start of the import job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A description of the import source that you provide at the start of an import job. This value is set to either Body or S3Uri, depending on how the StartAssetBundleImportJobRequest is configured.

" + } + }, + "com.amazonaws.quicksight#AssetBundlePrincipalList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Principal" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#AssetBundleResourceArns": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Arn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#AssetBundleResourceLinkSharingConfiguration": { + "type": "structure", + "members": { + "Permissions": { + "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", + "traits": { + "smithy.api#documentation": "

A list of link sharing permissions for the dashboards that you want to apply overrides to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the configuration of a shared link to an Amazon QuickSight dashboard.

" + } + }, + "com.amazonaws.quicksight#AssetBundleResourcePermissions": { + "type": "structure", + "members": { + "Principals": { + "target": "com.amazonaws.quicksight#AssetBundlePrincipalList", + "traits": { + "smithy.api#documentation": "

A list of principals to grant permissions on.

", + "smithy.api#required": {} + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#ActionList", + "traits": { + "smithy.api#documentation": "

A list of IAM actions to grant permissions on.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the permissions for the resource that you want to override in an asset bundle import job.

" + } + }, + "com.amazonaws.quicksight#AssetBundleRestrictiveResourceId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\*|[\\w\\-]{1,2048}$" + } + }, + "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetOptions": { + "type": "structure", + "members": { + "Timezone": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

Determines the timezone for the analysis.

" + } + }, + "WeekStart": { + "target": "com.amazonaws.quicksight#DayOfTheWeek", + "traits": { + "smithy.api#documentation": "

Determines the week start day for an analysis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An array of analysis level configurations.

" + } + }, + "com.amazonaws.quicksight#AssignmentStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DRAFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRAFT" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.quicksight#AthenaParameters": { + "type": "structure", + "members": { + "WorkGroup": { + "target": "com.amazonaws.quicksight#WorkGroup", + "traits": { + "smithy.api#documentation": "

The workgroup that Amazon Athena uses.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.quicksight#RoleArn", + "traits": { + "smithy.api#documentation": "

Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Parameters for Amazon Athena.

" + } + }, + "com.amazonaws.quicksight#AttributeAggregationFunction": { + "type": "structure", + "members": { + "SimpleAttributeAggregation": { + "target": "com.amazonaws.quicksight#SimpleAttributeAggregationFunction", + "traits": { + "smithy.api#documentation": "

The built-in aggregation functions for attributes.

\n " + } + }, + "ValueForMultipleValues": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to '*'.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Aggregation for attributes.

" + } + }, + "com.amazonaws.quicksight#AuroraParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

Host.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

Port.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

Database.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Parameters for Amazon Aurora.

" + } + }, + "com.amazonaws.quicksight#AuroraPostgreSqlParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

The Amazon Aurora PostgreSQL-Compatible host to connect to.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

The port that Amazon Aurora PostgreSQL is listening on.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

The Amazon Aurora PostgreSQL database to connect to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Parameters for Amazon Aurora PostgreSQL-Compatible Edition.

" + } + }, + "com.amazonaws.quicksight#AuthenticationMethodOption": { + "type": "enum", + "members": { + "IAM_AND_QUICKSIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_AND_QUICKSIGHT" + } + }, + "IAM_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_ONLY" + } + }, + "ACTIVE_DIRECTORY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE_DIRECTORY" + } + }, + "IAM_IDENTITY_CENTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_IDENTITY_CENTER" + } + } + } + }, + "com.amazonaws.quicksight#AuthorSpecifiedAggregation": { + "type": "enum", + "members": { + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "DISTINCT_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTINCT_COUNT" + } + }, + "MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIN" + } + }, + "MAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX" + } + }, + "MEDIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIAN" + } + }, + "SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM" + } + }, + "AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVERAGE" + } + }, + "STDEV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEV" + } + }, + "STDEVP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEVP" + } + }, + "VAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VAR" + } + }, + "VARP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARP" + } + }, + "PERCENTILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENTILE" + } + } + } + }, + "com.amazonaws.quicksight#AuthorSpecifiedAggregations": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AuthorSpecifiedAggregation" + } + }, + "com.amazonaws.quicksight#AuthorizedTargetsByService": { + "type": "structure", + "members": { + "Service": { + "target": "com.amazonaws.quicksight#ServiceType", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Web Services service.

" + } + }, + "AuthorizedTargets": { + "target": "com.amazonaws.quicksight#AuthorizedTargetsList", + "traits": { + "smithy.api#documentation": "

Aist of authorized targets that are represented by IAM Identity Center application ARNs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The authorized targets that are associated with a service.

" + } + }, + "com.amazonaws.quicksight#AuthorizedTargetsByServices": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AuthorizedTargetsByService" + } + }, + "com.amazonaws.quicksight#AuthorizedTargetsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#String" + } + }, + "com.amazonaws.quicksight#AwsAccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.quicksight#AwsAndAccountId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(aws|[0-9]{12})$" + } + }, + "com.amazonaws.quicksight#AwsIotAnalyticsParameters": { + "type": "structure", + "members": { + "DataSetName": { + "target": "com.amazonaws.quicksight#DataSetName", + "traits": { + "smithy.api#documentation": "

Dataset name.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for IoT Analytics.

" + } + }, + "com.amazonaws.quicksight#AxisBinding": { + "type": "enum", + "members": { + "PRIMARY_YAXIS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIMARY_YAXIS" + } + }, + "SECONDARY_YAXIS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECONDARY_YAXIS" + } + } + } + }, + "com.amazonaws.quicksight#AxisDataOptions": { + "type": "structure", + "members": { + "NumericAxisOptions": { + "target": "com.amazonaws.quicksight#NumericAxisOptions", + "traits": { + "smithy.api#documentation": "

The options for an axis with a numeric field.

" + } + }, + "DateAxisOptions": { + "target": "com.amazonaws.quicksight#DateAxisOptions", + "traits": { + "smithy.api#documentation": "

The options for an axis with a date field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data options for an axis.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#AxisDisplayDataDrivenRange": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The options that are saved for future extension.

" + } + }, + "com.amazonaws.quicksight#AxisDisplayMinMaxRange": { + "type": "structure", + "members": { + "Minimum": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The minimum setup for an axis display range.

" + } + }, + "Maximum": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum setup for an axis display range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum setup for an axis display range.

" + } + }, + "com.amazonaws.quicksight#AxisDisplayOptions": { + "type": "structure", + "members": { + "TickLabelOptions": { + "target": "com.amazonaws.quicksight#AxisTickLabelOptions", + "traits": { + "smithy.api#documentation": "

The tick label options of an axis.

" + } + }, + "AxisLineVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines whether or not the axis line is visible.

" + } + }, + "GridLineVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines whether or not the grid line is visible.

" + } + }, + "DataOptions": { + "target": "com.amazonaws.quicksight#AxisDataOptions", + "traits": { + "smithy.api#documentation": "

The data options for an axis.

" + } + }, + "ScrollbarOptions": { + "target": "com.amazonaws.quicksight#ScrollBarOptions", + "traits": { + "smithy.api#documentation": "

The scroll bar options for an axis.

" + } + }, + "AxisOffset": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The offset value that determines the starting placement of the axis within a visual's bounds.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options for the axis label.

" + } + }, + "com.amazonaws.quicksight#AxisDisplayRange": { + "type": "structure", + "members": { + "MinMax": { + "target": "com.amazonaws.quicksight#AxisDisplayMinMaxRange", + "traits": { + "smithy.api#documentation": "

The minimum and maximum setup of an axis display range.

" + } + }, + "DataDriven": { + "target": "com.amazonaws.quicksight#AxisDisplayDataDrivenRange", + "traits": { + "smithy.api#documentation": "

The data-driven setup of an axis display range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The range setup of a numeric axis display range.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#AxisLabelOptions": { + "type": "structure", + "members": { + "FontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration", + "traits": { + "smithy.api#documentation": "

The font configuration of the axis label.

" + } + }, + "CustomLabel": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The text for the axis label.

" + } + }, + "ApplyTo": { + "target": "com.amazonaws.quicksight#AxisLabelReferenceOptions", + "traits": { + "smithy.api#documentation": "

The options that indicate which field the label belongs to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The label options for a chart axis. You must specify the field that the label is targeted to.

" + } + }, + "com.amazonaws.quicksight#AxisLabelOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AxisLabelOptions" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#AxisLabelReferenceOptions": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field that the axis label is targeted to.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the axis label is targeted to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The reference that specifies where the axis label is applied to.

" + } + }, + "com.amazonaws.quicksight#AxisLinearScale": { + "type": "structure", + "members": { + "StepCount": { + "target": "com.amazonaws.quicksight#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The step count setup of a linear axis.

" + } + }, + "StepSize": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The step size setup of a linear axis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The liner axis scale setup.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#AxisLogarithmicScale": { + "type": "structure", + "members": { + "Base": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The base setup of a logarithmic axis scale.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The logarithmic axis scale setup.

" + } + }, + "com.amazonaws.quicksight#AxisScale": { + "type": "structure", + "members": { + "Linear": { + "target": "com.amazonaws.quicksight#AxisLinearScale", + "traits": { + "smithy.api#documentation": "

The linear axis scale setup.

" + } + }, + "Logarithmic": { + "target": "com.amazonaws.quicksight#AxisLogarithmicScale", + "traits": { + "smithy.api#documentation": "

The logarithmic axis scale setup.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The scale setup\n options for a numeric axis display.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#AxisTickLabelOptions": { + "type": "structure", + "members": { + "LabelOptions": { + "target": "com.amazonaws.quicksight#LabelOptions", + "traits": { + "smithy.api#documentation": "

Determines whether or not the axis ticks are visible.

" + } + }, + "RotationAngle": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The rotation angle of the axis tick labels.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tick label options of an axis.

" + } + }, + "com.amazonaws.quicksight#BarChartAggregatedFieldWells": { + "type": "structure", + "members": { + "Category": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The category (y-axis) field well of a bar chart.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The value field wells of a bar chart. Values are aggregated by\n category.

" + } + }, + "Colors": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The color (group/color) field well of a bar chart.

" + } + }, + "SmallMultiples": { + "target": "com.amazonaws.quicksight#SmallMultiplesDimensionFieldList", + "traits": { + "smithy.api#documentation": "

The small multiples field well of a bar chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a bar chart.

" + } + }, + "com.amazonaws.quicksight#BarChartConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#BarChartFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#BarChartSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a BarChartVisual.

" + } + }, + "Orientation": { + "target": "com.amazonaws.quicksight#BarChartOrientation", + "traits": { + "smithy.api#documentation": "

The orientation of the bars in a bar chart visual. There are two valid values in this structure:

\n " + } + }, + "BarsArrangement": { + "target": "com.amazonaws.quicksight#BarsArrangement", + "traits": { + "smithy.api#documentation": "

Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" + } + }, + "SmallMultiplesOptions": { + "target": "com.amazonaws.quicksight#SmallMultiplesOptions", + "traits": { + "smithy.api#documentation": "

The small multiples setup for the visual.

" + } + }, + "CategoryAxis": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The label display options (grid line, range, scale, axis step) for bar chart category.

" + } + }, + "CategoryLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility and sort icon visibility) for a bar chart.

" + } + }, + "ValueAxis": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The label display options (grid line, range, scale, axis step) for a bar chart value.

" + } + }, + "ValueLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility and sort icon visibility) for a bar chart value.

" + } + }, + "ColorLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "

The legend display setup of the visual.

" + } + }, + "DataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The tooltip display setup of the visual.

" + } + }, + "ReferenceLines": { + "target": "com.amazonaws.quicksight#ReferenceLineList", + "traits": { + "smithy.api#documentation": "

The reference line setup of the visual.

" + } + }, + "ContributionAnalysisDefaults": { + "target": "com.amazonaws.quicksight#ContributionAnalysisDefaultList", + "traits": { + "smithy.api#documentation": "

The contribution analysis (anomaly configuration) setup of the visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a BarChartVisual.

" + } + }, + "com.amazonaws.quicksight#BarChartFieldWells": { + "type": "structure", + "members": { + "BarChartAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#BarChartAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a bar chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field wells of a BarChartVisual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#BarChartOrientation": { + "type": "enum", + "members": { + "HORIZONTAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HORIZONTAL" + } + }, + "VERTICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERTICAL" + } + } + } + }, + "com.amazonaws.quicksight#BarChartSortConfiguration": { + "type": "structure", + "members": { + "CategorySort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of category fields.

" + } + }, + "CategoryItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of categories displayed in a bar chart.

" + } + }, + "ColorSort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of color fields in a bar chart.

" + } + }, + "ColorItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of values displayed in a bar chart.

" + } + }, + "SmallMultiplesSort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the small multiples field.

" + } + }, + "SmallMultiplesLimitConfiguration": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of small multiples panels that are displayed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

sort-configuration-description

" + } + }, + "com.amazonaws.quicksight#BarChartVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#BarChartConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A bar chart.

\n

The BarChartVisual structure describes a visual that is a member of the bar chart family. The following charts can be described using this structure:

\n \n

For more information, see Using bar charts in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#BarsArrangement": { + "type": "enum", + "members": { + "CLUSTERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLUSTERED" + } + }, + "STACKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STACKED" + } + }, + "STACKED_PERCENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STACKED_PERCENT" + } + } + } + }, + "com.amazonaws.quicksight#BaseMapStyleType": { + "type": "enum", + "members": { + "LIGHT_GRAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIGHT_GRAY" + } + }, + "DARK_GRAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DARK_GRAY" + } + }, + "STREET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREET" + } + }, + "IMAGERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGERY" + } + } + } + }, + "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswer": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswerRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates new reviewed answers for a Q Topic.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/batch-create-reviewed-answers", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswerRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that you want to create a reviewed answer in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Answers": { + "target": "com.amazonaws.quicksight#CreateTopicReviewedAnswers", + "traits": { + "smithy.api#documentation": "

The definition of the Answers to be created.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswerResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region\n for each Amazon Web Services account.

" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "SucceededAnswers": { + "target": "com.amazonaws.quicksight#SucceededTopicReviewedAnswers", + "traits": { + "smithy.api#documentation": "

The definition of Answers that are successfully created.

" + } + }, + "InvalidAnswers": { + "target": "com.amazonaws.quicksight#InvalidTopicReviewedAnswers", + "traits": { + "smithy.api#documentation": "

The definition of Answers that are invalid and not created.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswer": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswerRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes reviewed answers for Q Topic.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/batch-delete-reviewed-answers", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswerRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that you want to delete a reviewed answers in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID for the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AnswerIds": { + "target": "com.amazonaws.quicksight#AnswerIds", + "traits": { + "smithy.api#documentation": "

The Answer IDs of the Answers to be deleted.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswerResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "SucceededAnswers": { + "target": "com.amazonaws.quicksight#SucceededTopicReviewedAnswers", + "traits": { + "smithy.api#documentation": "

The definition of Answers that are successfully deleted.

" + } + }, + "InvalidAnswers": { + "target": "com.amazonaws.quicksight#InvalidTopicReviewedAnswers", + "traits": { + "smithy.api#documentation": "

The definition of Answers that are invalid and not deleted.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#BigQueryParameters": { + "type": "structure", + "members": { + "ProjectId": { + "target": "com.amazonaws.quicksight#ProjectId", + "traits": { + "smithy.api#documentation": "

The Google Cloud Platform project ID where your datasource was created.

", + "smithy.api#required": {} + } + }, + "DataSetRegion": { + "target": "com.amazonaws.quicksight#DataSetRegion", + "traits": { + "smithy.api#documentation": "

The storage location where you create a Google BigQuery data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters that are required to connect to a Google BigQuery data source.

" + } + }, + "com.amazonaws.quicksight#BinCountLimit": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.quicksight#BinCountOptions": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.quicksight#BinCountValue", + "traits": { + "smithy.api#documentation": "

The options that determine the bin count value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the bin count of a histogram.

" + } + }, + "com.amazonaws.quicksight#BinCountValue": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.quicksight#BinWidthOptions": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.quicksight#BinWidthValue", + "traits": { + "smithy.api#documentation": "

The options that determine the bin width value.

" + } + }, + "BinCountLimit": { + "target": "com.amazonaws.quicksight#BinCountLimit", + "traits": { + "smithy.api#documentation": "

The options that determine the bin count limit.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the bin width of a histogram.

" + } + }, + "com.amazonaws.quicksight#BinWidthValue": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.quicksight#BodySectionConfiguration": { + "type": "structure", + "members": { + "SectionId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a body section.

", + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.quicksight#BodySectionContent", + "traits": { + "smithy.api#documentation": "

The configuration of content in a body section.

", + "smithy.api#required": {} + } + }, + "Style": { + "target": "com.amazonaws.quicksight#SectionStyle", + "traits": { + "smithy.api#documentation": "

The style options of a body section.

" + } + }, + "PageBreakConfiguration": { + "target": "com.amazonaws.quicksight#SectionPageBreakConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of a page break for a section.

" + } + }, + "RepeatConfiguration": { + "target": "com.amazonaws.quicksight#BodySectionRepeatConfiguration", + "traits": { + "smithy.api#documentation": "

Describes the configurations that are required to declare a section as repeating.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a body section.

" + } + }, + "com.amazonaws.quicksight#BodySectionConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#BodySectionConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 28 + } + } + }, + "com.amazonaws.quicksight#BodySectionContent": { + "type": "structure", + "members": { + "Layout": { + "target": "com.amazonaws.quicksight#SectionLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

The layout configuration of a body section.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of content in a body section.

" + } + }, + "com.amazonaws.quicksight#BodySectionDynamicCategoryDimensionConfiguration": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#required": {} + } + }, + "Limit": { + "target": "com.amazonaws.quicksight#BodySectionDynamicDimensionLimit", + "traits": { + "smithy.api#documentation": "

Number of values to use from the column for repetition.

" + } + }, + "SortByMetrics": { + "target": "com.amazonaws.quicksight#BodySectionDynamicDimensionSortConfigurationList", + "traits": { + "smithy.api#documentation": "

Sort criteria on the column values that you use for repetition.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Category dataset column and constraints for the dynamic values used to repeat the contents of a section.

" + } + }, + "com.amazonaws.quicksight#BodySectionDynamicDimensionLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.quicksight#BodySectionDynamicDimensionSortConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnSort" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#BodySectionDynamicNumericDimensionConfiguration": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#required": {} + } + }, + "Limit": { + "target": "com.amazonaws.quicksight#BodySectionDynamicDimensionLimit", + "traits": { + "smithy.api#documentation": "

Number of values to use from the column for repetition.

" + } + }, + "SortByMetrics": { + "target": "com.amazonaws.quicksight#BodySectionDynamicDimensionSortConfigurationList", + "traits": { + "smithy.api#documentation": "

Sort criteria on the column values that you use for repetition.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Numeric dataset column and constraints for the dynamic values used to repeat the contents of a section.

" + } + }, + "com.amazonaws.quicksight#BodySectionRepeatConfiguration": { + "type": "structure", + "members": { + "DimensionConfigurations": { + "target": "com.amazonaws.quicksight#BodySectionRepeatDimensionConfigurationList", + "traits": { + "smithy.api#documentation": "

List of BodySectionRepeatDimensionConfiguration values that describe the dataset column and constraints for the column used to repeat the contents of a section.

" + } + }, + "PageBreakConfiguration": { + "target": "com.amazonaws.quicksight#BodySectionRepeatPageBreakConfiguration", + "traits": { + "smithy.api#documentation": "

Page break configuration to apply for each repeating instance.

" + } + }, + "NonRepeatingVisuals": { + "target": "com.amazonaws.quicksight#NonRepeatingVisualsList", + "traits": { + "smithy.api#documentation": "

List of visuals to exclude from repetition in repeating sections. The visuals will render identically, and ignore the repeating configurations in all repeating instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the configurations that are required to declare a section as repeating.

" + } + }, + "com.amazonaws.quicksight#BodySectionRepeatDimensionConfiguration": { + "type": "structure", + "members": { + "DynamicCategoryDimensionConfiguration": { + "target": "com.amazonaws.quicksight#BodySectionDynamicCategoryDimensionConfiguration", + "traits": { + "smithy.api#documentation": "

Describes the Category dataset column and constraints around the dynamic values that will be used in repeating the section contents.

" + } + }, + "DynamicNumericDimensionConfiguration": { + "target": "com.amazonaws.quicksight#BodySectionDynamicNumericDimensionConfiguration", + "traits": { + "smithy.api#documentation": "

Describes the Numeric dataset column and constraints around the dynamic values used to repeat the contents of a section.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the dataset column and constraints for the dynamic values used to repeat the contents of a section. The dataset column is either Category or Numeric column configuration

" + } + }, + "com.amazonaws.quicksight#BodySectionRepeatDimensionConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#BodySectionRepeatDimensionConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.quicksight#BodySectionRepeatPageBreakConfiguration": { + "type": "structure", + "members": { + "After": { + "target": "com.amazonaws.quicksight#SectionAfterPageBreak" + } + }, + "traits": { + "smithy.api#documentation": "

The page break configuration to apply for each repeating instance.

" + } + }, + "com.amazonaws.quicksight#BookmarksConfigurations": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that determines whether a user\n can bookmark an embedded dashboard.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The bookmarks configuration of an embedded dashboard.

" + } + }, + "com.amazonaws.quicksight#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.quicksight#BooleanObject": { + "type": "boolean" + }, + "com.amazonaws.quicksight#BorderStyle": { + "type": "structure", + "members": { + "Show": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The option to enable display of borders for visuals.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options for tile borders for visuals.

" + } + }, + "com.amazonaws.quicksight#BoxPlotAggregatedFieldWells": { + "type": "structure", + "members": { + "GroupBy": { + "target": "com.amazonaws.quicksight#BoxPlotDimensionFieldList", + "traits": { + "smithy.api#documentation": "

The group by field well of a box plot chart. Values are grouped based on group by fields.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#BoxPlotMeasureFieldList", + "traits": { + "smithy.api#documentation": "

The value field well of a box plot chart. Values are aggregated based on group by fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The aggregated field well for a box plot.

" + } + }, + "com.amazonaws.quicksight#BoxPlotChartConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#BoxPlotFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#BoxPlotSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a BoxPlotVisual.

" + } + }, + "BoxPlotOptions": { + "target": "com.amazonaws.quicksight#BoxPlotOptions", + "traits": { + "smithy.api#documentation": "

The box plot chart options for a box plot visual

" + } + }, + "CategoryAxis": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The label display options (grid line, range, scale, axis step) of a box plot category.

" + } + }, + "CategoryLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility and sort Icon visibility) of a box plot category.

" + } + }, + "PrimaryYAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The label display options (grid line, range, scale, axis step) of a box plot category.

" + } + }, + "PrimaryYAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility and sort icon visibility) of a box plot value.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions" + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The tooltip display setup of the visual.

" + } + }, + "ReferenceLines": { + "target": "com.amazonaws.quicksight#ReferenceLineList", + "traits": { + "smithy.api#documentation": "

The reference line setup of the visual.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a BoxPlotVisual.

" + } + }, + "com.amazonaws.quicksight#BoxPlotDimensionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#BoxPlotFieldWells": { + "type": "structure", + "members": { + "BoxPlotAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#BoxPlotAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a box plot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field wells of a BoxPlotVisual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#BoxPlotFillStyle": { + "type": "enum", + "members": { + "SOLID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOLID" + } + }, + "TRANSPARENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSPARENT" + } + } + } + }, + "com.amazonaws.quicksight#BoxPlotMeasureFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MeasureField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.quicksight#BoxPlotOptions": { + "type": "structure", + "members": { + "StyleOptions": { + "target": "com.amazonaws.quicksight#BoxPlotStyleOptions", + "traits": { + "smithy.api#documentation": "

The style options of the box plot.

" + } + }, + "OutlierVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines the visibility of the outlier in a box plot.

" + } + }, + "AllDataPointsVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines the visibility of all data points of the box plot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options of a box plot visual.

" + } + }, + "com.amazonaws.quicksight#BoxPlotSortConfiguration": { + "type": "structure", + "members": { + "CategorySort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of a group by fields.

" + } + }, + "PaginationConfiguration": { + "target": "com.amazonaws.quicksight#PaginationConfiguration", + "traits": { + "smithy.api#documentation": "

The pagination configuration of a table visual or box plot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a BoxPlotVisual.

" + } + }, + "com.amazonaws.quicksight#BoxPlotStyleOptions": { + "type": "structure", + "members": { + "FillStyle": { + "target": "com.amazonaws.quicksight#BoxPlotFillStyle", + "traits": { + "smithy.api#documentation": "

The fill styles (solid, transparent) of the box plot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The style options of the box plot.

" + } + }, + "com.amazonaws.quicksight#BoxPlotVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#BoxPlotChartConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A box plot.

\n

For more information, see Using box plots in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#CIDR": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(3[0-2]|[1-2][0-9]|[1-9]))$" + } + }, + "com.amazonaws.quicksight#CalculatedColumn": { + "type": "structure", + "members": { + "ColumnName": { + "target": "com.amazonaws.quicksight#ColumnName", + "traits": { + "smithy.api#documentation": "

Column name.

", + "smithy.api#required": {} + } + }, + "ColumnId": { + "target": "com.amazonaws.quicksight#ColumnId", + "traits": { + "smithy.api#documentation": "

A unique ID to identify a calculated column. During a dataset update, if the column ID\n of a calculated column matches that of an existing calculated column, Amazon QuickSight\n preserves the existing calculated column.

", + "smithy.api#required": {} + } + }, + "Expression": { + "target": "com.amazonaws.quicksight#Expression", + "traits": { + "smithy.api#documentation": "

An expression that defines the calculated column.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A calculated column for a dataset.

" + } + }, + "com.amazonaws.quicksight#CalculatedColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#CalculatedColumn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.quicksight#CalculatedField": { + "type": "structure", + "members": { + "DataSetIdentifier": { + "target": "com.amazonaws.quicksight#DataSetIdentifier", + "traits": { + "smithy.api#documentation": "

The data set that is used in this calculated field.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ColumnName", + "traits": { + "smithy.api#documentation": "

The name of the calculated field.

", + "smithy.api#required": {} + } + }, + "Expression": { + "target": "com.amazonaws.quicksight#CalculatedFieldExpression", + "traits": { + "smithy.api#documentation": "

The expression of the calculated field.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The calculated field of an analysis.

" + } + }, + "com.amazonaws.quicksight#CalculatedFieldExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#CalculatedFieldReferenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Identifier" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 250 + } + } + }, + "com.amazonaws.quicksight#CalculatedFields": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#CalculatedField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.quicksight#CalculatedMeasureField": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The custom field ID.

", + "smithy.api#required": {} + } + }, + "Expression": { + "target": "com.amazonaws.quicksight#Expression", + "traits": { + "smithy.api#documentation": "

The expression in the table calculation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The table calculation measure field for pivot tables.

" + } + }, + "com.amazonaws.quicksight#CancelIngestion": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CancelIngestionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CancelIngestionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels an ongoing ingestion of data into SPICE.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CancelIngestionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the dataset used in the ingestion.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IngestionId": { + "target": "com.amazonaws.quicksight#IngestionId", + "traits": { + "smithy.api#documentation": "

An ID for the ingestion.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CancelIngestionResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the data ingestion.

" + } + }, + "IngestionId": { + "target": "com.amazonaws.quicksight#IngestionId", + "traits": { + "smithy.api#documentation": "

An ID for the ingestion.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CascadingControlConfiguration": { + "type": "structure", + "members": { + "SourceControls": { + "target": "com.amazonaws.quicksight#CascadingControlSourceList", + "traits": { + "smithy.api#documentation": "

A list of source controls that determine the values that are used in the current control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

" + } + }, + "com.amazonaws.quicksight#CascadingControlSource": { + "type": "structure", + "members": { + "SourceSheetControlId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The source sheet control ID of a CascadingControlSource.

" + } + }, + "ColumnToMatch": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column identifier that determines which column to look up for the source sheet control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The source controls that are used in a CascadingControlConfiguration.

" + } + }, + "com.amazonaws.quicksight#CascadingControlSourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#CascadingControlSource" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#CastColumnTypeOperation": { + "type": "structure", + "members": { + "ColumnName": { + "target": "com.amazonaws.quicksight#ColumnName", + "traits": { + "smithy.api#documentation": "

Column name.

", + "smithy.api#required": {} + } + }, + "NewColumnType": { + "target": "com.amazonaws.quicksight#ColumnDataType", + "traits": { + "smithy.api#documentation": "

New column data type.

", + "smithy.api#required": {} + } + }, + "SubType": { + "target": "com.amazonaws.quicksight#ColumnDataSubType", + "traits": { + "smithy.api#documentation": "

The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.

" + } + }, + "Format": { + "target": "com.amazonaws.quicksight#TypeCastFormat", + "traits": { + "smithy.api#documentation": "

When casting a column from string to datetime type, you can supply a string in a\n format supported by Amazon QuickSight to denote the source data format.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A transform operation that casts a column to a different type.

" + } + }, + "com.amazonaws.quicksight#Catalog": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.quicksight#CategoricalAggregationFunction": { + "type": "enum", + "members": { + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "DISTINCT_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTINCT_COUNT" + } + } + } + }, + "com.amazonaws.quicksight#CategoricalDimensionField": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The custom field ID.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that is used in the CategoricalDimensionField.

", + "smithy.api#required": {} + } + }, + "HierarchyId": { + "target": "com.amazonaws.quicksight#HierarchyId", + "traits": { + "smithy.api#documentation": "

The custom hierarchy ID.

" + } + }, + "FormatConfiguration": { + "target": "com.amazonaws.quicksight#StringFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The format configuration of the field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The dimension type field with categorical type columns..

" + } + }, + "com.amazonaws.quicksight#CategoricalMeasureField": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The custom field ID.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that is used in the CategoricalMeasureField.

", + "smithy.api#required": {} + } + }, + "AggregationFunction": { + "target": "com.amazonaws.quicksight#CategoricalAggregationFunction", + "traits": { + "smithy.api#documentation": "

The aggregation function of the measure field.

" + } + }, + "FormatConfiguration": { + "target": "com.amazonaws.quicksight#StringFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The format configuration of the field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The measure type field with categorical type columns.

" + } + }, + "com.amazonaws.quicksight#CategoryDrillDownFilter": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "CategoryValues": { + "target": "com.amazonaws.quicksight#CategoryValueList", + "traits": { + "smithy.api#documentation": "

A list of the string inputs that are the values of the category drill down filter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The category drill down filter.

" + } + }, + "com.amazonaws.quicksight#CategoryFilter": { + "type": "structure", + "members": { + "FilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "Configuration": { + "target": "com.amazonaws.quicksight#CategoryFilterConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for a CategoryFilter.

", + "smithy.api#required": {} + } + }, + "DefaultFilterControlConfiguration": { + "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", + "traits": { + "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A CategoryFilter filters text values.

\n

For more information, see Adding text filters in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#CategoryFilterConfiguration": { + "type": "structure", + "members": { + "FilterListConfiguration": { + "target": "com.amazonaws.quicksight#FilterListConfiguration", + "traits": { + "smithy.api#documentation": "

A list of filter configurations. In the Amazon QuickSight console, this filter type is called a filter list.

" + } + }, + "CustomFilterListConfiguration": { + "target": "com.amazonaws.quicksight#CustomFilterListConfiguration", + "traits": { + "smithy.api#documentation": "

A list of custom filter values. In the Amazon QuickSight console, this filter type is called a custom filter list.

" + } + }, + "CustomFilterConfiguration": { + "target": "com.amazonaws.quicksight#CustomFilterConfiguration", + "traits": { + "smithy.api#documentation": "

A custom filter that filters based on a single value. This filter can be partially matched.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a CategoryFilter.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#CategoryFilterFunction": { + "type": "enum", + "members": { + "EXACT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXACT" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS" + } + } + } + }, + "com.amazonaws.quicksight#CategoryFilterMatchOperator": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + }, + "DOES_NOT_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOES_NOT_EQUAL" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS" + } + }, + "DOES_NOT_CONTAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOES_NOT_CONTAIN" + } + }, + "STARTS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTS_WITH" + } + }, + "ENDS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENDS_WITH" + } + } + } + }, + "com.amazonaws.quicksight#CategoryFilterSelectAllOptions": { + "type": "enum", + "members": { + "FILTER_ALL_VALUES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILTER_ALL_VALUES" + } + } + } + }, + "com.amazonaws.quicksight#CategoryFilterType": { + "type": "enum", + "members": { + "CUSTOM_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_FILTER" + } + }, + "CUSTOM_FILTER_LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_FILTER_LIST" + } + }, + "FILTER_LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILTER_LIST" + } + } + } + }, + "com.amazonaws.quicksight#CategoryInnerFilter": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#required": {} + } + }, + "Configuration": { + "target": "com.amazonaws.quicksight#CategoryFilterConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "DefaultFilterControlConfiguration": { + "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "

A CategoryInnerFilter filters text values for the NestedFilter.

" + } + }, + "com.amazonaws.quicksight#CategoryValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "com.amazonaws.quicksight#CategoryValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#CategoryValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100000 + } + } + }, + "com.amazonaws.quicksight#CellValueSynonym": { + "type": "structure", + "members": { + "CellValue": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The cell value.

" + } + }, + "Synonyms": { + "target": "com.amazonaws.quicksight#StringList", + "traits": { + "smithy.api#documentation": "

Other names or aliases for the cell value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents the cell value synonym.

" + } + }, + "com.amazonaws.quicksight#CellValueSynonyms": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#CellValueSynonym" + } + }, + "com.amazonaws.quicksight#ChartAxisLabelOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of an axis label on a chart. Choose one of the following options:

\n " + } + }, + "SortIconVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility configuration of the sort icon on a chart's axis label.

" + } + }, + "AxisLabelOptions": { + "target": "com.amazonaws.quicksight#AxisLabelOptionsList", + "traits": { + "smithy.api#documentation": "

The label options for a chart axis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The label options for an axis on a chart.

" + } + }, + "com.amazonaws.quicksight#ClusterId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#ClusterMarker": { + "type": "structure", + "members": { + "SimpleClusterMarker": { + "target": "com.amazonaws.quicksight#SimpleClusterMarker", + "traits": { + "smithy.api#documentation": "

The simple cluster marker of the cluster marker.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The cluster marker that is a part of the cluster marker\n configuration.

" + } + }, + "com.amazonaws.quicksight#ClusterMarkerConfiguration": { + "type": "structure", + "members": { + "ClusterMarker": { + "target": "com.amazonaws.quicksight#ClusterMarker", + "traits": { + "smithy.api#documentation": "

The cluster marker that is a part of the cluster marker configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The cluster marker configuration of the geospatial map selected point style.

" + } + }, + "com.amazonaws.quicksight#CollectiveConstant": { + "type": "structure", + "members": { + "ValueList": { + "target": "com.amazonaws.quicksight#StringList", + "traits": { + "smithy.api#documentation": "

A list of values for the collective constant.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a collective constant.

" + } + }, + "com.amazonaws.quicksight#CollectiveConstantEntry": { + "type": "structure", + "members": { + "ConstantType": { + "target": "com.amazonaws.quicksight#ConstantType", + "traits": { + "smithy.api#documentation": "

The ConstantType of a CollectiveConstantEntry.

" + } + }, + "Value": { + "target": "com.amazonaws.quicksight#ConstantValueString", + "traits": { + "smithy.api#documentation": "

The value of a CollectiveConstantEntry.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a CollectiveConstantEntry.

" + } + }, + "com.amazonaws.quicksight#CollectiveConstantEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#CollectiveConstantEntry" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.quicksight#ColorFillType": { + "type": "enum", + "members": { + "DISCRETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISCRETE" + } + }, + "GRADIENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GRADIENT" + } + } + } + }, + "com.amazonaws.quicksight#ColorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#HexColor" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#ColorScale": { + "type": "structure", + "members": { + "Colors": { + "target": "com.amazonaws.quicksight#ColorScaleColorList", + "traits": { + "smithy.api#documentation": "

Determines the list of colors that are applied to the visual.

", + "smithy.api#required": {} + } + }, + "ColorFillType": { + "target": "com.amazonaws.quicksight#ColorFillType", + "traits": { + "smithy.api#documentation": "

Determines the color fill type.

", + "smithy.api#required": {} + } + }, + "NullValueColor": { + "target": "com.amazonaws.quicksight#DataColor", + "traits": { + "smithy.api#documentation": "

Determines the color that is applied to null values.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the color scale that is applied to the visual.

" + } + }, + "com.amazonaws.quicksight#ColorScaleColorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataColor" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 3 + } + } + }, + "com.amazonaws.quicksight#ColorsConfiguration": { + "type": "structure", + "members": { + "CustomColors": { + "target": "com.amazonaws.quicksight#CustomColorsList", + "traits": { + "smithy.api#documentation": "

A list of up to 50 custom colors.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The color configurations for a column.

" + } + }, + "com.amazonaws.quicksight#ColumnConfiguration": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column.

", + "smithy.api#required": {} + } + }, + "FormatConfiguration": { + "target": "com.amazonaws.quicksight#FormatConfiguration", + "traits": { + "smithy.api#documentation": "

The format configuration of a column.

" + } + }, + "Role": { + "target": "com.amazonaws.quicksight#ColumnRole", + "traits": { + "smithy.api#documentation": "

The role of the column.

" + } + }, + "ColorsConfiguration": { + "target": "com.amazonaws.quicksight#ColorsConfiguration", + "traits": { + "smithy.api#documentation": "

The color configurations of the column.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The general configuration of a column.

" + } + }, + "com.amazonaws.quicksight#ColumnConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.quicksight#ColumnDataRole": { + "type": "enum", + "members": { + "DIMENSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIMENSION" + } + }, + "MEASURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEASURE" + } + } + } + }, + "com.amazonaws.quicksight#ColumnDataSubType": { + "type": "enum", + "members": { + "FLOAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLOAT" + } + }, + "FIXED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIXED" + } + } + } + }, + "com.amazonaws.quicksight#ColumnDataType": { + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + }, + "INTEGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTEGER" + } + }, + "DECIMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DECIMAL" + } + }, + "DATETIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATETIME" + } + } + } + }, + "com.amazonaws.quicksight#ColumnDescription": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.quicksight#ColumnDescriptiveText", + "traits": { + "smithy.api#documentation": "

The text of a description for a column.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata that contains a description for a column.

" + } + }, + "com.amazonaws.quicksight#ColumnDescriptiveText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.quicksight#ColumnGroup": { + "type": "structure", + "members": { + "GeoSpatialColumnGroup": { + "target": "com.amazonaws.quicksight#GeoSpatialColumnGroup", + "traits": { + "smithy.api#documentation": "

Geospatial column group that denotes a hierarchy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Groupings of columns that work together in certain Amazon QuickSight features. This is\n a variant type structure. For this structure to be valid, only one of the attributes can\n be non-null.

" + } + }, + "com.amazonaws.quicksight#ColumnGroupColumnSchema": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of the column group's column schema.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure describing the name, data type, and geographic role of the columns.

" + } + }, + "com.amazonaws.quicksight#ColumnGroupColumnSchemaList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnGroupColumnSchema" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.quicksight#ColumnGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnGroup" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8 + } + } + }, + "com.amazonaws.quicksight#ColumnGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#ColumnGroupSchema": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of the column group schema.

" + } + }, + "ColumnGroupColumnSchemaList": { + "target": "com.amazonaws.quicksight#ColumnGroupColumnSchemaList", + "traits": { + "smithy.api#documentation": "

A structure containing the list of schemas for column group columns.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The column group schema.

" + } + }, + "com.amazonaws.quicksight#ColumnGroupSchemaList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnGroupSchema" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.quicksight#ColumnHierarchy": { + "type": "structure", + "members": { + "ExplicitHierarchy": { + "target": "com.amazonaws.quicksight#ExplicitHierarchy", + "traits": { + "smithy.api#documentation": "

The option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.

" + } + }, + "DateTimeHierarchy": { + "target": "com.amazonaws.quicksight#DateTimeHierarchy", + "traits": { + "smithy.api#documentation": "

The option that determines the hierarchy of any DateTime fields.

" + } + }, + "PredefinedHierarchy": { + "target": "com.amazonaws.quicksight#PredefinedHierarchy", + "traits": { + "smithy.api#documentation": "

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The option that determines the hierarchy of the fields for a visual element.

" + } + }, + "com.amazonaws.quicksight#ColumnHierarchyList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnHierarchy" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.quicksight#ColumnId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#ColumnIdentifier": { + "type": "structure", + "members": { + "DataSetIdentifier": { + "target": "com.amazonaws.quicksight#DataSetIdentifier", + "traits": { + "smithy.api#documentation": "

The data set that the column belongs to.

", + "smithy.api#required": {} + } + }, + "ColumnName": { + "target": "com.amazonaws.quicksight#ColumnName", + "traits": { + "smithy.api#documentation": "

The name of the column.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A column of a data set.

" + } + }, + "com.amazonaws.quicksight#ColumnLevelPermissionRule": { + "type": "structure", + "members": { + "Principals": { + "target": "com.amazonaws.quicksight#PrincipalList", + "traits": { + "smithy.api#documentation": "

An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.

" + } + }, + "ColumnNames": { + "target": "com.amazonaws.quicksight#ColumnNameList", + "traits": { + "smithy.api#documentation": "

An array of column names.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule defined to grant access on one or more restricted columns.\n Each dataset can have multiple rules.\n To create a restricted column, you add it to one or more rules.\n Each rule must contain at least one column and at least one user or group.\n To be able to see a restricted column, a user or group needs to be added\n to a rule for that column.

" + } + }, + "com.amazonaws.quicksight#ColumnLevelPermissionRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnLevelPermissionRule" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.quicksight#ColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.quicksight#ColumnName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.quicksight#ColumnNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#String" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.quicksight#ColumnOrderingType": { + "type": "enum", + "members": { + "GREATER_IS_BETTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER_IS_BETTER" + } + }, + "LESSER_IS_BETTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LESSER_IS_BETTER" + } + }, + "SPECIFIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPECIFIED" + } + } + } + }, + "com.amazonaws.quicksight#ColumnRole": { + "type": "enum", + "members": { + "DIMENSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIMENSION" + } + }, + "MEASURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEASURE" + } + } + } + }, + "com.amazonaws.quicksight#ColumnSchema": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of the column schema.

" + } + }, + "DataType": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The data type of the column schema.

" + } + }, + "GeographicRole": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The geographic role of the column schema.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The column schema.

" + } + }, + "com.amazonaws.quicksight#ColumnSchemaList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnSchema" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.quicksight#ColumnSort": { + "type": "structure", + "members": { + "SortBy": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#required": {} + } + }, + "Direction": { + "target": "com.amazonaws.quicksight#SortDirection", + "traits": { + "smithy.api#documentation": "

The sort direction.

", + "smithy.api#required": {} + } + }, + "AggregationFunction": { + "target": "com.amazonaws.quicksight#AggregationFunction", + "traits": { + "smithy.api#documentation": "

The aggregation function that is defined in the column sort.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration for a column that is not used in a field well.

" + } + }, + "com.amazonaws.quicksight#ColumnTag": { + "type": "structure", + "members": { + "ColumnGeographicRole": { + "target": "com.amazonaws.quicksight#GeoSpatialDataRole", + "traits": { + "smithy.api#documentation": "

A geospatial role for a column.

" + } + }, + "ColumnDescription": { + "target": "com.amazonaws.quicksight#ColumnDescription", + "traits": { + "smithy.api#documentation": "

A description for a column.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A tag for a column in a\n \n TagColumnOperation\n \n structure. This is a\n variant type structure. For this structure to be valid, only one of the attributes can\n be non-null.

" + } + }, + "com.amazonaws.quicksight#ColumnTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnTag" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.quicksight#ColumnTagName": { + "type": "enum", + "members": { + "COLUMN_GEOGRAPHIC_ROLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLUMN_GEOGRAPHIC_ROLE" + } + }, + "COLUMN_DESCRIPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLUMN_DESCRIPTION" + } + } + } + }, + "com.amazonaws.quicksight#ColumnTagNames": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnTagName" + } + }, + "com.amazonaws.quicksight#ColumnTooltipItem": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The target column of the tooltip item.

", + "smithy.api#required": {} + } + }, + "Label": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The label of the tooltip item.

" + } + }, + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the tooltip item.

" + } + }, + "Aggregation": { + "target": "com.amazonaws.quicksight#AggregationFunction", + "traits": { + "smithy.api#documentation": "

The aggregation function of the column tooltip item.

" + } + }, + "TooltipTarget": { + "target": "com.amazonaws.quicksight#TooltipTarget", + "traits": { + "smithy.api#documentation": "

Determines the target of the column tooltip item in a combo chart visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tooltip item for the columns that are not part of a field well.

" + } + }, + "com.amazonaws.quicksight#ComboChartAggregatedFieldWells": { + "type": "structure", + "members": { + "Category": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The aggregated category field wells of a combo chart.

" + } + }, + "BarValues": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The aggregated BarValues field well of a combo chart.

" + } + }, + "Colors": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The aggregated colors field well of a combo chart.

" + } + }, + "LineValues": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The aggregated LineValues field well of a combo chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a combo chart.

" + } + }, + "com.amazonaws.quicksight#ComboChartConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#ComboChartFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#ComboChartSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a ComboChartVisual.

" + } + }, + "BarsArrangement": { + "target": "com.amazonaws.quicksight#BarsArrangement", + "traits": { + "smithy.api#documentation": "

Determines the bar arrangement in a combo chart. The following are valid values in this structure:

\n " + } + }, + "CategoryAxis": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The category axis of a combo chart.

" + } + }, + "CategoryLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.

" + } + }, + "PrimaryYAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.

" + } + }, + "PrimaryYAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.

" + } + }, + "SecondaryYAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.

" + } + }, + "SecondaryYAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.

" + } + }, + "SingleAxisOptions": { + "target": "com.amazonaws.quicksight#SingleAxisOptions" + }, + "ColorLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "

The legend display setup of the visual.

" + } + }, + "BarDataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

\n

The data label options for a bar in a combo chart.

" + } + }, + "LineDataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

\n

The data label options for a line in a combo chart.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The legend display setup of the visual.

" + } + }, + "ReferenceLines": { + "target": "com.amazonaws.quicksight#ReferenceLineList", + "traits": { + "smithy.api#documentation": "

The reference line setup of the visual.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a ComboChartVisual.

" + } + }, + "com.amazonaws.quicksight#ComboChartFieldWells": { + "type": "structure", + "members": { + "ComboChartAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#ComboChartAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a combo chart. Combo charts only have aggregated field wells. Columns in a combo chart are aggregated by category.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#ComboChartSortConfiguration": { + "type": "structure", + "members": { + "CategorySort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the category field well in a combo chart.

" + } + }, + "CategoryItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The item limit configuration for the category field well of a combo chart.

" + } + }, + "ColorSort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the color field well in a combo chart.

" + } + }, + "ColorItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The item limit configuration of the color field well in a combo chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a ComboChartVisual.

" + } + }, + "com.amazonaws.quicksight#ComboChartVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#ComboChartConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A combo chart.

\n

The ComboChartVisual includes stacked bar combo charts and clustered bar combo charts

\n

For more information, see Using combo charts in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#ComparativeOrder": { + "type": "structure", + "members": { + "UseOrdering": { + "target": "com.amazonaws.quicksight#ColumnOrderingType", + "traits": { + "smithy.api#documentation": "

The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER, LESSER_IS_BETTER and SPECIFIED.

" + } + }, + "SpecifedOrder": { + "target": "com.amazonaws.quicksight#StringList", + "traits": { + "smithy.api#documentation": "

The list of columns to be used in the ordering.

" + } + }, + "TreatUndefinedSpecifiedValues": { + "target": "com.amazonaws.quicksight#UndefinedSpecifiedValueType", + "traits": { + "smithy.api#documentation": "

The treat of undefined specified values. Valid values for this structure are LEAST and MOST.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a comparative order.

" + } + }, + "com.amazonaws.quicksight#ComparisonConfiguration": { + "type": "structure", + "members": { + "ComparisonMethod": { + "target": "com.amazonaws.quicksight#ComparisonMethod", + "traits": { + "smithy.api#documentation": "

The method of the comparison. Choose from the following options:

\n " + } + }, + "ComparisonFormat": { + "target": "com.amazonaws.quicksight#ComparisonFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The format of the comparison.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The comparison display configuration of a KPI or gauge chart.

" + } + }, + "com.amazonaws.quicksight#ComparisonFormatConfiguration": { + "type": "structure", + "members": { + "NumberDisplayFormatConfiguration": { + "target": "com.amazonaws.quicksight#NumberDisplayFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The number display format.

" + } + }, + "PercentageDisplayFormatConfiguration": { + "target": "com.amazonaws.quicksight#PercentageDisplayFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The percentage display format.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The format of the comparison.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#ComparisonMethod": { + "type": "enum", + "members": { + "DIFFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIFFERENCE" + } + }, + "PERCENT_DIFFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENT_DIFFERENCE" + } + }, + "PERCENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENT" + } + } + } + }, + "com.amazonaws.quicksight#ComparisonMethodType": { + "type": "enum", + "members": { + "DIFF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIFF" + } + }, + "PERC_DIFF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERC_DIFF" + } + }, + "DIFF_AS_PERC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIFF_AS_PERC" + } + }, + "POP_CURRENT_DIFF_AS_PERC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POP_CURRENT_DIFF_AS_PERC" + } + }, + "POP_CURRENT_DIFF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POP_CURRENT_DIFF" + } + }, + "POP_OVERTIME_DIFF_AS_PERC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POP_OVERTIME_DIFF_AS_PERC" + } + }, + "POP_OVERTIME_DIFF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POP_OVERTIME_DIFF" + } + }, + "PERCENT_OF_TOTAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENT_OF_TOTAL" + } + }, + "RUNNING_SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING_SUM" + } + }, + "MOVING_AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MOVING_AVERAGE" + } + } + } + }, + "com.amazonaws.quicksight#Computation": { + "type": "structure", + "members": { + "TopBottomRanked": { + "target": "com.amazonaws.quicksight#TopBottomRankedComputation", + "traits": { + "smithy.api#documentation": "

The top ranked and bottom ranked computation configuration.

" + } + }, + "TopBottomMovers": { + "target": "com.amazonaws.quicksight#TopBottomMoversComputation", + "traits": { + "smithy.api#documentation": "

The top movers and bottom movers computation configuration.

" + } + }, + "TotalAggregation": { + "target": "com.amazonaws.quicksight#TotalAggregationComputation", + "traits": { + "smithy.api#documentation": "

The total aggregation computation configuration.

" + } + }, + "MaximumMinimum": { + "target": "com.amazonaws.quicksight#MaximumMinimumComputation", + "traits": { + "smithy.api#documentation": "

The maximum and minimum computation configuration.

" + } + }, + "MetricComparison": { + "target": "com.amazonaws.quicksight#MetricComparisonComputation", + "traits": { + "smithy.api#documentation": "

The metric comparison computation configuration.

" + } + }, + "PeriodOverPeriod": { + "target": "com.amazonaws.quicksight#PeriodOverPeriodComputation", + "traits": { + "smithy.api#documentation": "

The period over period computation configuration.

" + } + }, + "PeriodToDate": { + "target": "com.amazonaws.quicksight#PeriodToDateComputation", + "traits": { + "smithy.api#documentation": "

The period to DataSetIdentifier computation configuration.

" + } + }, + "GrowthRate": { + "target": "com.amazonaws.quicksight#GrowthRateComputation", + "traits": { + "smithy.api#documentation": "

The growth rate computation configuration.

" + } + }, + "UniqueValues": { + "target": "com.amazonaws.quicksight#UniqueValuesComputation", + "traits": { + "smithy.api#documentation": "

The unique values computation configuration.

" + } + }, + "Forecast": { + "target": "com.amazonaws.quicksight#ForecastComputation", + "traits": { + "smithy.api#documentation": "

The forecast computation configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The computation union that is used in an insight visual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#ComputationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Computation" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#ConcurrentUpdatingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String" + } + }, + "traits": { + "smithy.api#documentation": "

A resource is already in a state that indicates an operation is happening that must complete\n\t\t\tbefore a new update can be applied.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.quicksight#ConditionalFormattingColor": { + "type": "structure", + "members": { + "Solid": { + "target": "com.amazonaws.quicksight#ConditionalFormattingSolidColor", + "traits": { + "smithy.api#documentation": "

Formatting configuration for solid color.

" + } + }, + "Gradient": { + "target": "com.amazonaws.quicksight#ConditionalFormattingGradientColor", + "traits": { + "smithy.api#documentation": "

Formatting configuration for gradient color.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The formatting configuration for the color.

" + } + }, + "com.amazonaws.quicksight#ConditionalFormattingCustomIconCondition": { + "type": "structure", + "members": { + "Expression": { + "target": "com.amazonaws.quicksight#Expression", + "traits": { + "smithy.api#documentation": "

The expression that determines the condition of the icon set.

", + "smithy.api#required": {} + } + }, + "IconOptions": { + "target": "com.amazonaws.quicksight#ConditionalFormattingCustomIconOptions", + "traits": { + "smithy.api#documentation": "

Custom icon options for an icon set.

", + "smithy.api#required": {} + } + }, + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

Determines the color of the icon.

" + } + }, + "DisplayConfiguration": { + "target": "com.amazonaws.quicksight#ConditionalFormattingIconDisplayConfiguration", + "traits": { + "smithy.api#documentation": "

Determines the icon display configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the custom condition for an icon set.

" + } + }, + "com.amazonaws.quicksight#ConditionalFormattingCustomIconOptions": { + "type": "structure", + "members": { + "Icon": { + "target": "com.amazonaws.quicksight#Icon", + "traits": { + "smithy.api#documentation": "

Determines the type of icon.

" + } + }, + "UnicodeIcon": { + "target": "com.amazonaws.quicksight#UnicodeIcon", + "traits": { + "smithy.api#documentation": "

Determines the Unicode icon type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Custom icon options for an icon set.

" + } + }, + "com.amazonaws.quicksight#ConditionalFormattingGradientColor": { + "type": "structure", + "members": { + "Expression": { + "target": "com.amazonaws.quicksight#Expression", + "traits": { + "smithy.api#documentation": "

The expression that determines the formatting configuration for gradient color.

", + "smithy.api#required": {} + } + }, + "Color": { + "target": "com.amazonaws.quicksight#GradientColor", + "traits": { + "smithy.api#documentation": "

Determines the color.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Formatting configuration for gradient color.

" + } + }, + "com.amazonaws.quicksight#ConditionalFormattingIcon": { + "type": "structure", + "members": { + "IconSet": { + "target": "com.amazonaws.quicksight#ConditionalFormattingIconSet", + "traits": { + "smithy.api#documentation": "

Formatting configuration for icon set.

" + } + }, + "CustomCondition": { + "target": "com.amazonaws.quicksight#ConditionalFormattingCustomIconCondition", + "traits": { + "smithy.api#documentation": "

Determines the custom condition for an icon set.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The formatting configuration for the icon.

" + } + }, + "com.amazonaws.quicksight#ConditionalFormattingIconDisplayConfiguration": { + "type": "structure", + "members": { + "IconDisplayOption": { + "target": "com.amazonaws.quicksight#ConditionalFormattingIconDisplayOption", + "traits": { + "smithy.api#documentation": "

Determines the icon display configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the icon display configuration.

" + } + }, + "com.amazonaws.quicksight#ConditionalFormattingIconDisplayOption": { + "type": "enum", + "members": { + "ICON_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ICON_ONLY" + } + } + } + }, + "com.amazonaws.quicksight#ConditionalFormattingIconSet": { + "type": "structure", + "members": { + "Expression": { + "target": "com.amazonaws.quicksight#Expression", + "traits": { + "smithy.api#documentation": "

The expression that determines the formatting configuration for the icon set.

", + "smithy.api#required": {} + } + }, + "IconSetType": { + "target": "com.amazonaws.quicksight#ConditionalFormattingIconSetType", + "traits": { + "smithy.api#documentation": "

Determines the icon set type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Formatting configuration for icon set.

" + } + }, + "com.amazonaws.quicksight#ConditionalFormattingIconSetType": { + "type": "enum", + "members": { + "PLUS_MINUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLUS_MINUS" + } + }, + "CHECK_X": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHECK_X" + } + }, + "THREE_COLOR_ARROW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THREE_COLOR_ARROW" + } + }, + "THREE_GRAY_ARROW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THREE_GRAY_ARROW" + } + }, + "CARET_UP_MINUS_DOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CARET_UP_MINUS_DOWN" + } + }, + "THREE_SHAPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THREE_SHAPE" + } + }, + "THREE_CIRCLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THREE_CIRCLE" + } + }, + "FLAGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLAGS" + } + }, + "BARS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BARS" + } + }, + "FOUR_COLOR_ARROW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FOUR_COLOR_ARROW" + } + }, + "FOUR_GRAY_ARROW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FOUR_GRAY_ARROW" + } + } + } + }, + "com.amazonaws.quicksight#ConditionalFormattingSolidColor": { + "type": "structure", + "members": { + "Expression": { + "target": "com.amazonaws.quicksight#Expression", + "traits": { + "smithy.api#documentation": "

The expression that determines the formatting configuration for solid color.

", + "smithy.api#required": {} + } + }, + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

Determines the color.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Formatting configuration for solid color.

" + } + }, + "com.amazonaws.quicksight#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Updating or deleting a resource can cause an inconsistent state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.quicksight#ConstantType": { + "type": "enum", + "members": { + "SINGULAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGULAR" + } + }, + "RANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RANGE" + } + }, + "COLLECTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLLECTIVE" + } + } + } + }, + "com.amazonaws.quicksight#ConstantValueString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.quicksight#ContextMenuOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

The availability status of the context menu options. If the value of this property is set to ENABLED, dashboard readers can interact with the context menu.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The context menu options for a visual's interactions.

" + } + }, + "com.amazonaws.quicksight#ContributionAnalysisDefault": { + "type": "structure", + "members": { + "MeasureFieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The measure field that is used in the contribution analysis.

", + "smithy.api#required": {} + } + }, + "ContributorDimensions": { + "target": "com.amazonaws.quicksight#ContributorDimensionList", + "traits": { + "smithy.api#documentation": "

The dimensions columns that are used in the contribution analysis,\n usually a list of ColumnIdentifiers.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The contribution analysis visual display for a line, pie, or bar chart.

" + } + }, + "com.amazonaws.quicksight#ContributionAnalysisDefaultList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ContributionAnalysisDefault" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#ContributionAnalysisDirection": { + "type": "enum", + "members": { + "INCREASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCREASE" + } + }, + "DECREASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DECREASE" + } + }, + "NEUTRAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEUTRAL" + } + } + } + }, + "com.amazonaws.quicksight#ContributionAnalysisFactor": { + "type": "structure", + "members": { + "FieldName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The field name of the ContributionAnalysisFactor.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for the ContributionAnalysisFactor.

" + } + }, + "com.amazonaws.quicksight#ContributionAnalysisFactorsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ContributionAnalysisFactor" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#ContributionAnalysisSortType": { + "type": "enum", + "members": { + "ABSOLUTE_DIFFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABSOLUTE_DIFFERENCE" + } + }, + "CONTRIBUTION_PERCENTAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTRIBUTION_PERCENTAGE" + } + }, + "DEVIATION_FROM_EXPECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEVIATION_FROM_EXPECTED" + } + }, + "PERCENTAGE_DIFFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENTAGE_DIFFERENCE" + } + } + } + }, + "com.amazonaws.quicksight#ContributionAnalysisTimeRanges": { + "type": "structure", + "members": { + "StartRange": { + "target": "com.amazonaws.quicksight#TopicIRFilterOption", + "traits": { + "smithy.api#documentation": "

The start range for the ContributionAnalysisTimeRanges.

" + } + }, + "EndRange": { + "target": "com.amazonaws.quicksight#TopicIRFilterOption", + "traits": { + "smithy.api#documentation": "

The end range for the ContributionAnalysisTimeRanges.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for the ContributionAnalysisTimeRanges.

" + } + }, + "com.amazonaws.quicksight#ContributorDimensionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4 + } + } + }, + "com.amazonaws.quicksight#CopySourceArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:[-a-z0-9]*:quicksight:[-a-z0-9]*:[0-9]{12}:datasource/.+$" + } + }, + "com.amazonaws.quicksight#CreateAccountCustomization": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateAccountCustomizationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateAccountCustomizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the\n CreateAccountCustomization or UpdateAccountCustomization\n API operation. To further customize Amazon QuickSight by removing Amazon QuickSight\n sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide.\n

\n

You can create customizations for your Amazon Web Services account or, if you specify a namespace, for\n a QuickSight namespace instead. Customizations that apply to a namespace always override\n customizations that apply to an Amazon Web Services account. To find out which customizations apply, use\n the DescribeAccountCustomization API operation.

\n

Before you use the CreateAccountCustomization API operation to add a theme\n as the namespace default, make sure that you first share the theme with the namespace.\n If you don't share it with the namespace, the theme isn't visible to your users\n even if you make it the default theme.\n To check if the theme is shared, view the current permissions by using the\n \n DescribeThemePermissions\n \n API operation.\n To share the theme, grant permissions by using the\n \n UpdateThemePermissions\n \n API operation.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/customizations", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateAccountCustomizationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight namespace that you want to add customizations to.

", + "smithy.api#httpQuery": "namespace" + } + }, + "AccountCustomization": { + "target": "com.amazonaws.quicksight#AccountCustomization", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add\n these to an Amazon Web Services account and a QuickSight namespace.

\n

For example, you can add a default theme by setting AccountCustomization\n to the midnight theme: \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }. Or, you can add a custom theme by\n specifying \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\"\n }.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

A list of the tags that you want to attach to this resource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateAccountCustomizationResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.

" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace associated with the customization you're creating.

" + } + }, + "AccountCustomization": { + "target": "com.amazonaws.quicksight#AccountCustomization", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateAccountSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateAccountSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateAccountSubscriptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.

\n

The Amazon Web Services Region for the account is derived from what is configured in the\n CLI or SDK.

\n

Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign\n up for Amazon Web Services in the Amazon QuickSight User\n Guide. The person who signs up for Amazon QuickSight needs to have the\n correct Identity and Access Management (IAM) permissions. For more information,\n see IAM Policy Examples for Amazon QuickSight in the\n Amazon QuickSight User Guide.

\n

If your IAM policy includes both the Subscribe and\n CreateAccountSubscription actions, make sure that both actions are set\n to Allow. If either action is set to Deny, the\n Deny action prevails and your API call fails.

\n

You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to\n Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the\n Amazon QuickSight User Guide.

\n

You can't set default resource access on the new account from the Amazon QuickSight\n API. Instead, add default resource access from the Amazon QuickSight console. For more\n information about setting default resource access to Amazon Web Services services, see\n Setting default resource\n access to Amazon Web Services services in the Amazon QuickSight\n User Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/account/{AwsAccountId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateAccountSubscriptionRequest": { + "type": "structure", + "members": { + "Edition": { + "target": "com.amazonaws.quicksight#Edition", + "traits": { + "smithy.api#documentation": "

The edition of Amazon QuickSight that you want your account to have. Currently, you can\n choose from ENTERPRISE or\n ENTERPRISE_AND_Q.

\n

If you choose ENTERPRISE_AND_Q, the following parameters are\n required:

\n " + } + }, + "AuthenticationMethod": { + "target": "com.amazonaws.quicksight#AuthenticationMethodOption", + "traits": { + "smithy.api#documentation": "

The method that you want to use to authenticate your Amazon QuickSight account.

\n

If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName\n and an AdminGroup associated with your Active Directory.

\n

If you choose IAM_IDENTITY_CENTER, provide an AdminGroup associated with your IAM Identity Center account.

", + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AccountName": { + "target": "com.amazonaws.quicksight#AccountName", + "traits": { + "smithy.api#documentation": "

The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change\n AccountName value after the Amazon QuickSight account is\n created.

", + "smithy.api#required": {} + } + }, + "NotificationEmail": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.

", + "smithy.api#required": {} + } + }, + "ActiveDirectoryName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

" + } + }, + "Realm": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

" + } + }, + "DirectoryId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the Active Directory that is associated with your Amazon QuickSight account.

" + } + }, + "AdminGroup": { + "target": "com.amazonaws.quicksight#GroupsList", + "traits": { + "smithy.api#documentation": "

The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" + } + }, + "AuthorGroup": { + "target": "com.amazonaws.quicksight#GroupsList", + "traits": { + "smithy.api#documentation": "

The author group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" + } + }, + "ReaderGroup": { + "target": "com.amazonaws.quicksight#GroupsList", + "traits": { + "smithy.api#documentation": "

The reader group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" + } + }, + "AdminProGroup": { + "target": "com.amazonaws.quicksight#GroupsList", + "traits": { + "smithy.api#documentation": "

The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" + } + }, + "AuthorProGroup": { + "target": "com.amazonaws.quicksight#GroupsList", + "traits": { + "smithy.api#documentation": "

The author pro group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" + } + }, + "ReaderProGroup": { + "target": "com.amazonaws.quicksight#GroupsList", + "traits": { + "smithy.api#documentation": "

The reader pro group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" + } + }, + "FirstName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The first name of the author of the Amazon QuickSight account to use for future\n communications. This field is required if ENTERPPRISE_AND_Q is the selected\n edition of the new Amazon QuickSight account.

" + } + }, + "LastName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The last name of the author of the Amazon QuickSight account to use for future\n communications. This field is required if ENTERPPRISE_AND_Q is the selected\n edition of the new Amazon QuickSight account.

" + } + }, + "EmailAddress": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The email address of the author of the Amazon QuickSight account to use for future\n communications. This field is required if ENTERPPRISE_AND_Q is the selected\n edition of the new Amazon QuickSight account.

" + } + }, + "ContactNumber": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A 10-digit phone number for the author of the Amazon QuickSight account to use for\n future communications. This field is required if ENTERPPRISE_AND_Q is the\n selected edition of the new Amazon QuickSight account.

" + } + }, + "IAMIdentityCenterInstanceArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM Identity Center instance.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateAccountSubscriptionResponse": { + "type": "structure", + "members": { + "SignupResponse": { + "target": "com.amazonaws.quicksight#SignupResponse", + "traits": { + "smithy.api#documentation": "

A SignupResponse object that returns information about a newly created Amazon QuickSight account.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateAnalysisResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an AnalysisDefinition.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateAnalysisRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account where you are creating an analysis.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the analysis that you're creating. This ID displays in the URL of the\n analysis.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#AnalysisName", + "traits": { + "smithy.api#documentation": "

A descriptive name for the analysis that you're creating. This name displays for the\n analysis in the Amazon QuickSight console.

", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.quicksight#Parameters", + "traits": { + "smithy.api#documentation": "

The parameter names and override values that you want to use. An analysis can have \n any parameter type, and some parameters might accept multiple values.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A structure that describes the principals and the resource-level permissions on an\n analysis. You can use the Permissions structure to grant permissions by\n providing a list of Identity and Access Management (IAM) action information for each\n principal listed by Amazon Resource Name (ARN).

\n

To specify no permissions, omit Permissions.

" + } + }, + "SourceEntity": { + "target": "com.amazonaws.quicksight#AnalysisSourceEntity", + "traits": { + "smithy.api#documentation": "

A source entity to use for the analysis that you're creating. This metadata structure\n contains details that describe a source template and one or more datasets.

\n

Either a SourceEntity or a Definition must be provided in \n order for the request to be valid.

" + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the theme to apply to the analysis that you're creating. To see the theme\n in the Amazon QuickSight console, make sure that you have access to it.

" + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the\n analysis.

" + } + }, + "Definition": { + "target": "com.amazonaws.quicksight#AnalysisDefinition", + "traits": { + "smithy.api#documentation": "

The definition of an analysis.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

\n

Either a SourceEntity or a Definition must be provided in \n order for the request to be valid.

" + } + }, + "ValidationStrategy": { + "target": "com.amazonaws.quicksight#ValidationStrategy", + "traits": { + "smithy.api#documentation": "

The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

" + } + }, + "FolderArns": { + "target": "com.amazonaws.quicksight#FolderArnList", + "traits": { + "smithy.api#documentation": "

When you create the analysis, Amazon QuickSight adds the analysis to these folders.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateAnalysisResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the analysis.

" + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis.

" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The status of the creation of the analysis.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateColumnsOperation": { + "type": "structure", + "members": { + "Columns": { + "target": "com.amazonaws.quicksight#CalculatedColumnList", + "traits": { + "smithy.api#documentation": "

Calculated columns to create.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A transform operation that creates calculated columns. Columns created in one such\n operation form a lexical closure.

" + } + }, + "com.amazonaws.quicksight#CreateDashboard": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateDashboardRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateDashboardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the \n \n CreateTemplate\n \n API operation.

\n

A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created\n from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can\n create scheduled email reports from them. If you have the correct permissions, you can\n create a dashboard from a template that exists in a different Amazon Web Services account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateDashboardRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account where you want to create the dashboard.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard, also added to the IAM policy.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DashboardName", + "traits": { + "smithy.api#documentation": "

The display name of the dashboard.

", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.quicksight#Parameters", + "traits": { + "smithy.api#documentation": "

The parameters for the creation of the dashboard, which you want to use to override\n the default settings. A dashboard can have any type of parameters, and some parameters\n might accept multiple values.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A structure that contains the permissions of the dashboard. You can use this structure\n for granting permissions by providing a list of IAM action information for each\n principal ARN.

\n

To specify no permissions, omit the permissions list.

" + } + }, + "SourceEntity": { + "target": "com.amazonaws.quicksight#DashboardSourceEntity", + "traits": { + "smithy.api#documentation": "

The entity that you are using as a source when you create the dashboard. In\n SourceEntity, you specify the type of object you're using as source. You\n can only create a dashboard from a template, so you use a SourceTemplate\n entity. If you need to create a dashboard from an analysis, first convert the analysis\n to a template by using the \n CreateTemplate\n \n API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplateARN can contain any Amazon Web Services account and any\n Amazon QuickSight-supported Amazon Web Services Region.

\n

Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.

\n

Either a SourceEntity or a Definition must be provided in \n order for the request to be valid.

" + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the\n dashboard.

" + } + }, + "VersionDescription": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

A description for the first version of the dashboard being created.

" + } + }, + "DashboardPublishOptions": { + "target": "com.amazonaws.quicksight#DashboardPublishOptions", + "traits": { + "smithy.api#documentation": "

Options for publishing the dashboard when you create it:

\n " + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If\n you add a value for this field, it overrides the value that is used in the source\n entity. The theme ARN must exist in the same Amazon Web Services account where you create the\n dashboard.

" + } + }, + "Definition": { + "target": "com.amazonaws.quicksight#DashboardVersionDefinition", + "traits": { + "smithy.api#documentation": "

The definition of a dashboard.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

\n

Either a SourceEntity or a Definition must be provided in \n order for the request to be valid.

" + } + }, + "ValidationStrategy": { + "target": "com.amazonaws.quicksight#ValidationStrategy", + "traits": { + "smithy.api#documentation": "

The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.

" + } + }, + "FolderArns": { + "target": "com.amazonaws.quicksight#FolderArnList", + "traits": { + "smithy.api#documentation": "

When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

" + } + }, + "LinkSharingConfiguration": { + "target": "com.amazonaws.quicksight#LinkSharingConfiguration", + "traits": { + "smithy.api#documentation": "

A structure that contains the permissions of a shareable link to the dashboard.

" + } + }, + "LinkEntities": { + "target": "com.amazonaws.quicksight#LinkEntityArnList", + "traits": { + "smithy.api#documentation": "

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateDashboardResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the dashboard.

" + } + }, + "VersionArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the dashboard, including the version number of the first version that is\n created.

" + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The status of the dashboard creation request.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateDataSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateDataSetRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateDataSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/data-sets", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateDataSetRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

The display name for the dataset.

", + "smithy.api#required": {} + } + }, + "PhysicalTableMap": { + "target": "com.amazonaws.quicksight#PhysicalTableMap", + "traits": { + "smithy.api#documentation": "

Declares the physical tables that are available in the underlying data sources.

", + "smithy.api#required": {} + } + }, + "LogicalTableMap": { + "target": "com.amazonaws.quicksight#LogicalTableMap", + "traits": { + "smithy.api#documentation": "

Configures the combination and transformation of the data from the physical tables.

" + } + }, + "ImportMode": { + "target": "com.amazonaws.quicksight#DataSetImportMode", + "traits": { + "smithy.api#documentation": "

Indicates whether you want to import the data into SPICE.

", + "smithy.api#required": {} + } + }, + "ColumnGroups": { + "target": "com.amazonaws.quicksight#ColumnGroupList", + "traits": { + "smithy.api#documentation": "

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

" + } + }, + "FieldFolders": { + "target": "com.amazonaws.quicksight#FieldFolderMap", + "traits": { + "smithy.api#documentation": "

The folder that contains fields and nested subfolders for your dataset.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions on the dataset.

" + } + }, + "RowLevelPermissionDataSet": { + "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", + "traits": { + "smithy.api#documentation": "

The row-level security configuration for the data that you want to create.

" + } + }, + "RowLevelPermissionTagConfiguration": { + "target": "com.amazonaws.quicksight#RowLevelPermissionTagConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

" + } + }, + "ColumnLevelPermissionRules": { + "target": "com.amazonaws.quicksight#ColumnLevelPermissionRuleList", + "traits": { + "smithy.api#documentation": "

A set of one or more definitions of a \n ColumnLevelPermissionRule\n .

" + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

" + } + }, + "DataSetUsageConfiguration": { + "target": "com.amazonaws.quicksight#DataSetUsageConfiguration" + }, + "DatasetParameters": { + "target": "com.amazonaws.quicksight#DatasetParameterList", + "traits": { + "smithy.api#documentation": "

The parameter declarations of the dataset.

" + } + }, + "FolderArns": { + "target": "com.amazonaws.quicksight#FolderArnList", + "traits": { + "smithy.api#documentation": "

When you create the dataset, Amazon QuickSight adds the dataset to these folders.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateDataSetResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "IngestionArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the ingestion, which is triggered as a result of dataset creation if the import\n\t\t\tmode is SPICE.

" + } + }, + "IngestionId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the ingestion, which is triggered as a result of dataset creation if the import\n\t\t\tmode is SPICE.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#CustomerManagedKeyUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a data source.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/data-sources", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateDataSourceRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

A display name for the data source.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.quicksight#DataSourceType", + "traits": { + "smithy.api#documentation": "

The type of the data source. To return a\n\t\t\tlist of all data sources, use ListDataSources.

\n

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

", + "smithy.api#required": {} + } + }, + "DataSourceParameters": { + "target": "com.amazonaws.quicksight#DataSourceParameters", + "traits": { + "smithy.api#documentation": "

The parameters that Amazon QuickSight uses to connect to your underlying source.

" + } + }, + "Credentials": { + "target": "com.amazonaws.quicksight#DataSourceCredentials", + "traits": { + "smithy.api#documentation": "

The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only\n\t\t\tcredentials based on user name and password are supported.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions on the data source.

" + } + }, + "VpcConnectionProperties": { + "target": "com.amazonaws.quicksight#VpcConnectionProperties", + "traits": { + "smithy.api#documentation": "

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to\n\t\t\tyour underlying source.

" + } + }, + "SslProperties": { + "target": "com.amazonaws.quicksight#SslProperties", + "traits": { + "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

" + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

" + } + }, + "FolderArns": { + "target": "com.amazonaws.quicksight#FolderArnList", + "traits": { + "smithy.api#documentation": "

When you create the data source, Amazon QuickSight adds the data source to these folders.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateDataSourceResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The status of creating the data source.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateFolder": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateFolderRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateFolderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an empty shared folder.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateFolderMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateFolderMembershipRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateFolderMembershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds an asset, such as a dashboard, analysis, or dataset into a folder.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateFolderMembershipRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MemberId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the asset that you want to add to the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MemberType": { + "target": "com.amazonaws.quicksight#MemberType", + "traits": { + "smithy.api#documentation": "

The member type of the asset that you want to add to a folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateFolderMembershipResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + }, + "FolderMember": { + "target": "com.amazonaws.quicksight#FolderMember", + "traits": { + "smithy.api#documentation": "

Information about the member in the folder.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateFolderRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account where you want to create the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#FolderName", + "traits": { + "smithy.api#documentation": "

The name of the folder.

" + } + }, + "FolderType": { + "target": "com.amazonaws.quicksight#FolderType", + "traits": { + "smithy.api#documentation": "

The type of folder. By default, folderType is SHARED.

" + } + }, + "ParentFolderArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the parent folder.

\n

\n ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A structure that describes the principals and the resource-level permissions of a folder.

\n

To specify no permissions, omit Permissions.

" + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

Tags for the folder.

" + } + }, + "SharingModel": { + "target": "com.amazonaws.quicksight#SharingModel", + "traits": { + "smithy.api#documentation": "

An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateFolderResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the newly created folder.

" + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The folder ID for the newly created folder.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The request ID for the newly created folder.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateGroupRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Use the CreateGroup operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services Support.

\n

The permissions resource is\n\t\t\t\t\tarn:aws:quicksight:::group/default/\n .

\n

The response is a group object.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateGroupMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateGroupMembershipRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateGroupMembershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds an Amazon QuickSight user to an Amazon QuickSight group.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateGroupMembershipRequest": { + "type": "structure", + "members": { + "MemberName": { + "target": "com.amazonaws.quicksight#GroupMemberName", + "traits": { + "smithy.api#documentation": "

The name of the user that you want to add to the group membership.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group that you want to add the user to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the \n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that you want the user to be a part of.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateGroupMembershipResponse": { + "type": "structure", + "members": { + "GroupMember": { + "target": "com.amazonaws.quicksight#GroupMember", + "traits": { + "smithy.api#documentation": "

The group member.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateGroupRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

A name for the group that you want to create.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.quicksight#GroupDescription", + "traits": { + "smithy.api#documentation": "

A description for the group that you want to create.

" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that you want the group to be a part of.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request object for this operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateGroupResponse": { + "type": "structure", + "members": { + "Group": { + "target": "com.amazonaws.quicksight#Group", + "traits": { + "smithy.api#documentation": "

The name of the group.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The response object for this operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateIAMPolicyAssignment": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateIAMPolicyAssignmentRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateIAMPolicyAssignmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConcurrentUpdatingException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an assignment with one specified IAM policy, identified by its\n\t\t\tAmazon Resource Name (ARN). This policy assignment is attached to the specified groups\n\t\t\tor users of Amazon QuickSight. Assignment names are unique per Amazon Web Services\n\t\t\taccount. To avoid overwriting rules in other namespaces, use assignment names that are\n\t\t\tunique.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateIAMPolicyAssignmentRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "traits": { + "smithy.api#documentation": "

The name of the assignment, also called a rule.\n\t\t\tThe\n\t\t\tname\n\t\t\tmust be unique within the\n\t\t\tAmazon Web Services account.

", + "smithy.api#required": {} + } + }, + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", + "traits": { + "smithy.api#documentation": "

The status of the assignment. Possible values are as follows:

\n ", + "smithy.api#required": {} + } + }, + "PolicyArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM policy to apply to the Amazon QuickSight users and\n\t\t\tgroups specified in this assignment.

" + } + }, + "Identities": { + "target": "com.amazonaws.quicksight#IdentityMap", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight users, groups, or both that you want to assign the policy\n\t\t\tto.

" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that contains the assignment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateIAMPolicyAssignmentResponse": { + "type": "structure", + "members": { + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "traits": { + "smithy.api#documentation": "

The name of the assignment.\n\t\t\tThe\n\t\t\tname must be unique within the Amazon Web Services account.

" + } + }, + "AssignmentId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID for the assignment.

" + } + }, + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", + "traits": { + "smithy.api#documentation": "

The status of the assignment. Possible values are as follows:

\n " + } + }, + "PolicyArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM policy that is applied to the Amazon QuickSight\n\t\t\tusers and groups specified in this assignment.

" + } + }, + "Identities": { + "target": "com.amazonaws.quicksight#IdentityMap", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight users, groups, or both that the IAM policy is\n\t\t\tassigned to.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateIngestion": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateIngestionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateIngestionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in\n\t\t\tan Enterprise edition account 32 times in a 24-hour period. You can manually refresh\n\t\t\tdatasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period\n\t\t\tis measured starting 24 hours before the current date and time.

\n

Any ingestions operating on tagged datasets inherit the same tags automatically for use in\n\t\t\taccess control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using\n\t\t\t\ttags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateIngestionRequest": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the dataset used in the ingestion.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IngestionId": { + "target": "com.amazonaws.quicksight#IngestionId", + "traits": { + "smithy.api#documentation": "

An ID for the ingestion.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IngestionType": { + "target": "com.amazonaws.quicksight#IngestionType", + "traits": { + "smithy.api#documentation": "

The type of ingestion that you want to create.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateIngestionResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the data ingestion.

" + } + }, + "IngestionId": { + "target": "com.amazonaws.quicksight#IngestionId", + "traits": { + "smithy.api#documentation": "

An ID for the ingestion.

" + } + }, + "IngestionStatus": { + "target": "com.amazonaws.quicksight#IngestionStatus", + "traits": { + "smithy.api#documentation": "

The ingestion status.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateNamespaceRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateNamespaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.

\n

A namespace allows you to isolate the Amazon QuickSight users and groups that are registered\n for that namespace. Users that access the namespace can share assets only with other\n users or groups in the same namespace. They can't see users and groups in other\n namespaces. You can create a namespace after your Amazon Web Services account is subscribed to\n Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a\n limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with\n Amazon Web Services Support.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateNamespaceRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The name that you want to use to describe the new namespace.

", + "smithy.api#required": {} + } + }, + "IdentityStore": { + "target": "com.amazonaws.quicksight#IdentityStore", + "traits": { + "smithy.api#documentation": "

Specifies the type of your user identity directory. Currently, this supports users\n with an identity type of QUICKSIGHT.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

The tags that you want to associate with the namespace that you're creating.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateNamespaceResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the Amazon QuickSight namespace you created.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The name of the new namespace that you created.

" + } + }, + "CapacityRegion": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region; that you want to use for the free SPICE capacity for the new namespace.\n This is set to the region that you run CreateNamespace in.

" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#NamespaceStatus", + "traits": { + "smithy.api#documentation": "

The status of the creation of the namespace. This is an asynchronous process. A status\n of CREATED means that your namespace is ready to use. If an error occurs,\n it indicates if the process is retryable or non-retryable. In\n the case of a non-retryable error, refer to the error message for follow-up\n tasks.

" + } + }, + "IdentityStore": { + "target": "com.amazonaws.quicksight#IdentityStore", + "traits": { + "smithy.api#documentation": "

Specifies the type of your user identity directory. Currently, this supports users\n with an identity type of QUICKSIGHT.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateRefreshScheduleRequest": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Schedule": { + "target": "com.amazonaws.quicksight#RefreshSchedule", + "traits": { + "smithy.api#documentation": "

The refresh schedule.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateRefreshScheduleResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the refresh schedule.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the refresh schedule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateRoleMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateRoleMembershipRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateRoleMembershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Use CreateRoleMembership to add an existing Amazon QuickSight group to an existing role.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members/{MemberName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateRoleMembershipRequest": { + "type": "structure", + "members": { + "MemberName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group that you want to add to the role.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that the role belongs to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Role": { + "target": "com.amazonaws.quicksight#Role", + "traits": { + "smithy.api#documentation": "

The role that you want to add a group to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateRoleMembershipResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateTemplateRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template. You can use the resulting\n\t\t\ttemplate to create additional dashboards, templates, or analyses.

\n

A template is an entity in Amazon QuickSight that encapsulates the metadata\n\t\t\trequired to create an analysis and that you can use to create s dashboard. A template adds\n\t\t\ta layer of abstraction by using placeholders to replace the dataset associated with the\n\t\t\tanalysis. You can use templates to create dashboards by replacing dataset placeholders\n\t\t\twith datasets that follow the same schema that was used to create the source analysis\n\t\t\tand template.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateTemplateAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateTemplateAliasRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateTemplateAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a template alias for a template.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateTemplateAliasRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template that you creating an alias for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The name that you want to give to the template alias that you're creating. Don't start the\n\t\t\talias name with the $ character. Alias names that start with $\n\t\t\tare reserved by Amazon QuickSight.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateTemplateAliasResponse": { + "type": "structure", + "members": { + "TemplateAlias": { + "target": "com.amazonaws.quicksight#TemplateAlias", + "traits": { + "smithy.api#documentation": "

Information about the template alias.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateTemplateRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in\n\t\t\teach Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#TemplateName", + "traits": { + "smithy.api#documentation": "

A display name for the template.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions to be set on the template.

" + } + }, + "SourceEntity": { + "target": "com.amazonaws.quicksight#TemplateSourceEntity", + "traits": { + "smithy.api#documentation": "

The entity that you are using as a source when you create the template. In\n\t\t\tSourceEntity, you specify the type of object you're using as source:\n\t\t\tSourceTemplate for a template or SourceAnalysis for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate, specify the ARN of the source template. For\n\t\t\tSourceAnalysis, specify the ARN of the source analysis. The SourceTemplate\n\t\t\tARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

\n

Use the DataSetReferences entity within SourceTemplate or\n\t\t\tSourceAnalysis to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.

\n

Either a SourceEntity or a Definition must be provided in \n\t\t\torder for the request to be valid.

" + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

" + } + }, + "VersionDescription": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

A description of the current template version being created. This API operation creates the\n\t\t\tfirst version of the template. Every time UpdateTemplate is called, a new\n\t\t\tversion is created. Each version of the template maintains a description of the version\n\t\t\tin the VersionDescription field.

" + } + }, + "Definition": { + "target": "com.amazonaws.quicksight#TemplateVersionDefinition", + "traits": { + "smithy.api#documentation": "

The definition of a template.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

\n

Either a SourceEntity or a Definition must be provided in \n\t\t\torder for the request to be valid.

" + } + }, + "ValidationStrategy": { + "target": "com.amazonaws.quicksight#ValidationStrategy", + "traits": { + "smithy.api#documentation": "

TThe option to relax the validation needed to create a template with definition objects. This skips the validation step for specific errors.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateTemplateResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the template.

" + } + }, + "VersionArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the template, including the version information of\n\t\t\tthe first version.

" + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the template.

" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The template creation status.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateTheme": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateThemeRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateThemeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a theme.

\n

A theme is set of configuration options for color and layout.\n\t\t\tThemes apply to analyses and dashboards. For more information, see Using\n\t\t\tThemes in Amazon QuickSight in the Amazon QuickSight User Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateThemeAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateThemeAliasRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateThemeAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a theme alias for a theme.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateThemeAliasRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme for the new theme alias.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the theme alias.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The name that you want to give to the theme alias that you are creating. The\n\t\t\talias name can't begin with a $. Alias names that start with $\n\t\t\tare reserved by Amazon QuickSight.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the theme.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateThemeAliasResponse": { + "type": "structure", + "members": { + "ThemeAlias": { + "target": "com.amazonaws.quicksight#ThemeAlias", + "traits": { + "smithy.api#documentation": "

Information about the theme alias.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateThemeRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account where you want to store the new theme.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in\n\t\t\teach Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ThemeName", + "traits": { + "smithy.api#documentation": "

A display name for the theme.

", + "smithy.api#required": {} + } + }, + "BaseThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the theme that a custom theme will inherit from. All themes inherit from one of\n\t\t\tthe starting themes defined by Amazon QuickSight. For a list of the starting themes, use\n\t\t\t\tListThemes or choose Themes from\n\t\t\twithin an analysis.

", + "smithy.api#required": {} + } + }, + "VersionDescription": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

A description of the first version of the theme that you're creating. Every time\n\t\t\t\tUpdateTheme is called, a new version is created. Each version of the\n\t\t\ttheme has a description of the version in the VersionDescription\n\t\t\tfield.

" + } + }, + "Configuration": { + "target": "com.amazonaws.quicksight#ThemeConfiguration", + "traits": { + "smithy.api#documentation": "

The theme configuration, which contains the theme display properties.

", + "smithy.api#required": {} + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A valid grouping of resource permissions to apply to the new theme.\n\t\t\t

" + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

A map of the key-value pairs for the resource tag or tags that you want to add to the\n\t\t\tresource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateThemeResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the theme.

" + } + }, + "VersionArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the new theme.

" + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the theme.

" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The theme creation status.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateTopic": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateTopicRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateTopicResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new Q topic.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/topics", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateTopicRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateTopicRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateTopicRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a topic refresh schedule.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateTopicRefreshScheduleRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic\n you're creating a refresh schedule for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

", + "smithy.api#required": {} + } + }, + "DatasetName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of the dataset.

" + } + }, + "RefreshSchedule": { + "target": "com.amazonaws.quicksight#TopicRefreshSchedule", + "traits": { + "smithy.api#documentation": "

The definition of a refresh schedule.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateTopicRefreshScheduleResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateTopicRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that you want to create a topic in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "Topic": { + "target": "com.amazonaws.quicksight#TopicDetails", + "traits": { + "smithy.api#documentation": "

The definition of a topic to create.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags that are assigned to\n the dataset.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateTopicResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region\n for each Amazon Web Services account.

" + } + }, + "RefreshArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic refresh.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateTopicReviewedAnswer": { + "type": "structure", + "members": { + "AnswerId": { + "target": "com.amazonaws.quicksight#AnswerId", + "traits": { + "smithy.api#documentation": "

The answer ID for the CreateTopicReviewedAnswer.

", + "smithy.api#required": {} + } + }, + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Dataset arn for the CreateTopicReviewedAnswer.

", + "smithy.api#required": {} + } + }, + "Question": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The Question to be created.

", + "smithy.api#required": {} + } + }, + "Mir": { + "target": "com.amazonaws.quicksight#TopicIR", + "traits": { + "smithy.api#documentation": "

The Mir for the CreateTopicReviewedAnswer.

" + } + }, + "PrimaryVisual": { + "target": "com.amazonaws.quicksight#TopicVisual", + "traits": { + "smithy.api#documentation": "

The PrimaryVisual for the CreateTopicReviewedAnswer.

" + } + }, + "Template": { + "target": "com.amazonaws.quicksight#TopicTemplate", + "traits": { + "smithy.api#documentation": "

The template for the CreateTopicReviewedAnswer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a CreateTopicReviewedAnswer.

" + } + }, + "com.amazonaws.quicksight#CreateTopicReviewedAnswers": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#CreateTopicReviewedAnswer" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#CreateVPCConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateVPCConnectionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateVPCConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new VPC connection.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/vpc-connections", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateVPCConnectionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the account where you want to create a new VPC\n\t\t\tconnection.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdRestricted", + "traits": { + "smithy.api#documentation": "

The ID of the VPC connection that\n\t\t\tyou're creating. This ID is a unique identifier for each Amazon Web Services Region in an\n\t\t\t\tAmazon Web Services account.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

The display name for the VPC connection.

", + "smithy.api#required": {} + } + }, + "SubnetIds": { + "target": "com.amazonaws.quicksight#SubnetIdList", + "traits": { + "smithy.api#documentation": "

A list of subnet IDs for the VPC connection.

", + "smithy.api#required": {} + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.quicksight#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of security group IDs for the VPC connection.

", + "smithy.api#required": {} + } + }, + "DnsResolvers": { + "target": "com.amazonaws.quicksight#DnsResolverList", + "traits": { + "smithy.api#documentation": "

A list of IP addresses of DNS resolver endpoints for the VPC connection.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.quicksight#RoleArn", + "traits": { + "smithy.api#documentation": "

The IAM role to associate with the VPC connection.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

A map of the key-value pairs for the resource tag or tags assigned to the VPC\n\t\t\tconnection.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateVPCConnectionResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC connection.

" + } + }, + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdRestricted", + "traits": { + "smithy.api#documentation": "

The ID for the VPC connection that\n\t\t\tyou're creating. This ID is unique per Amazon Web Services Region for each Amazon Web Services\n\t\t\taccount.

" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", + "traits": { + "smithy.api#documentation": "

The status of the creation of the VPC connection.

" + } + }, + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", + "traits": { + "smithy.api#documentation": "

The availability status of the VPC connection.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CredentialPair": { + "type": "structure", + "members": { + "Username": { + "target": "com.amazonaws.quicksight#DbUsername", + "traits": { + "smithy.api#documentation": "

User name.

", + "smithy.api#required": {} + } + }, + "Password": { + "target": "com.amazonaws.quicksight#Password", + "traits": { + "smithy.api#documentation": "

Password.

", + "smithy.api#required": {} + } + }, + "AlternateDataSourceParameters": { + "target": "com.amazonaws.quicksight#DataSourceParametersList", + "traits": { + "smithy.api#documentation": "

A set of alternate data source parameters that you want to share for these\n credentials. The credentials are applied in tandem with the data source parameters when\n you copy a data source by using a create or update request. The API operation compares\n the DataSourceParameters structure that's in the request with the\n structures in the AlternateDataSourceParameters allow list. If the\n structures are an exact match, the request is allowed to use the new data source with\n the existing credentials. If the AlternateDataSourceParameters list is\n null, the DataSourceParameters originally used with these\n Credentials is automatically allowed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The combination of user name and password that are used as credentials.

" + } + }, + "com.amazonaws.quicksight#CrossDatasetTypes": { + "type": "enum", + "members": { + "ALL_DATASETS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_DATASETS" + } + }, + "SINGLE_DATASET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_DATASET" + } + } + } + }, + "com.amazonaws.quicksight#CurrencyCode": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Z]{3}$" + } + }, + "com.amazonaws.quicksight#CurrencyDisplayFormatConfiguration": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.quicksight#Prefix", + "traits": { + "smithy.api#documentation": "

Determines the prefix value of the currency format.

" + } + }, + "Suffix": { + "target": "com.amazonaws.quicksight#Suffix", + "traits": { + "smithy.api#documentation": "

Determines the suffix value of the currency format.

" + } + }, + "SeparatorConfiguration": { + "target": "com.amazonaws.quicksight#NumericSeparatorConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the numeric separator configuration.

" + } + }, + "Symbol": { + "target": "com.amazonaws.quicksight#CurrencyCode", + "traits": { + "smithy.api#documentation": "

Determines the symbol for the currency format.

" + } + }, + "DecimalPlacesConfiguration": { + "target": "com.amazonaws.quicksight#DecimalPlacesConfiguration", + "traits": { + "smithy.api#documentation": "

The option that determines the decimal places configuration.

" + } + }, + "NumberScale": { + "target": "com.amazonaws.quicksight#NumberScale", + "traits": { + "smithy.api#documentation": "

Determines the number scale value for the currency format.

" + } + }, + "NegativeValueConfiguration": { + "target": "com.amazonaws.quicksight#NegativeValueConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the negative value configuration.

" + } + }, + "NullValueFormatConfiguration": { + "target": "com.amazonaws.quicksight#NullValueFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the null value format configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the currency display format configuration.

" + } + }, + "com.amazonaws.quicksight#CustomActionColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#CustomActionFilterOperation": { + "type": "structure", + "members": { + "SelectedFieldsConfiguration": { + "target": "com.amazonaws.quicksight#FilterOperationSelectedFieldsConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that chooses the fields to be filtered.

", + "smithy.api#required": {} + } + }, + "TargetVisualsConfiguration": { + "target": "com.amazonaws.quicksight#FilterOperationTargetVisualsConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that chooses the target visuals to be filtered.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The filter operation that filters data included in a visual or in an entire sheet.

" + } + }, + "com.amazonaws.quicksight#CustomActionNavigationOperation": { + "type": "structure", + "members": { + "LocalNavigationConfiguration": { + "target": "com.amazonaws.quicksight#LocalNavigationConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that chooses the navigation target.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The navigation operation that navigates between different sheets in the same analysis.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#CustomActionSetParametersOperation": { + "type": "structure", + "members": { + "ParameterValueConfigurations": { + "target": "com.amazonaws.quicksight#SetParameterValueConfigurationList", + "traits": { + "smithy.api#documentation": "

The parameter that determines the value configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The set parameter operation that sets parameters in custom action.

" + } + }, + "com.amazonaws.quicksight#CustomActionURLOperation": { + "type": "structure", + "members": { + "URLTemplate": { + "target": "com.amazonaws.quicksight#URLOperationTemplate", + "traits": { + "smithy.api#documentation": "

THe URL link of the CustomActionURLOperation.

", + "smithy.api#required": {} + } + }, + "URLTarget": { + "target": "com.amazonaws.quicksight#URLTargetConfiguration", + "traits": { + "smithy.api#documentation": "

The target of the CustomActionURLOperation.

\n

Valid values are defined as follows:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The URL operation that opens a link to another webpage.

" + } + }, + "com.amazonaws.quicksight#CustomColor": { + "type": "structure", + "members": { + "FieldValue": { + "target": "com.amazonaws.quicksight#FieldValue", + "traits": { + "smithy.api#documentation": "

The data value that the color is applied to.

" + } + }, + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color that is applied to the data value.

", + "smithy.api#required": {} + } + }, + "SpecialValue": { + "target": "com.amazonaws.quicksight#SpecialValue", + "traits": { + "smithy.api#documentation": "

The value of a special data value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the color that's applied to a particular data value in a column.

" + } + }, + "com.amazonaws.quicksight#CustomColorsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#CustomColor" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#CustomContentConfiguration": { + "type": "structure", + "members": { + "ContentUrl": { + "target": "com.amazonaws.quicksight#URLOperationTemplate", + "traits": { + "smithy.api#documentation": "

The input URL that links to the custom content that you want in the custom visual.

" + } + }, + "ContentType": { + "target": "com.amazonaws.quicksight#CustomContentType", + "traits": { + "smithy.api#documentation": "

The content type of the custom content visual. You can use this to have the visual render as an image.

" + } + }, + "ImageScaling": { + "target": "com.amazonaws.quicksight#CustomContentImageScalingConfiguration", + "traits": { + "smithy.api#documentation": "

The sizing options for the size of the custom content visual. This structure is required when the ContentType of the visual is 'IMAGE'.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a CustomContentVisual.

" + } + }, + "com.amazonaws.quicksight#CustomContentImageScalingConfiguration": { + "type": "enum", + "members": { + "FIT_TO_HEIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIT_TO_HEIGHT" + } + }, + "FIT_TO_WIDTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIT_TO_WIDTH" + } + }, + "DO_NOT_SCALE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DO_NOT_SCALE" + } + }, + "SCALE_TO_VISUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCALE_TO_VISUAL" + } + } + } + }, + "com.amazonaws.quicksight#CustomContentType": { + "type": "enum", + "members": { + "IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE" + } + }, + "OTHER_EMBEDDED_CONTENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER_EMBEDDED_CONTENT" + } + } + } + }, + "com.amazonaws.quicksight#CustomContentVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#CustomContentConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of a CustomContentVisual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "DataSetIdentifier": { + "target": "com.amazonaws.quicksight#DataSetIdentifier", + "traits": { + "smithy.api#documentation": "

The dataset that is used to create the custom content visual. You can't create a visual without a dataset.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A visual that contains custom content.

\n

For more information, see Using custom visual content in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#CustomFilterConfiguration": { + "type": "structure", + "members": { + "MatchOperator": { + "target": "com.amazonaws.quicksight#CategoryFilterMatchOperator", + "traits": { + "smithy.api#documentation": "

The match operator that is used to determine if a filter should be applied.

", + "smithy.api#required": {} + } + }, + "CategoryValue": { + "target": "com.amazonaws.quicksight#CategoryValue", + "traits": { + "smithy.api#documentation": "

The category value for the filter.

\n

This field is mutually exclusive to ParameterName.

" + } + }, + "SelectAllOptions": { + "target": "com.amazonaws.quicksight#CategoryFilterSelectAllOptions", + "traits": { + "smithy.api#documentation": "

Select all of the values. Null is not the assigned value of select all.

\n " + } + }, + "ParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The parameter whose value should be used for the filter value.

\n

This field is mutually exclusive to CategoryValue.

" + } + }, + "NullOption": { + "target": "com.amazonaws.quicksight#FilterNullOption", + "traits": { + "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A custom filter that filters based on a single value. This filter can be partially matched.

" + } + }, + "com.amazonaws.quicksight#CustomFilterListConfiguration": { + "type": "structure", + "members": { + "MatchOperator": { + "target": "com.amazonaws.quicksight#CategoryFilterMatchOperator", + "traits": { + "smithy.api#documentation": "

The match operator that is used to determine if a filter should be applied.

", + "smithy.api#required": {} + } + }, + "CategoryValues": { + "target": "com.amazonaws.quicksight#CategoryValueList", + "traits": { + "smithy.api#documentation": "

The list of category values for the filter.

" + } + }, + "SelectAllOptions": { + "target": "com.amazonaws.quicksight#CategoryFilterSelectAllOptions", + "traits": { + "smithy.api#documentation": "

Select all of the values. Null is not the assigned value of select all.

\n " + } + }, + "NullOption": { + "target": "com.amazonaws.quicksight#FilterNullOption", + "traits": { + "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of custom filter values.

" + } + }, + "com.amazonaws.quicksight#CustomLabel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#CustomNarrativeOptions": { + "type": "structure", + "members": { + "Narrative": { + "target": "com.amazonaws.quicksight#NarrativeString", + "traits": { + "smithy.api#documentation": "

The string input of custom narrative.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The custom narrative options.

" + } + }, + "com.amazonaws.quicksight#CustomParameterValues": { + "type": "structure", + "members": { + "StringValues": { + "target": "com.amazonaws.quicksight#StringDefaultValueList", + "traits": { + "smithy.api#documentation": "

A list of string-type parameter values.

" + } + }, + "IntegerValues": { + "target": "com.amazonaws.quicksight#IntegerDefaultValueList", + "traits": { + "smithy.api#documentation": "

A list of integer-type parameter values.

" + } + }, + "DecimalValues": { + "target": "com.amazonaws.quicksight#DecimalDefaultValueList", + "traits": { + "smithy.api#documentation": "

A list of decimal-type parameter values.

" + } + }, + "DateTimeValues": { + "target": "com.amazonaws.quicksight#DateTimeDefaultValueList", + "traits": { + "smithy.api#documentation": "

A list of datetime-type parameter values.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The customized parameter values.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#CustomSql": { + "type": "structure", + "members": { + "DataSourceArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#CustomSqlName", + "traits": { + "smithy.api#documentation": "

A display name for the SQL query result.

", + "smithy.api#required": {} + } + }, + "SqlQuery": { + "target": "com.amazonaws.quicksight#SqlQuery", + "traits": { + "smithy.api#documentation": "

The SQL query.

", + "smithy.api#required": {} + } + }, + "Columns": { + "target": "com.amazonaws.quicksight#InputColumnList", + "traits": { + "smithy.api#documentation": "

The column schema from the SQL query result set.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A physical table type built from the results of the custom SQL query.

" + } + }, + "com.amazonaws.quicksight#CustomSqlName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#CustomValuesConfiguration": { + "type": "structure", + "members": { + "IncludeNullValue": { + "target": "com.amazonaws.quicksight#BooleanObject", + "traits": { + "smithy.api#documentation": "

Includes the null value in custom action parameter values.

" + } + }, + "CustomValues": { + "target": "com.amazonaws.quicksight#CustomParameterValues", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of custom values for the destination parameter in DestinationParameterValueConfiguration.

" + } + }, + "com.amazonaws.quicksight#CustomerManagedKeyUnavailableException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The customer managed key that is registered to your Amazon QuickSight account is unavailable.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.quicksight#Dashboard": { + "type": "structure", + "members": { + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

Dashboard ID.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DashboardName", + "traits": { + "smithy.api#documentation": "

A display name for the dashboard.

" + } + }, + "Version": { + "target": "com.amazonaws.quicksight#DashboardVersion", + "traits": { + "smithy.api#documentation": "

Version.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that this dashboard was created.

" + } + }, + "LastPublishedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that this dashboard was published.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that this dashboard was updated.

" + } + }, + "LinkEntities": { + "target": "com.amazonaws.quicksight#LinkEntityArnList", + "traits": { + "smithy.api#documentation": "

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Dashboard.

" + } + }, + "com.amazonaws.quicksight#DashboardBehavior": { + "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.quicksight#DashboardError": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#DashboardErrorType", + "traits": { + "smithy.api#documentation": "

Type.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Message.

" + } + }, + "ViolatedEntities": { + "target": "com.amazonaws.quicksight#EntityList", + "traits": { + "smithy.api#documentation": "

Lists the violated entities that caused the dashboard error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Dashboard error.

" + } + }, + "com.amazonaws.quicksight#DashboardErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DashboardError" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.quicksight#DashboardErrorType": { + "type": "enum", + "members": { + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_DENIED" + } + }, + "SOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOURCE_NOT_FOUND" + } + }, + "DATA_SET_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SET_NOT_FOUND" + } + }, + "INTERNAL_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_FAILURE" + } + }, + "PARAMETER_VALUE_INCOMPATIBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARAMETER_VALUE_INCOMPATIBLE" + } + }, + "PARAMETER_TYPE_INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARAMETER_TYPE_INVALID" + } + }, + "PARAMETER_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARAMETER_NOT_FOUND" + } + }, + "COLUMN_TYPE_MISMATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLUMN_TYPE_MISMATCH" + } + }, + "COLUMN_GEOGRAPHIC_ROLE_MISMATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLUMN_GEOGRAPHIC_ROLE_MISMATCH" + } + }, + "COLUMN_REPLACEMENT_MISSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLUMN_REPLACEMENT_MISSING" + } + } + } + }, + "com.amazonaws.quicksight#DashboardFilterAttribute": { + "type": "enum", + "members": { + "QUICKSIGHT_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_USER" + } + }, + "QUICKSIGHT_VIEWER_OR_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_VIEWER_OR_OWNER" + } + }, + "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" + } + }, + "QUICKSIGHT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_OWNER" + } + }, + "DIRECT_QUICKSIGHT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_OWNER" + } + }, + "DIRECT_QUICKSIGHT_SOLE_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_SOLE_OWNER" + } + }, + "DASHBOARD_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DASHBOARD_NAME" + } + } + } + }, + "com.amazonaws.quicksight#DashboardName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#DashboardPublishOptions": { + "type": "structure", + "members": { + "AdHocFilteringOption": { + "target": "com.amazonaws.quicksight#AdHocFilteringOption", + "traits": { + "smithy.api#documentation": "

Ad hoc (one-time) filtering option.

" + } + }, + "ExportToCSVOption": { + "target": "com.amazonaws.quicksight#ExportToCSVOption", + "traits": { + "smithy.api#documentation": "

Export to .csv option.

" + } + }, + "SheetControlsOption": { + "target": "com.amazonaws.quicksight#SheetControlsOption", + "traits": { + "smithy.api#documentation": "

Sheet controls option.

" + } + }, + "VisualPublishOptions": { + "target": "com.amazonaws.quicksight#DashboardVisualPublishOptions", + "traits": { + "smithy.api#deprecated": { + "message": "VisualPublishOptions property will reach its end of standard support in a future release. To perform this action, use ExportWithHiddenFields." + }, + "smithy.api#documentation": "

The visual publish options of a visual in a dashboard.

" + } + }, + "SheetLayoutElementMaximizationOption": { + "target": "com.amazonaws.quicksight#SheetLayoutElementMaximizationOption", + "traits": { + "smithy.api#documentation": "

The sheet layout maximization options of a dashbaord.

" + } + }, + "VisualMenuOption": { + "target": "com.amazonaws.quicksight#VisualMenuOption", + "traits": { + "smithy.api#documentation": "

The menu options of a visual in a dashboard.

" + } + }, + "VisualAxisSortOption": { + "target": "com.amazonaws.quicksight#VisualAxisSortOption", + "traits": { + "smithy.api#documentation": "

The axis sort options of a dashboard.

" + } + }, + "ExportWithHiddenFieldsOption": { + "target": "com.amazonaws.quicksight#ExportWithHiddenFieldsOption", + "traits": { + "smithy.api#documentation": "

Determines if hidden fields are exported with a dashboard.

" + } + }, + "DataPointDrillUpDownOption": { + "target": "com.amazonaws.quicksight#DataPointDrillUpDownOption", + "traits": { + "smithy.api#documentation": "

The drill-down options of data points in a dashboard.

" + } + }, + "DataPointMenuLabelOption": { + "target": "com.amazonaws.quicksight#DataPointMenuLabelOption", + "traits": { + "smithy.api#documentation": "

The data point menu label options of a dashboard.

" + } + }, + "DataPointTooltipOption": { + "target": "com.amazonaws.quicksight#DataPointTooltipOption", + "traits": { + "smithy.api#documentation": "

The data point tool tip options of a dashboard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Dashboard publish options.

" + } + }, + "com.amazonaws.quicksight#DashboardSearchFilter": { + "type": "structure", + "members": { + "Operator": { + "target": "com.amazonaws.quicksight#FilterOperator", + "traits": { + "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\": \"StringEquals\". Valid values are \"StringEquals\" and \"StringLike\".

\n

If you set the operator value to \"StringEquals\", you need to provide an ownership related filter in the \"NAME\" field and the arn of the user or group whose folders you want to search in the \"Value\" field. For example, \"Name\":\"DIRECT_QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

\n

If you set the value to \"StringLike\", you need to provide the name of the folders you are searching for. For example, \"Name\":\"DASHBOARD_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\". The \"StringLike\" operator only supports the NAME value DASHBOARD_NAME.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DashboardFilterAttribute", + "traits": { + "smithy.api#documentation": "

The name of the value that you want to use as a filter, for example, \"Name\":\n \"QUICKSIGHT_OWNER\".

\n

Valid values are defined as follows:

\n " + } + }, + "Value": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The value of the named item, in this case QUICKSIGHT_USER, that you want\n to use as a filter, for example, \"Value\":\n \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter that you apply when searching for dashboards.

" + } + }, + "com.amazonaws.quicksight#DashboardSearchFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DashboardSearchFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#DashboardSourceEntity": { + "type": "structure", + "members": { + "SourceTemplate": { + "target": "com.amazonaws.quicksight#DashboardSourceTemplate", + "traits": { + "smithy.api#documentation": "

Source template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Dashboard source entity.

" + } + }, + "com.amazonaws.quicksight#DashboardSourceTemplate": { + "type": "structure", + "members": { + "DataSetReferences": { + "target": "com.amazonaws.quicksight#DataSetReferenceList", + "traits": { + "smithy.api#documentation": "

Dataset references.

", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Dashboard source template.

" + } + }, + "com.amazonaws.quicksight#DashboardSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

Dashboard ID.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DashboardName", + "traits": { + "smithy.api#documentation": "

A display name for the dashboard.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that this dashboard was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that this dashboard was updated.

" + } + }, + "PublishedVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

Published version number.

" + } + }, + "LastPublishedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that this dashboard was published.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Dashboard summary.

" + } + }, + "com.amazonaws.quicksight#DashboardSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DashboardSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#DashboardUIState": { + "type": "enum", + "members": { + "EXPANDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPANDED" + } + }, + "COLLAPSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLLAPSED" + } + } + } + }, + "com.amazonaws.quicksight#DashboardVersion": { + "type": "structure", + "members": { + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that this dashboard version was created.

" + } + }, + "Errors": { + "target": "com.amazonaws.quicksight#DashboardErrorList", + "traits": { + "smithy.api#documentation": "

Errors associated with this dashboard version.

" + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

Version number for this version of the dashboard.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The HTTP status of the request.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "SourceEntityArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

Source entity ARN.

" + } + }, + "DataSetArns": { + "target": "com.amazonaws.quicksight#DataSetArnsList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Numbers (ARNs) for the datasets that are associated with this\n version of the dashboard.

" + } + }, + "Description": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

Description.

" + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the theme associated with a version of the dashboard.

" + } + }, + "Sheets": { + "target": "com.amazonaws.quicksight#SheetList", + "traits": { + "smithy.api#documentation": "

A list of the associated sheets with the unique identifier and name of each sheet.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Dashboard version.

" + } + }, + "com.amazonaws.quicksight#DashboardVersionDefinition": { + "type": "structure", + "members": { + "DataSetIdentifierDeclarations": { + "target": "com.amazonaws.quicksight#DataSetIdentifierDeclarationList", + "traits": { + "smithy.api#documentation": "

An array of dataset identifier declarations. With\n this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.

", + "smithy.api#required": {} + } + }, + "Sheets": { + "target": "com.amazonaws.quicksight#SheetDefinitionList", + "traits": { + "smithy.api#documentation": "

An array of sheet definitions for a dashboard.

" + } + }, + "CalculatedFields": { + "target": "com.amazonaws.quicksight#CalculatedFields", + "traits": { + "smithy.api#documentation": "

An array of calculated field definitions for the dashboard.

" + } + }, + "ParameterDeclarations": { + "target": "com.amazonaws.quicksight#ParameterDeclarationList", + "traits": { + "smithy.api#documentation": "

The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.

\n

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

" + } + }, + "FilterGroups": { + "target": "com.amazonaws.quicksight#FilterGroupList", + "traits": { + "smithy.api#documentation": "

The filter definitions for a dashboard.

\n

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.

" + } + }, + "ColumnConfigurations": { + "target": "com.amazonaws.quicksight#ColumnConfigurationList", + "traits": { + "smithy.api#documentation": "

An array of dashboard-level column configurations. Column configurations\n are used to set the default formatting for a column that\n is used throughout a dashboard.

" + } + }, + "AnalysisDefaults": { + "target": "com.amazonaws.quicksight#AnalysisDefaults" + }, + "Options": { + "target": "com.amazonaws.quicksight#AssetOptions", + "traits": { + "smithy.api#documentation": "

An array of option definitions for a dashboard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The contents of a dashboard.

" + } + }, + "com.amazonaws.quicksight#DashboardVersionSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that this dashboard version was created.

" + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

Version number.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The HTTP status of the request.

" + } + }, + "SourceEntityArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

Source entity ARN.

" + } + }, + "Description": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

Description.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Dashboard version summary.

" + } + }, + "com.amazonaws.quicksight#DashboardVersionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DashboardVersionSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#DashboardVisualId": { + "type": "structure", + "members": { + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

", + "smithy.api#required": {} + } + }, + "SheetId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.

", + "smithy.api#required": {} + } + }, + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the following elements:

\n \n

The DashboardId, SheetId, and VisualId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

" + } + }, + "com.amazonaws.quicksight#DashboardVisualPublishOptions": { + "type": "structure", + "members": { + "ExportHiddenFieldsOption": { + "target": "com.amazonaws.quicksight#ExportHiddenFieldsOption", + "traits": { + "smithy.api#documentation": "

Determines if hidden fields are included in an exported dashboard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The visual publish options of a visual in a dashboard

" + } + }, + "com.amazonaws.quicksight#DataAggregation": { + "type": "structure", + "members": { + "DatasetRowDateGranularity": { + "target": "com.amazonaws.quicksight#TopicTimeGranularity", + "traits": { + "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" + } + }, + "DefaultDateColumnName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The column name for the default date.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a data aggregation.

" + } + }, + "com.amazonaws.quicksight#DataBarsOptions": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID for the data bars options.

", + "smithy.api#required": {} + } + }, + "PositiveColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color of the positive data bar.

" + } + }, + "NegativeColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color of the negative data bar.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for data bars.

" + } + }, + "com.amazonaws.quicksight#DataColor": { + "type": "structure", + "members": { + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color that is applied to the data value.

" + } + }, + "DataValue": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The data value that the color is applied to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the color that is applied to a particular data value.

" + } + }, + "com.amazonaws.quicksight#DataColorPalette": { + "type": "structure", + "members": { + "Colors": { + "target": "com.amazonaws.quicksight#ColorList", + "traits": { + "smithy.api#documentation": "

The hexadecimal codes for the colors.

" + } + }, + "MinMaxGradient": { + "target": "com.amazonaws.quicksight#ColorList", + "traits": { + "smithy.api#documentation": "

The minimum and maximum hexadecimal codes that describe a color gradient.

" + } + }, + "EmptyFillColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The hexadecimal code of a color that applies to charts where a lack of data is\n highlighted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The theme colors that are used for data colors in charts. The colors description is a\n hexadecimal color code that consists of six alphanumerical characters, prefixed with\n #, for example #37BFF5.

" + } + }, + "com.amazonaws.quicksight#DataFieldSeriesItem": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID of the field that you are setting the axis binding to.

", + "smithy.api#required": {} + } + }, + "FieldValue": { + "target": "com.amazonaws.quicksight#SensitiveString", + "traits": { + "smithy.api#documentation": "

The field value of the field that you are setting the axis binding to.

" + } + }, + "AxisBinding": { + "target": "com.amazonaws.quicksight#AxisBinding", + "traits": { + "smithy.api#documentation": "

The axis that you are binding the field to.

", + "smithy.api#required": {} + } + }, + "Settings": { + "target": "com.amazonaws.quicksight#LineChartSeriesSettings", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of line series associated to the field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data field series item configuration of a line chart.

" + } + }, + "com.amazonaws.quicksight#DataLabelContent": { + "type": "enum", + "members": { + "VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALUE" + } + }, + "PERCENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENT" + } + }, + "VALUE_AND_PERCENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALUE_AND_PERCENT" + } + } + } + }, + "com.amazonaws.quicksight#DataLabelOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines the visibility of the data labels.

" + } + }, + "CategoryLabelVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines the visibility of the category field labels.

" + } + }, + "MeasureLabelVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines the visibility of the measure field labels.

" + } + }, + "DataLabelTypes": { + "target": "com.amazonaws.quicksight#DataLabelTypes", + "traits": { + "smithy.api#documentation": "

The option that determines the data label type.

" + } + }, + "Position": { + "target": "com.amazonaws.quicksight#DataLabelPosition", + "traits": { + "smithy.api#documentation": "

Determines the position of the data labels.

" + } + }, + "LabelContent": { + "target": "com.amazonaws.quicksight#DataLabelContent", + "traits": { + "smithy.api#documentation": "

Determines the content of the data labels.

" + } + }, + "LabelFontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration", + "traits": { + "smithy.api#documentation": "

Determines the font configuration of the data labels.

" + } + }, + "LabelColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

Determines the color of the data labels.

" + } + }, + "Overlap": { + "target": "com.amazonaws.quicksight#DataLabelOverlap", + "traits": { + "smithy.api#documentation": "

Determines whether overlap is enabled or disabled for the data labels.

" + } + }, + "TotalsVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines the visibility of the total.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the data labels.

" + } + }, + "com.amazonaws.quicksight#DataLabelOverlap": { + "type": "enum", + "members": { + "DISABLE_OVERLAP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLE_OVERLAP" + } + }, + "ENABLE_OVERLAP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLE_OVERLAP" + } + } + } + }, + "com.amazonaws.quicksight#DataLabelPosition": { + "type": "enum", + "members": { + "INSIDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSIDE" + } + }, + "OUTSIDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUTSIDE" + } + }, + "LEFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEFT" + } + }, + "TOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOP" + } + }, + "BOTTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTTOM" + } + }, + "RIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RIGHT" + } + } + } + }, + "com.amazonaws.quicksight#DataLabelType": { + "type": "structure", + "members": { + "FieldLabelType": { + "target": "com.amazonaws.quicksight#FieldLabelType", + "traits": { + "smithy.api#documentation": "

Determines the label configuration for the entire field.

" + } + }, + "DataPathLabelType": { + "target": "com.amazonaws.quicksight#DataPathLabelType", + "traits": { + "smithy.api#documentation": "

The option that specifies individual data values for labels.

" + } + }, + "RangeEndsLabelType": { + "target": "com.amazonaws.quicksight#RangeEndsLabelType", + "traits": { + "smithy.api#documentation": "

Determines the label configuration for range end value in a visual.

" + } + }, + "MinimumLabelType": { + "target": "com.amazonaws.quicksight#MinimumLabelType", + "traits": { + "smithy.api#documentation": "

Determines the label configuration for the minimum value in a visual.

" + } + }, + "MaximumLabelType": { + "target": "com.amazonaws.quicksight#MaximumLabelType", + "traits": { + "smithy.api#documentation": "

Determines the label configuration for the maximum value in a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The option that determines the data label type.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#DataLabelTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataLabelType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#DataPathColor": { + "type": "structure", + "members": { + "Element": { + "target": "com.amazonaws.quicksight#DataPathValue", + "traits": { + "smithy.api#documentation": "

The element that the color needs to be applied to.

", + "smithy.api#required": {} + } + }, + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color that needs to be applied to the element.

", + "smithy.api#required": {} + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The time granularity of the field that the color needs to be applied to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The color map that determines the color options for a particular element.

" + } + }, + "com.amazonaws.quicksight#DataPathColorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataPathColor" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5000 + } + } + }, + "com.amazonaws.quicksight#DataPathLabelType": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID of the field that the data label needs to be applied to.

" + } + }, + "FieldValue": { + "target": "com.amazonaws.quicksight#FieldValue", + "traits": { + "smithy.api#documentation": "

The actual value of the field that is labeled.

" + } + }, + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the data label.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The option that specifies individual data values for labels.

" + } + }, + "com.amazonaws.quicksight#DataPathSort": { + "type": "structure", + "members": { + "Direction": { + "target": "com.amazonaws.quicksight#SortDirection", + "traits": { + "smithy.api#documentation": "

Determines the sort direction.

", + "smithy.api#required": {} + } + }, + "SortPaths": { + "target": "com.amazonaws.quicksight#DataPathValueList", + "traits": { + "smithy.api#documentation": "

The list of data paths that need to be sorted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Allows data paths to be sorted by a specific data value.

" + } + }, + "com.amazonaws.quicksight#DataPathType": { + "type": "structure", + "members": { + "PivotTableDataPathType": { + "target": "com.amazonaws.quicksight#PivotTableDataPathType", + "traits": { + "smithy.api#documentation": "

The type of data path value utilized in a pivot table. Choose one of the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The type of the data path value.

" + } + }, + "com.amazonaws.quicksight#DataPathValue": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID of the field that needs to be sorted.

" + } + }, + "FieldValue": { + "target": "com.amazonaws.quicksight#FieldValue", + "traits": { + "smithy.api#documentation": "

The actual value of the field that needs to be sorted.

" + } + }, + "DataPathType": { + "target": "com.amazonaws.quicksight#DataPathType", + "traits": { + "smithy.api#documentation": "

The type configuration of the field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data path that needs to be sorted.

" + } + }, + "com.amazonaws.quicksight#DataPathValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataPathValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#DataPointDrillUpDownOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

The status of the drill down options of data points.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The drill down options for data points in a dashbaord.

" + } + }, + "com.amazonaws.quicksight#DataPointMenuLabelOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

The status of the data point menu options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data point menu options of a dashboard.

" + } + }, + "com.amazonaws.quicksight#DataPointTooltipOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

The status of the data point tool tip options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data point tooltip options.

" + } + }, + "com.amazonaws.quicksight#DataSet": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

A display name for the dataset.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that this dataset was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that this dataset was updated.

" + } + }, + "PhysicalTableMap": { + "target": "com.amazonaws.quicksight#PhysicalTableMap", + "traits": { + "smithy.api#documentation": "

Declares the physical tables that are available in the underlying data sources.

" + } + }, + "LogicalTableMap": { + "target": "com.amazonaws.quicksight#LogicalTableMap", + "traits": { + "smithy.api#documentation": "

Configures the combination and transformation of the data from the physical\n tables.

" + } + }, + "OutputColumns": { + "target": "com.amazonaws.quicksight#OutputColumnList", + "traits": { + "smithy.api#documentation": "

The list of columns after all transforms. These columns are available in templates,\n analyses, and dashboards.

" + } + }, + "ImportMode": { + "target": "com.amazonaws.quicksight#DataSetImportMode", + "traits": { + "smithy.api#documentation": "

A value that indicates whether you want to import the data into SPICE.

" + } + }, + "ConsumedSpiceCapacityInBytes": { + "target": "com.amazonaws.quicksight#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't\n imported into SPICE.

" + } + }, + "ColumnGroups": { + "target": "com.amazonaws.quicksight#ColumnGroupList", + "traits": { + "smithy.api#documentation": "

Groupings of columns that work together in certain Amazon QuickSight features.\n Currently, only geospatial hierarchy is supported.

" + } + }, + "FieldFolders": { + "target": "com.amazonaws.quicksight#FieldFolderMap", + "traits": { + "smithy.api#documentation": "

The folder that contains fields and nested subfolders for your dataset.

" + } + }, + "RowLevelPermissionDataSet": { + "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", + "traits": { + "smithy.api#documentation": "

The row-level security configuration for the dataset.

" + } + }, + "RowLevelPermissionTagConfiguration": { + "target": "com.amazonaws.quicksight#RowLevelPermissionTagConfiguration", + "traits": { + "smithy.api#documentation": "

The element you can use to define tags for row-level security.

" + } + }, + "ColumnLevelPermissionRules": { + "target": "com.amazonaws.quicksight#ColumnLevelPermissionRuleList", + "traits": { + "smithy.api#documentation": "

A set of one or more definitions of a \n ColumnLevelPermissionRule\n .

" + } + }, + "DataSetUsageConfiguration": { + "target": "com.amazonaws.quicksight#DataSetUsageConfiguration", + "traits": { + "smithy.api#documentation": "

The usage configuration to apply to child datasets that reference this dataset as a source.

" + } + }, + "DatasetParameters": { + "target": "com.amazonaws.quicksight#DatasetParameterList", + "traits": { + "smithy.api#documentation": "

The parameters that are declared in a dataset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Dataset.

" + } + }, + "com.amazonaws.quicksight#DataSetArnsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Arn" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#DataSetConfiguration": { + "type": "structure", + "members": { + "Placeholder": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

Placeholder.

" + } + }, + "DataSetSchema": { + "target": "com.amazonaws.quicksight#DataSetSchema", + "traits": { + "smithy.api#documentation": "

Dataset schema.

" + } + }, + "ColumnGroupSchemaList": { + "target": "com.amazonaws.quicksight#ColumnGroupSchemaList", + "traits": { + "smithy.api#documentation": "

A structure containing the list of column group schemas.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Dataset configuration.

" + } + }, + "com.amazonaws.quicksight#DataSetConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataSetConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30 + } + } + }, + "com.amazonaws.quicksight#DataSetFilterAttribute": { + "type": "enum", + "members": { + "QUICKSIGHT_VIEWER_OR_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_VIEWER_OR_OWNER" + } + }, + "QUICKSIGHT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_OWNER" + } + }, + "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" + } + }, + "DIRECT_QUICKSIGHT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_OWNER" + } + }, + "DIRECT_QUICKSIGHT_SOLE_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_SOLE_OWNER" + } + }, + "DATASET_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATASET_NAME" + } + } + } + }, + "com.amazonaws.quicksight#DataSetIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#DataSetIdentifierDeclaration": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.quicksight#DataSetIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the data set, typically the data set's name.

", + "smithy.api#required": {} + } + }, + "DataSetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data set.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A data set.

" + } + }, + "com.amazonaws.quicksight#DataSetIdentifierDeclarationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataSetIdentifierDeclaration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#DataSetImportMode": { + "type": "enum", + "members": { + "SPICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPICE" + } + }, + "DIRECT_QUERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUERY" + } + } + } + }, + "com.amazonaws.quicksight#DataSetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.quicksight#DataSetReference": { + "type": "structure", + "members": { + "DataSetPlaceholder": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Dataset placeholder.

", + "smithy.api#required": {} + } + }, + "DataSetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

Dataset Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Dataset reference.

" + } + }, + "com.amazonaws.quicksight#DataSetReferenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataSetReference" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.quicksight#DataSetRefreshProperties": { + "type": "structure", + "members": { + "RefreshConfiguration": { + "target": "com.amazonaws.quicksight#RefreshConfiguration", + "traits": { + "smithy.api#documentation": "

The refresh configuration for a dataset.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The refresh properties of a dataset.

" + } + }, + "com.amazonaws.quicksight#DataSetRegion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#DataSetSchema": { + "type": "structure", + "members": { + "ColumnSchemaList": { + "target": "com.amazonaws.quicksight#ColumnSchemaList", + "traits": { + "smithy.api#documentation": "

A structure containing the list of column schemas.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Dataset schema.

" + } + }, + "com.amazonaws.quicksight#DataSetSearchFilter": { + "type": "structure", + "members": { + "Operator": { + "target": "com.amazonaws.quicksight#FilterOperator", + "traits": { + "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\": \"StringEquals\". Valid values are \"StringEquals\" and \"StringLike\".

\n

If you set the operator value to \"StringEquals\", you need to provide an ownership related filter in the \"NAME\" field and the arn of the user or group whose datasets you want to search in the \"Value\" field. For example, \"Name\":\"QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east- 1:1:user/default/UserName1\".

\n

If you set the value to \"StringLike\", you need to provide the name of the datasets you are searching for. For example, \"Name\":\"DATASET_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\". The \"StringLike\" operator only supports the NAME value DATASET_NAME.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DataSetFilterAttribute", + "traits": { + "smithy.api#documentation": "

The name of the value that you want to use as a filter, for example, \"Name\":\n \"QUICKSIGHT_OWNER\".

\n

Valid values are defined as follows:

\n ", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The value of the named item, in this case QUICKSIGHT_OWNER, that you want\n to use as a filter, for example, \"Value\":\n \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter that you apply when searching for datasets.

" + } + }, + "com.amazonaws.quicksight#DataSetSearchFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataSetSearchFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#DataSetSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

A display name for the dataset.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that this dataset was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that this dataset was updated.

" + } + }, + "ImportMode": { + "target": "com.amazonaws.quicksight#DataSetImportMode", + "traits": { + "smithy.api#documentation": "

A value that indicates whether you want to import the data into SPICE.

" + } + }, + "RowLevelPermissionDataSet": { + "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", + "traits": { + "smithy.api#documentation": "

The row-level security configuration for the dataset.

" + } + }, + "RowLevelPermissionTagConfigurationApplied": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether or not the row level permission tags are applied.

" + } + }, + "ColumnLevelPermissionRulesApplied": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates if the dataset has column level permission configured.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Dataset summary.

" + } + }, + "com.amazonaws.quicksight#DataSetSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataSetSummary" + } + }, + "com.amazonaws.quicksight#DataSetUsageConfiguration": { + "type": "structure", + "members": { + "DisableUseAsDirectQuerySource": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

An option that controls whether a child dataset of a direct query can use this dataset as a source.

" + } + }, + "DisableUseAsImportedSource": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The usage configuration to apply to child datasets that reference this dataset as a source.

" + } + }, + "com.amazonaws.quicksight#DataSource": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each\n Amazon Web Services account.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

A display name for the data source.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#DataSourceType", + "traits": { + "smithy.api#documentation": "

The type of the data source. This type indicates which database engine the data source\n connects to.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The HTTP status of the request.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that this data source was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that this data source was updated.

" + } + }, + "DataSourceParameters": { + "target": "com.amazonaws.quicksight#DataSourceParameters", + "traits": { + "smithy.api#documentation": "

The parameters that Amazon QuickSight uses to connect to your underlying source. This\n is a variant type structure. For this structure to be valid, only one of the attributes\n can be non-null.

" + } + }, + "AlternateDataSourceParameters": { + "target": "com.amazonaws.quicksight#DataSourceParametersList", + "traits": { + "smithy.api#documentation": "

A set of alternate data source parameters that you want to share for the credentials\n stored with this data source. The credentials are applied in tandem with the data source\n parameters when you copy a data source by using a create or update request. The API\n operation compares the DataSourceParameters structure that's in the request\n with the structures in the AlternateDataSourceParameters allow list. If the\n structures are an exact match, the request is allowed to use the credentials from this\n existing data source. If the AlternateDataSourceParameters list is null,\n the Credentials originally used with this DataSourceParameters\n are automatically allowed.

" + } + }, + "VpcConnectionProperties": { + "target": "com.amazonaws.quicksight#VpcConnectionProperties", + "traits": { + "smithy.api#documentation": "

The VPC connection information. You need to use this parameter only when you want\n Amazon QuickSight to use a VPC connection when connecting to your underlying source.

" + } + }, + "SslProperties": { + "target": "com.amazonaws.quicksight#SslProperties", + "traits": { + "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your\n underlying source.

" + } + }, + "ErrorInfo": { + "target": "com.amazonaws.quicksight#DataSourceErrorInfo", + "traits": { + "smithy.api#documentation": "

Error information from the last update or the creation of the data source.

" + } + }, + "SecretArn": { + "target": "com.amazonaws.quicksight#SecretArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The structure of a data source.

" + } + }, + "com.amazonaws.quicksight#DataSourceCredentials": { + "type": "structure", + "members": { + "CredentialPair": { + "target": "com.amazonaws.quicksight#CredentialPair", + "traits": { + "smithy.api#documentation": "

Credential pair. For more information, see\n \n CredentialPair\n .

" + } + }, + "CopySourceArn": { + "target": "com.amazonaws.quicksight#CopySourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a data source that has the credential pair that you\n want to use. When CopySourceArn is not null, the credential pair from the\n data source in the ARN is used as the credentials for the\n DataSourceCredentials structure.

" + } + }, + "SecretArn": { + "target": "com.amazonaws.quicksight#SecretArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data source credentials. This is a variant type structure. For this structure to be\n valid, only one of the attributes can be non-null.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#DataSourceErrorInfo": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#DataSourceErrorInfoType", + "traits": { + "smithy.api#documentation": "

Error type.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

Error message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Error information for the data source creation or update.

" + } + }, + "com.amazonaws.quicksight#DataSourceErrorInfoType": { + "type": "enum", + "members": { + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_DENIED" + } + }, + "COPY_SOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COPY_SOURCE_NOT_FOUND" + } + }, + "TIMEOUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMEOUT" + } + }, + "ENGINE_VERSION_NOT_SUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENGINE_VERSION_NOT_SUPPORTED" + } + }, + "UNKNOWN_HOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN_HOST" + } + }, + "GENERIC_SQL_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GENERIC_SQL_FAILURE" + } + }, + "CONFLICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFLICT" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } + } + } + }, + "com.amazonaws.quicksight#DataSourceFilterAttribute": { + "type": "enum", + "members": { + "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" + } + }, + "DIRECT_QUICKSIGHT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_OWNER" + } + }, + "DIRECT_QUICKSIGHT_SOLE_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_SOLE_OWNER" + } + }, + "DATASOURCE_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATASOURCE_NAME" + } + } + } + }, + "com.amazonaws.quicksight#DataSourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataSource" + } + }, + "com.amazonaws.quicksight#DataSourceParameters": { + "type": "union", + "members": { + "AmazonElasticsearchParameters": { + "target": "com.amazonaws.quicksight#AmazonElasticsearchParameters", + "traits": { + "smithy.api#documentation": "

The parameters for OpenSearch.

" + } + }, + "AthenaParameters": { + "target": "com.amazonaws.quicksight#AthenaParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Amazon Athena.

" + } + }, + "AuroraParameters": { + "target": "com.amazonaws.quicksight#AuroraParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Amazon Aurora MySQL.

" + } + }, + "AuroraPostgreSqlParameters": { + "target": "com.amazonaws.quicksight#AuroraPostgreSqlParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Amazon Aurora.

" + } + }, + "AwsIotAnalyticsParameters": { + "target": "com.amazonaws.quicksight#AwsIotAnalyticsParameters", + "traits": { + "smithy.api#documentation": "

The parameters for IoT Analytics.

" + } + }, + "JiraParameters": { + "target": "com.amazonaws.quicksight#JiraParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Jira.

" + } + }, + "MariaDbParameters": { + "target": "com.amazonaws.quicksight#MariaDbParameters", + "traits": { + "smithy.api#documentation": "

The parameters for MariaDB.

" + } + }, + "MySqlParameters": { + "target": "com.amazonaws.quicksight#MySqlParameters", + "traits": { + "smithy.api#documentation": "

The parameters for MySQL.

" + } + }, + "OracleParameters": { + "target": "com.amazonaws.quicksight#OracleParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Oracle.

" + } + }, + "PostgreSqlParameters": { + "target": "com.amazonaws.quicksight#PostgreSqlParameters", + "traits": { + "smithy.api#documentation": "

The parameters for PostgreSQL.

" + } + }, + "PrestoParameters": { + "target": "com.amazonaws.quicksight#PrestoParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Presto.

" + } + }, + "RdsParameters": { + "target": "com.amazonaws.quicksight#RdsParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Amazon RDS.

" + } + }, + "RedshiftParameters": { + "target": "com.amazonaws.quicksight#RedshiftParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Amazon Redshift.

" + } + }, + "S3Parameters": { + "target": "com.amazonaws.quicksight#S3Parameters", + "traits": { + "smithy.api#documentation": "

The parameters for S3.

" + } + }, + "ServiceNowParameters": { + "target": "com.amazonaws.quicksight#ServiceNowParameters", + "traits": { + "smithy.api#documentation": "

The parameters for ServiceNow.

" + } + }, + "SnowflakeParameters": { + "target": "com.amazonaws.quicksight#SnowflakeParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Snowflake.

" + } + }, + "SparkParameters": { + "target": "com.amazonaws.quicksight#SparkParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Spark.

" + } + }, + "SqlServerParameters": { + "target": "com.amazonaws.quicksight#SqlServerParameters", + "traits": { + "smithy.api#documentation": "

The parameters for SQL Server.

" + } + }, + "TeradataParameters": { + "target": "com.amazonaws.quicksight#TeradataParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Teradata.

" + } + }, + "TwitterParameters": { + "target": "com.amazonaws.quicksight#TwitterParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Twitter.

" + } + }, + "AmazonOpenSearchParameters": { + "target": "com.amazonaws.quicksight#AmazonOpenSearchParameters", + "traits": { + "smithy.api#documentation": "

The parameters for OpenSearch.

" + } + }, + "ExasolParameters": { + "target": "com.amazonaws.quicksight#ExasolParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Exasol.

" + } + }, + "DatabricksParameters": { + "target": "com.amazonaws.quicksight#DatabricksParameters", + "traits": { + "smithy.api#documentation": "

The parameters that are required to connect to a Databricks data source.

" + } + }, + "StarburstParameters": { + "target": "com.amazonaws.quicksight#StarburstParameters", + "traits": { + "smithy.api#documentation": "

The parameters that are required to connect to a Starburst data source.

" + } + }, + "TrinoParameters": { + "target": "com.amazonaws.quicksight#TrinoParameters", + "traits": { + "smithy.api#documentation": "

The parameters that are required to connect to a Trino data source.

" + } + }, + "BigQueryParameters": { + "target": "com.amazonaws.quicksight#BigQueryParameters", + "traits": { + "smithy.api#documentation": "

The parameters that are required to connect to a Google BigQuery data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters that Amazon QuickSight uses to connect to your underlying data source.\n This is a variant type structure. For this structure to be valid, only one of the\n attributes can be non-null.

" + } + }, + "com.amazonaws.quicksight#DataSourceParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataSourceParameters" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#DataSourceSearchFilter": { + "type": "structure", + "members": { + "Operator": { + "target": "com.amazonaws.quicksight#FilterOperator", + "traits": { + "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\": \"StringEquals\". Valid values are \"StringEquals\" and \"StringLike\".

\n

If you set the operator value to \"StringEquals\", you need to provide an ownership related filter in the \"NAME\" field and the arn of the user or group whose data sources you want to search in the \"Value\" field. For example, \"Name\":\"DIRECT_QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

\n

If you set the value to \"StringLike\", you need to provide the name of the data sources you are searching for. For example, \"Name\":\"DATASOURCE_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\". The \"StringLike\" operator only supports the NAME value DATASOURCE_NAME.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DataSourceFilterAttribute", + "traits": { + "smithy.api#documentation": "

The name of the value that you want to use as a filter, for example, \"Name\":\n \"DIRECT_QUICKSIGHT_OWNER\".

\n

Valid values are defined as follows:

\n ", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The value of the named item, for example DIRECT_QUICKSIGHT_OWNER, that you want\n to use as a filter, for example, \"Value\":\n \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter that you apply when searching for data sources.

" + } + }, + "com.amazonaws.quicksight#DataSourceSearchFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataSourceSearchFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#DataSourceSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The arn of the datasource.

" + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The unique ID of the data source.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the data source.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#DataSourceType", + "traits": { + "smithy.api#documentation": "

The type of the data source.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A DataSourceSummary object that returns a summary of a data source.

" + } + }, + "com.amazonaws.quicksight#DataSourceSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataSourceSummary" + } + }, + "com.amazonaws.quicksight#DataSourceType": { + "type": "enum", + "members": { + "ADOBE_ANALYTICS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADOBE_ANALYTICS" + } + }, + "AMAZON_ELASTICSEARCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON_ELASTICSEARCH" + } + }, + "ATHENA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATHENA" + } + }, + "AURORA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AURORA" + } + }, + "AURORA_POSTGRESQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AURORA_POSTGRESQL" + } + }, + "AWS_IOT_ANALYTICS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_IOT_ANALYTICS" + } + }, + "GITHUB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GITHUB" + } + }, + "JIRA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JIRA" + } + }, + "MARIADB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MARIADB" + } + }, + "MYSQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MYSQL" + } + }, + "ORACLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORACLE" + } + }, + "POSTGRESQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSTGRESQL" + } + }, + "PRESTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRESTO" + } + }, + "REDSHIFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REDSHIFT" + } + }, + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + }, + "SALESFORCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SALESFORCE" + } + }, + "SERVICENOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICENOW" + } + }, + "SNOWFLAKE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNOWFLAKE" + } + }, + "SPARK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPARK" + } + }, + "SQLSERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQLSERVER" + } + }, + "TERADATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERADATA" + } + }, + "TWITTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TWITTER" + } + }, + "TIMESTREAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMESTREAM" + } + }, + "AMAZON_OPENSEARCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON_OPENSEARCH" + } + }, + "EXASOL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXASOL" + } + }, + "DATABRICKS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATABRICKS" + } + }, + "STARBURST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARBURST" + } + }, + "TRINO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRINO" + } + }, + "BIGQUERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIGQUERY" + } + } + } + }, + "com.amazonaws.quicksight#Database": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.quicksight#DatabaseGroup": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#DatabaseGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DatabaseGroup" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#DatabaseUser": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#DatabricksParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

The host name of the Databricks data source.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

The port for the Databricks data source.

", + "smithy.api#required": {} + } + }, + "SqlEndpointPath": { + "target": "com.amazonaws.quicksight#SqlEndpointPath", + "traits": { + "smithy.api#documentation": "

The HTTP path of the Databricks data source.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters that are required to connect to a Databricks data source.

" + } + }, + "com.amazonaws.quicksight#DatasetMetadata": { + "type": "structure", + "members": { + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

", + "smithy.api#required": {} + } + }, + "DatasetName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The name of the dataset.

" + } + }, + "DatasetDescription": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The description of the dataset.

" + } + }, + "DataAggregation": { + "target": "com.amazonaws.quicksight#DataAggregation", + "traits": { + "smithy.api#documentation": "

The definition of a data aggregation.

" + } + }, + "Filters": { + "target": "com.amazonaws.quicksight#TopicFilters", + "traits": { + "smithy.api#documentation": "

The list of filter definitions.

" + } + }, + "Columns": { + "target": "com.amazonaws.quicksight#TopicColumns", + "traits": { + "smithy.api#documentation": "

The list of column definitions.

" + } + }, + "CalculatedFields": { + "target": "com.amazonaws.quicksight#TopicCalculatedFields", + "traits": { + "smithy.api#documentation": "

The list of calculated field definitions.

" + } + }, + "NamedEntities": { + "target": "com.amazonaws.quicksight#TopicNamedEntities", + "traits": { + "smithy.api#documentation": "

The list of named entities definitions.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a dataset.

" + } + }, + "com.amazonaws.quicksight#DatasetParameter": { + "type": "structure", + "members": { + "StringDatasetParameter": { + "target": "com.amazonaws.quicksight#StringDatasetParameter", + "traits": { + "smithy.api#documentation": "

A string parameter that is created in the dataset.

" + } + }, + "DecimalDatasetParameter": { + "target": "com.amazonaws.quicksight#DecimalDatasetParameter", + "traits": { + "smithy.api#documentation": "

A decimal parameter that is created in the dataset.

" + } + }, + "IntegerDatasetParameter": { + "target": "com.amazonaws.quicksight#IntegerDatasetParameter", + "traits": { + "smithy.api#documentation": "

An integer parameter that is created in the dataset.

" + } + }, + "DateTimeDatasetParameter": { + "target": "com.amazonaws.quicksight#DateTimeDatasetParameter", + "traits": { + "smithy.api#documentation": "

A date time parameter that is created in the dataset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.

" + } + }, + "com.amazonaws.quicksight#DatasetParameterId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.quicksight#DatasetParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DatasetParameter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.quicksight#DatasetParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.quicksight#DatasetParameterValueType": { + "type": "enum", + "members": { + "MULTI_VALUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTI_VALUED" + } + }, + "SINGLE_VALUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_VALUED" + } + } + }, + "traits": { + "smithy.api#documentation": "

The value type of the parameter. The value type is used to validate the parameter before it is evaluated.

" + } + }, + "com.amazonaws.quicksight#Datasets": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DatasetMetadata" + } + }, + "com.amazonaws.quicksight#DateAggregationFunction": { + "type": "enum", + "members": { + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "DISTINCT_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTINCT_COUNT" + } + }, + "MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIN" + } + }, + "MAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX" + } + } + } + }, + "com.amazonaws.quicksight#DateAxisOptions": { + "type": "structure", + "members": { + "MissingDateVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines whether or not missing dates are displayed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine how a date axis is displayed.

" + } + }, + "com.amazonaws.quicksight#DateDimensionField": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The custom field ID.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that is used in the DateDimensionField.

", + "smithy.api#required": {} + } + }, + "DateGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The date granularity of the DateDimensionField. Choose one of the following options:

\n " + } + }, + "HierarchyId": { + "target": "com.amazonaws.quicksight#HierarchyId", + "traits": { + "smithy.api#documentation": "

The custom hierarchy ID.

" + } + }, + "FormatConfiguration": { + "target": "com.amazonaws.quicksight#DateTimeFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The format configuration of the field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The dimension type field with date type columns.

" + } + }, + "com.amazonaws.quicksight#DateMeasureField": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The custom field ID.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that is used in the DateMeasureField.

", + "smithy.api#required": {} + } + }, + "AggregationFunction": { + "target": "com.amazonaws.quicksight#DateAggregationFunction", + "traits": { + "smithy.api#documentation": "

The aggregation function of the measure field.

" + } + }, + "FormatConfiguration": { + "target": "com.amazonaws.quicksight#DateTimeFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The format configuration of the field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The measure type field with date type columns.

" + } + }, + "com.amazonaws.quicksight#DateTimeDatasetParameter": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.quicksight#DatasetParameterId", + "traits": { + "smithy.api#documentation": "

An identifier for the parameter that is created in the dataset.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DatasetParameterName", + "traits": { + "smithy.api#documentation": "

The name of the date time parameter that is created in the dataset.

", + "smithy.api#required": {} + } + }, + "ValueType": { + "target": "com.amazonaws.quicksight#DatasetParameterValueType", + "traits": { + "smithy.api#documentation": "

The value type of the dataset parameter. Valid values are single value or multi value.

", + "smithy.api#required": {} + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The time granularity of the date time parameter.

" + } + }, + "DefaultValues": { + "target": "com.amazonaws.quicksight#DateTimeDatasetParameterDefaultValues", + "traits": { + "smithy.api#documentation": "

A list of default values for a given date time parameter. This structure only accepts static values.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A date time parameter for a dataset.

" + } + }, + "com.amazonaws.quicksight#DateTimeDatasetParameterDefaultValue": { + "type": "timestamp", + "traits": { + "smithy.api#documentation": "

The default value for the date time parameter.

" + } + }, + "com.amazonaws.quicksight#DateTimeDatasetParameterDefaultValues": { + "type": "structure", + "members": { + "StaticValues": { + "target": "com.amazonaws.quicksight#DateTimeDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "

A list of static default values for a given date time parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default values of a date time parameter.

" + } + }, + "com.amazonaws.quicksight#DateTimeDatasetParameterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DateTimeDatasetParameterDefaultValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.quicksight#DateTimeDefaultValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SensitiveTimestamp" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50000 + } + } + }, + "com.amazonaws.quicksight#DateTimeDefaultValues": { + "type": "structure", + "members": { + "DynamicValue": { + "target": "com.amazonaws.quicksight#DynamicDefaultValue", + "traits": { + "smithy.api#documentation": "

The dynamic value of the DataTimeDefaultValues. Different defaults are displayed according to users, groups, and values mapping.

" + } + }, + "StaticValues": { + "target": "com.amazonaws.quicksight#DateTimeDefaultValueList", + "traits": { + "smithy.api#documentation": "

The static values of the DataTimeDefaultValues.

" + } + }, + "RollingDate": { + "target": "com.amazonaws.quicksight#RollingDateConfiguration", + "traits": { + "smithy.api#documentation": "

The rolling date of the DataTimeDefaultValues. The date is determined from the dataset based on input expression.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default values of the DateTimeParameterDeclaration.

" + } + }, + "com.amazonaws.quicksight#DateTimeFormat": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.quicksight#DateTimeFormatConfiguration": { + "type": "structure", + "members": { + "DateTimeFormat": { + "target": "com.amazonaws.quicksight#DateTimeFormat", + "traits": { + "smithy.api#documentation": "

Determines the DateTime format.

" + } + }, + "NullValueFormatConfiguration": { + "target": "com.amazonaws.quicksight#NullValueFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the null value format configuration.

" + } + }, + "NumericFormatConfiguration": { + "target": "com.amazonaws.quicksight#NumericFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The formatting configuration for numeric DateTime fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Formatting configuration for DateTime fields.

" + } + }, + "com.amazonaws.quicksight#DateTimeHierarchy": { + "type": "structure", + "members": { + "HierarchyId": { + "target": "com.amazonaws.quicksight#HierarchyId", + "traits": { + "smithy.api#documentation": "

The hierarchy ID of the DateTime hierarchy.

", + "smithy.api#required": {} + } + }, + "DrillDownFilters": { + "target": "com.amazonaws.quicksight#DrillDownFilterList", + "traits": { + "smithy.api#documentation": "

The option that determines the drill down filters for the\n DateTime hierarchy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The option that determines the hierarchy of any DateTime fields.

" + } + }, + "com.amazonaws.quicksight#DateTimeParameter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A display name for the date-time parameter.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.quicksight#SensitiveTimestampList", + "traits": { + "smithy.api#documentation": "

The values for the date-time parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A date-time parameter.

" + } + }, + "com.amazonaws.quicksight#DateTimeParameterDeclaration": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The name of the parameter that is being declared.

", + "smithy.api#required": {} + } + }, + "DefaultValues": { + "target": "com.amazonaws.quicksight#DateTimeDefaultValues", + "traits": { + "smithy.api#documentation": "

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

" + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" + } + }, + "ValueWhenUnset": { + "target": "com.amazonaws.quicksight#DateTimeValueWhenUnsetConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that defines the default value of a DateTime parameter when a value has not been set.

" + } + }, + "MappedDataSetParameters": { + "target": "com.amazonaws.quicksight#MappedDataSetParameters" + } + }, + "traits": { + "smithy.api#documentation": "

A parameter declaration for the DateTime data type.

" + } + }, + "com.amazonaws.quicksight#DateTimeParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DateTimeParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#DateTimePickerControlDisplayOptions": { + "type": "structure", + "members": { + "TitleOptions": { + "target": "com.amazonaws.quicksight#LabelOptions", + "traits": { + "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" + } + }, + "DateTimeFormat": { + "target": "com.amazonaws.quicksight#DateTimeFormat", + "traits": { + "smithy.api#documentation": "

Customize how dates are formatted in controls.

" + } + }, + "InfoIconLabelOptions": { + "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", + "traits": { + "smithy.api#documentation": "

The configuration of info icon label options.

" + } + }, + "HelperTextVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The helper text visibility of the DateTimePickerControlDisplayOptions.

" + } + }, + "DateIconVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The date icon visibility of the DateTimePickerControlDisplayOptions.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "com.amazonaws.quicksight#DateTimeValueWhenUnsetConfiguration": { + "type": "structure", + "members": { + "ValueWhenUnsetOption": { + "target": "com.amazonaws.quicksight#ValueWhenUnsetOption", + "traits": { + "smithy.api#documentation": "

The built-in options for default values. The value can be one of the following:

\n " + } + }, + "CustomValue": { + "target": "com.amazonaws.quicksight#SensitiveTimestamp", + "traits": { + "smithy.api#documentation": "

A custom value that's used when the value of a parameter isn't set.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration that defines the default value of a DateTime parameter when a value has not been set.

" + } + }, + "com.amazonaws.quicksight#DayOfMonth": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 17 + }, + "smithy.api#pattern": "^(?:LAST_DAY_OF_MONTH|1[0-9]|2[0-8]|[12]|[3-9])$" + } + }, + "com.amazonaws.quicksight#DayOfTheWeek": { + "type": "enum", + "members": { + "SUNDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUNDAY" + } + }, + "MONDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONDAY" + } + }, + "TUESDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TUESDAY" + } + }, + "WEDNESDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEDNESDAY" + } + }, + "THURSDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THURSDAY" + } + }, + "FRIDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FRIDAY" + } + }, + "SATURDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SATURDAY" + } + } + } + }, + "com.amazonaws.quicksight#DayOfWeek": { + "type": "enum", + "members": { + "SUNDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUNDAY" + } + }, + "MONDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONDAY" + } + }, + "TUESDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TUESDAY" + } + }, + "WEDNESDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEDNESDAY" + } + }, + "THURSDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THURSDAY" + } + }, + "FRIDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FRIDAY" + } + }, + "SATURDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SATURDAY" + } + } + } + }, + "com.amazonaws.quicksight#DbUsername": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#DecimalDatasetParameter": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.quicksight#DatasetParameterId", + "traits": { + "smithy.api#documentation": "

An identifier for the decimal parameter created in the dataset.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DatasetParameterName", + "traits": { + "smithy.api#documentation": "

The name of the decimal parameter that is created in the dataset.

", + "smithy.api#required": {} + } + }, + "ValueType": { + "target": "com.amazonaws.quicksight#DatasetParameterValueType", + "traits": { + "smithy.api#documentation": "

The value type of the dataset parameter. Valid values are single value or multi value.

", + "smithy.api#required": {} + } + }, + "DefaultValues": { + "target": "com.amazonaws.quicksight#DecimalDatasetParameterDefaultValues", + "traits": { + "smithy.api#documentation": "

A list of default values for a given decimal parameter. This structure only accepts static values.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A decimal parameter for a dataset.

" + } + }, + "com.amazonaws.quicksight#DecimalDatasetParameterDefaultValue": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The default value for the decimal parameter.

" + } + }, + "com.amazonaws.quicksight#DecimalDatasetParameterDefaultValues": { + "type": "structure", + "members": { + "StaticValues": { + "target": "com.amazonaws.quicksight#DecimalDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "

A list of static default values for a given decimal parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default values of a decimal parameter.

" + } + }, + "com.amazonaws.quicksight#DecimalDatasetParameterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DecimalDatasetParameterDefaultValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.quicksight#DecimalDefaultValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SensitiveDoubleObject" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50000 + } + } + }, + "com.amazonaws.quicksight#DecimalDefaultValues": { + "type": "structure", + "members": { + "DynamicValue": { + "target": "com.amazonaws.quicksight#DynamicDefaultValue", + "traits": { + "smithy.api#documentation": "

The dynamic value of the DecimalDefaultValues. Different defaults are displayed according to users, groups, and values mapping.

" + } + }, + "StaticValues": { + "target": "com.amazonaws.quicksight#DecimalDefaultValueList", + "traits": { + "smithy.api#documentation": "

The static values of the DecimalDefaultValues.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default values of the DecimalParameterDeclaration.

" + } + }, + "com.amazonaws.quicksight#DecimalParameter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A display name for the decimal parameter.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.quicksight#SensitiveDoubleList", + "traits": { + "smithy.api#documentation": "

The values for the decimal parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A decimal parameter.

" + } + }, + "com.amazonaws.quicksight#DecimalParameterDeclaration": { + "type": "structure", + "members": { + "ParameterValueType": { + "target": "com.amazonaws.quicksight#ParameterValueType", + "traits": { + "smithy.api#documentation": "

The value type determines whether the parameter is a single-value or multi-value parameter.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The name of the parameter that is being declared.

", + "smithy.api#required": {} + } + }, + "DefaultValues": { + "target": "com.amazonaws.quicksight#DecimalDefaultValues", + "traits": { + "smithy.api#documentation": "

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

" + } + }, + "ValueWhenUnset": { + "target": "com.amazonaws.quicksight#DecimalValueWhenUnsetConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that defines the default value of a Decimal parameter when a value has not been set.

" + } + }, + "MappedDataSetParameters": { + "target": "com.amazonaws.quicksight#MappedDataSetParameters" + } + }, + "traits": { + "smithy.api#documentation": "

A parameter declaration for the Decimal data type.

" + } + }, + "com.amazonaws.quicksight#DecimalParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DecimalParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#DecimalPlaces": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#DecimalPlacesConfiguration": { + "type": "structure", + "members": { + "DecimalPlaces": { + "target": "com.amazonaws.quicksight#DecimalPlaces", + "traits": { + "smithy.api#documentation": "

The values of the decimal places.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The option that determines the decimal places configuration.

" + } + }, + "com.amazonaws.quicksight#DecimalValueWhenUnsetConfiguration": { + "type": "structure", + "members": { + "ValueWhenUnsetOption": { + "target": "com.amazonaws.quicksight#ValueWhenUnsetOption", + "traits": { + "smithy.api#documentation": "

The built-in options for default values. The value can be one of the following:

\n " + } + }, + "CustomValue": { + "target": "com.amazonaws.quicksight#SensitiveDouble", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

A custom value that's used when the value of a parameter isn't set.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration that defines the default value of a Decimal parameter when a value has not been set.

" + } + }, + "com.amazonaws.quicksight#DefaultAggregation": { + "type": "enum", + "members": { + "SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM" + } + }, + "MAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX" + } + }, + "MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIN" + } + }, + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "DISTINCT_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTINCT_COUNT" + } + }, + "AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVERAGE" + } + }, + "MEDIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIAN" + } + }, + "STDEV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEV" + } + }, + "STDEVP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEVP" + } + }, + "VAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VAR" + } + }, + "VARP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARP" + } + } + } + }, + "com.amazonaws.quicksight#DefaultDateTimePickerControlOptions": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#SheetControlDateTimePickerType", + "traits": { + "smithy.api#documentation": "

The date time picker type of the DefaultDateTimePickerControlOptions. Choose one of the following options:

\n " + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#DateTimePickerControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default options that correspond to the filter control type of a DateTimePicker.

" + } + }, + "com.amazonaws.quicksight#DefaultFilterControlConfiguration": { + "type": "structure", + "members": { + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the DefaultFilterControlConfiguration. This title is shared by all controls that are tied to this filter.

", + "smithy.api#required": {} + } + }, + "ControlOptions": { + "target": "com.amazonaws.quicksight#DefaultFilterControlOptions", + "traits": { + "smithy.api#documentation": "

The control option for the DefaultFilterControlConfiguration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The default configuration for all dependent controls of the filter.

" + } + }, + "com.amazonaws.quicksight#DefaultFilterControlOptions": { + "type": "structure", + "members": { + "DefaultDateTimePickerOptions": { + "target": "com.amazonaws.quicksight#DefaultDateTimePickerControlOptions", + "traits": { + "smithy.api#documentation": "

The default options that correspond to the filter control type of a DateTimePicker.

" + } + }, + "DefaultListOptions": { + "target": "com.amazonaws.quicksight#DefaultFilterListControlOptions", + "traits": { + "smithy.api#documentation": "

The default options that correspond to the List filter control type.

" + } + }, + "DefaultDropdownOptions": { + "target": "com.amazonaws.quicksight#DefaultFilterDropDownControlOptions", + "traits": { + "smithy.api#documentation": "

The default options that correspond to the Dropdown filter control type.

" + } + }, + "DefaultTextFieldOptions": { + "target": "com.amazonaws.quicksight#DefaultTextFieldControlOptions", + "traits": { + "smithy.api#documentation": "

The default options that correspond to the TextField filter control type.

" + } + }, + "DefaultTextAreaOptions": { + "target": "com.amazonaws.quicksight#DefaultTextAreaControlOptions", + "traits": { + "smithy.api#documentation": "

The default options that correspond to the TextArea filter control type.

" + } + }, + "DefaultSliderOptions": { + "target": "com.amazonaws.quicksight#DefaultSliderControlOptions", + "traits": { + "smithy.api#documentation": "

The default options that correspond to the Slider filter control type.

" + } + }, + "DefaultRelativeDateTimeOptions": { + "target": "com.amazonaws.quicksight#DefaultRelativeDateTimeControlOptions", + "traits": { + "smithy.api#documentation": "

The default options that correspond to the RelativeDateTime filter control type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The option that corresponds to the control type of the filter.

" + } + }, + "com.amazonaws.quicksight#DefaultFilterDropDownControlOptions": { + "type": "structure", + "members": { + "DisplayOptions": { + "target": "com.amazonaws.quicksight#DropDownControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#SheetControlListType", + "traits": { + "smithy.api#documentation": "

The type of the FilterDropDownControl. Choose one of the following options:

\n " + } + }, + "SelectableValues": { + "target": "com.amazonaws.quicksight#FilterSelectableValues", + "traits": { + "smithy.api#documentation": "

A list of selectable values that are used in a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default options that correspond to the Dropdown filter control type.

" + } + }, + "com.amazonaws.quicksight#DefaultFilterListControlOptions": { + "type": "structure", + "members": { + "DisplayOptions": { + "target": "com.amazonaws.quicksight#ListControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#SheetControlListType", + "traits": { + "smithy.api#documentation": "

The type of the DefaultFilterListControlOptions. Choose one of the following options:

\n " + } + }, + "SelectableValues": { + "target": "com.amazonaws.quicksight#FilterSelectableValues", + "traits": { + "smithy.api#documentation": "

A list of selectable values that are used in a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default options that correspond to the List filter control type.

" + } + }, + "com.amazonaws.quicksight#DefaultFormatting": { + "type": "structure", + "members": { + "DisplayFormat": { + "target": "com.amazonaws.quicksight#DisplayFormat", + "traits": { + "smithy.api#documentation": "

The display format. Valid values for this structure are AUTO,\n PERCENT, CURRENCY, NUMBER, DATE, and\n STRING.

" + } + }, + "DisplayFormatOptions": { + "target": "com.amazonaws.quicksight#DisplayFormatOptions", + "traits": { + "smithy.api#documentation": "

The additional options for display formatting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a default formatting definition.

" + } + }, + "com.amazonaws.quicksight#DefaultFreeFormLayoutConfiguration": { + "type": "structure", + "members": { + "CanvasSizeOptions": { + "target": "com.amazonaws.quicksight#FreeFormLayoutCanvasSizeOptions", + "traits": { + "smithy.api#documentation": "

Determines the screen canvas size options for a free-form layout.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the default settings of a free-form layout configuration.

" + } + }, + "com.amazonaws.quicksight#DefaultGridLayoutConfiguration": { + "type": "structure", + "members": { + "CanvasSizeOptions": { + "target": "com.amazonaws.quicksight#GridLayoutCanvasSizeOptions", + "traits": { + "smithy.api#documentation": "

Determines the screen canvas size options for a grid layout.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the default settings for a grid layout configuration.

" + } + }, + "com.amazonaws.quicksight#DefaultInteractiveLayoutConfiguration": { + "type": "structure", + "members": { + "Grid": { + "target": "com.amazonaws.quicksight#DefaultGridLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the default settings for a grid layout configuration.

" + } + }, + "FreeForm": { + "target": "com.amazonaws.quicksight#DefaultFreeFormLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the default settings of a free-form layout configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the default settings for interactive layout configuration.

" + } + }, + "com.amazonaws.quicksight#DefaultNewSheetConfiguration": { + "type": "structure", + "members": { + "InteractiveLayoutConfiguration": { + "target": "com.amazonaws.quicksight#DefaultInteractiveLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the default settings for interactive layout configuration.

" + } + }, + "PaginatedLayoutConfiguration": { + "target": "com.amazonaws.quicksight#DefaultPaginatedLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the default settings for a paginated layout configuration.

" + } + }, + "SheetContentType": { + "target": "com.amazonaws.quicksight#SheetContentType", + "traits": { + "smithy.api#documentation": "

The option that determines the sheet content type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for default new sheet settings.

" + } + }, + "com.amazonaws.quicksight#DefaultPaginatedLayoutConfiguration": { + "type": "structure", + "members": { + "SectionBased": { + "target": "com.amazonaws.quicksight#DefaultSectionBasedLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the default settings for a section-based layout configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the default settings for a paginated layout configuration.

" + } + }, + "com.amazonaws.quicksight#DefaultRelativeDateTimeControlOptions": { + "type": "structure", + "members": { + "DisplayOptions": { + "target": "com.amazonaws.quicksight#RelativeDateTimeControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default options that correspond to the RelativeDateTime filter control type.

" + } + }, + "com.amazonaws.quicksight#DefaultSectionBasedLayoutConfiguration": { + "type": "structure", + "members": { + "CanvasSizeOptions": { + "target": "com.amazonaws.quicksight#SectionBasedLayoutCanvasSizeOptions", + "traits": { + "smithy.api#documentation": "

Determines the screen canvas size options for a section-based layout.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the default settings for a section-based layout configuration.

" + } + }, + "com.amazonaws.quicksight#DefaultSliderControlOptions": { + "type": "structure", + "members": { + "DisplayOptions": { + "target": "com.amazonaws.quicksight#SliderControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#SheetControlSliderType", + "traits": { + "smithy.api#documentation": "

The type of the DefaultSliderControlOptions. Choose one of the following options:

\n " + } + }, + "MaximumValue": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The larger value that is displayed at the right of the slider.

", + "smithy.api#required": {} + } + }, + "MinimumValue": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The smaller value that is displayed at the left of the slider.

", + "smithy.api#required": {} + } + }, + "StepSize": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of increments that the slider bar is divided into.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The default options that correspond to the Slider filter control type.

" + } + }, + "com.amazonaws.quicksight#DefaultTextAreaControlOptions": { + "type": "structure", + "members": { + "Delimiter": { + "target": "com.amazonaws.quicksight#TextAreaControlDelimiter", + "traits": { + "smithy.api#documentation": "

The delimiter that is used to separate the lines in text.

" + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#TextAreaControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default options that correspond to the TextArea filter control type.

" + } + }, + "com.amazonaws.quicksight#DefaultTextFieldControlOptions": { + "type": "structure", + "members": { + "DisplayOptions": { + "target": "com.amazonaws.quicksight#TextFieldControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default options that correspond to the TextField filter control type.

" + } + }, + "com.amazonaws.quicksight#DeleteAccountCustomization": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteAccountCustomizationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteAccountCustomizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified\n Amazon Web Services account and Amazon QuickSight namespace.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/customizations", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteAccountCustomizationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in\n this Amazon Web Services Region.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight namespace that you're deleting the customizations from.

", + "smithy.api#httpQuery": "namespace" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteAccountCustomizationResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteAccountSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteAccountSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteAccountSubscriptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Use the DeleteAccountSubscription operation to delete an Amazon QuickSight account. This operation will result in an error message if you have configured your account termination protection settings to True. To change this setting and delete your account, call the UpdateAccountSettings API and set the value of the TerminationProtectionEnabled parameter to False, then make another call to the DeleteAccountSubscription API.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/account/{AwsAccountId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteAccountSubscriptionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the account that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteAccountSubscriptionResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteAnalysisResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during\n which you can restore the analysis. If you don't specify a recovery window value, the\n operation defaults to 30 days. Amazon QuickSight attaches a DeletionTime stamp to\n the response that specifies the end of the recovery window. At the end of the recovery\n window, Amazon QuickSight deletes the analysis permanently.

\n

At any time before recovery window ends, you can use the RestoreAnalysis\n API operation to remove the DeletionTime stamp and cancel the deletion of\n the analysis. The analysis remains visible in the API until it's deleted, so you can\n describe it but you can't make a template from it.

\n

An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console.\n To access it in the console, restore it. Deleting an analysis doesn't delete the\n dashboards that you publish from it.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteAnalysisRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account where you want to delete an analysis.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis that you're deleting.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RecoveryWindowInDays": { + "target": "com.amazonaws.quicksight#RecoveryWindowInDays", + "traits": { + "smithy.api#documentation": "

A value that specifies the number of days that Amazon QuickSight waits before it deletes the\n analysis. You can't use this parameter with the ForceDeleteWithoutRecovery\n option in the same API call. The default value is 30.

", + "smithy.api#httpQuery": "recovery-window-in-days" + } + }, + "ForceDeleteWithoutRecovery": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

This option defaults to the value NoForceDeleteWithoutRecovery. To\n immediately delete the analysis, add the ForceDeleteWithoutRecovery option.\n You can't restore an analysis after it's deleted.

", + "smithy.api#httpQuery": "force-delete-without-recovery" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteAnalysisResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deleted analysis.

" + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the deleted analysis.

" + } + }, + "DeletionTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the analysis is scheduled to be deleted.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteDashboard": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteDashboardRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteDashboardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a dashboard.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteDashboardRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're\n deleting.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the dashboard. If the version number property is provided, only\n the specified version of the dashboard is deleted.

", + "smithy.api#httpQuery": "version-number" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteDashboardResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Secure Socket Layer (SSL) properties that apply for the resource.

" + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dashboard.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteDataSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteDataSetRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteDataSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a dataset.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteDataSetRefreshProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteDataSetRefreshPropertiesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteDataSetRefreshPropertiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the dataset refresh properties of the dataset.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteDataSetRefreshPropertiesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteDataSetRefreshPropertiesResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteDataSetRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteDataSetResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the data source permanently. This operation breaks \n\t\t\tall the datasets that reference the deleted data source.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteDataSourceRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteDataSourceResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source that you deleted.

" + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteFolder": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteFolderRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteFolderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an empty folder.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteFolderMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteFolderMembershipRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteFolderMembershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes an asset, such as a dashboard, analysis, or dataset, from a folder.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteFolderMembershipRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The Folder ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MemberId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the asset that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MemberType": { + "target": "com.amazonaws.quicksight#MemberType", + "traits": { + "smithy.api#documentation": "

The member type of the asset that you want to delete from a folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteFolderMembershipResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteFolderRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteFolderResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name of the deleted folder.

" + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteGroupRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a user group from Amazon QuickSight.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteGroupMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteGroupMembershipRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteGroupMembershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a user from a group so that the user is no longer a member of the group.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteGroupMembershipRequest": { + "type": "structure", + "members": { + "MemberName": { + "target": "com.amazonaws.quicksight#GroupMemberName", + "traits": { + "smithy.api#documentation": "

The name of the user that you want to delete from the group membership.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group that you want to delete the user from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the group that you want to remove a user from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteGroupMembershipResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteGroupRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the group that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteGroupResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteIAMPolicyAssignment": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteIAMPolicyAssignmentRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteIAMPolicyAssignmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConcurrentUpdatingException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing IAM policy assignment.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/namespace/{Namespace}/iam-policy-assignments/{AssignmentName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteIAMPolicyAssignmentRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID where you want to delete the IAM\n\t\t\tpolicy assignment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "traits": { + "smithy.api#documentation": "

The name of the assignment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that contains the assignment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteIAMPolicyAssignmentResponse": { + "type": "structure", + "members": { + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "traits": { + "smithy.api#documentation": "

The name of the assignment.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteIdentityPropagationConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteIdentityPropagationConfigRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteIdentityPropagationConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application.

\n

This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/identity-propagation-config/{Service}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteIdentityPropagationConfigRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that you want to delete an identity propagation configuration from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Service": { + "target": "com.amazonaws.quicksight#ServiceType", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Web Services service that you want to delete the associated access scopes and authorized targets from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteIdentityPropagationConfigResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteNamespaceRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteNamespaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a namespace and the users and groups that are associated with the namespace.\n This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not \n deleted. To delete these assets, you use the API operations for the relevant asset.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteNamespaceRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteNamespaceResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a refresh schedule from a dataset.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteRefreshScheduleRequest": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the refresh schedule.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteRefreshScheduleResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the refresh schedule.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the refresh schedule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteRoleCustomPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteRoleCustomPermissionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteRoleCustomPermissionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes custom permissions from the role.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteRoleCustomPermissionRequest": { + "type": "structure", + "members": { + "Role": { + "target": "com.amazonaws.quicksight#Role", + "traits": { + "smithy.api#documentation": "

The role that you want to remove permissions from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n Amazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that includes the role.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteRoleCustomPermissionResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteRoleMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteRoleMembershipRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteRoleMembershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a group from a role.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members/{MemberName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteRoleMembershipRequest": { + "type": "structure", + "members": { + "MemberName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Role": { + "target": "com.amazonaws.quicksight#Role", + "traits": { + "smithy.api#documentation": "

The role that you want to remove permissions from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that contains the role.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteRoleMembershipResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteTemplateRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a template.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteTemplateAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteTemplateAliasRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteTemplateAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the item that the specified template alias points to. If you provide a specific\n\t\t\talias, you delete the version of the template that the alias points to.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteTemplateAliasRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the item to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template that the specified alias is for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The name for the template alias. To delete a specific alias, you delete the version that the\n\t\t\talias points to. You can specify the alias name, or specify the latest version of the\n\t\t\ttemplate by providing the keyword $LATEST in the AliasName\n\t\t\tparameter.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteTemplateAliasResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the template associated with the deletion.

" + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The name for the template alias.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template you want to delete.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteTemplateRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template that you're deleting.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the template you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

Specifies the version of the template that you want to delete.\n\t\t\tIf you don't provide a version number, DeleteTemplate deletes all versions of the template.\n\t

", + "smithy.api#httpQuery": "version-number" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteTemplateResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the template.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteTheme": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteThemeRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteThemeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a theme.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteThemeAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteThemeAliasRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteThemeAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the version of the theme that the specified theme alias points to. \n\t\t\tIf you provide a specific alias, you delete the version of the theme \n\t\t\tthat the alias points to.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteThemeAliasRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme alias to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme that the specified alias is for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The unique name for the theme alias to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteThemeAliasResponse": { + "type": "structure", + "members": { + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The name for the theme alias.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme resource using the deleted alias.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the theme associated with the deletion.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteThemeRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme that you're deleting.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the theme that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version of the theme that you want to delete.

\n

\n Note: If you don't provide a version number, you're\n\t\t\tusing this call to DeleteTheme to delete all versions of the theme.

", + "smithy.api#httpQuery": "version-number" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteThemeResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the theme.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteTopic": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteTopicRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteTopicResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a topic.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteTopicRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteTopicRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteTopicRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a topic refresh schedule.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules/{DatasetId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteTopicRefreshScheduleRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DatasetId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteTopicRefreshScheduleResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteTopicRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic that you want to\n delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteTopicResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteUserRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the Amazon QuickSight user that is associated with the identity of the\n\t\t\tIAM user or role that's making the call. The IAM user\n\t\t\tisn't deleted as a result of this call.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteUserByPrincipalId": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteUserByPrincipalIdRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteUserByPrincipalIdResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a user identified by its principal ID.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/user-principals/{PrincipalId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteUserByPrincipalIdRequest": { + "type": "structure", + "members": { + "PrincipalId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The principal ID of the user.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteUserByPrincipalIdResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteUserRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.quicksight#UserName", + "traits": { + "smithy.api#documentation": "

The name of the user that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteUserResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteVPCConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteVPCConnectionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteVPCConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a VPC connection.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteVPCConnectionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the account where you want to delete a VPC\n\t\t\tconnection.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", + "traits": { + "smithy.api#documentation": "

The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an\n\t\t\t\tAmazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteVPCConnectionResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deleted VPC connection.

" + } + }, + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", + "traits": { + "smithy.api#documentation": "

The ID of the VPC connection that\n\t\t\tyou're creating. This ID is a unique identifier for each Amazon Web Services Region in an\n\t\t\t\tAmazon Web Services account.

" + } + }, + "DeletionStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", + "traits": { + "smithy.api#documentation": "

The deletion status of the VPC connection.

" + } + }, + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", + "traits": { + "smithy.api#documentation": "

The availability status of the VPC connection.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#Delimiter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#DescribeAccountCustomization": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeAccountCustomizationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeAccountCustomizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the customizations associated with the provided Amazon Web Services account and Amazon\n Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which\n customizations to apply by running this API operation with the Resolved flag\n included.

\n

To determine what customizations display when you run this command, it can help to\n visualize the relationship of the entities involved.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/customizations", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeAccountCustomizationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations\n for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations\n for.

", + "smithy.api#httpQuery": "namespace" + } + }, + "Resolved": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The Resolved flag works with the other parameters to determine which view\n of Amazon QuickSight customizations is returned. You can add this flag to your command to use\n the same view that Amazon QuickSight uses to identify which customizations to apply to the\n console. Omit this flag, or set it to no-resolved, to reveal customizations\n that are configured at different levels.

", + "smithy.api#httpQuery": "resolved" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeAccountCustomizationResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customization that's associated with this Amazon Web Services account.

" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you're describing.

" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight namespace that you're describing.

" + } + }, + "AccountCustomization": { + "target": "com.amazonaws.quicksight#AccountCustomization", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight customizations that exist in the current Amazon Web Services Region.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeAccountSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeAccountSettingsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeAccountSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the settings that were used when your Amazon QuickSight subscription was first\n created in this Amazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/settings", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeAccountSettingsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the settings that you want to list.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeAccountSettingsResponse": { + "type": "structure", + "members": { + "AccountSettings": { + "target": "com.amazonaws.quicksight#AccountSettings", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight settings for this Amazon Web Services account. This information\n includes the edition of Amazon Amazon QuickSight that you subscribed to (Standard or\n Enterprise) and the notification email for the Amazon QuickSight subscription.

\n

In the QuickSight console, the Amazon QuickSight subscription is sometimes referred to\n as a QuickSight \"account\" even though it's technically not an account by\n itself. Instead, it's a subscription to the Amazon QuickSight service for your\n Amazon Web Services account. The edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region where you use it.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeAccountSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeAccountSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeAccountSubscriptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.

", + "smithy.api#http": { + "method": "GET", + "uri": "/account/{AwsAccountId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeAccountSubscriptionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeAccountSubscriptionResponse": { + "type": "structure", + "members": { + "AccountInfo": { + "target": "com.amazonaws.quicksight#AccountInfo", + "traits": { + "smithy.api#documentation": "

A structure that contains the following elements:

\n " + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeAnalysisResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a summary of the metadata for an analysis.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeAnalysisDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeAnalysisDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeAnalysisDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a detailed description of the definition of an analysis.

\n \n

If you do not need to know details about the content of an Analysis, for instance if you\n are trying to check the status of a recently created or updated Analysis, use the\n \n DescribeAnalysis\n instead.\n

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}/definition", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeAnalysisDefinitionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis. You must be using the\n Amazon Web Services account that the analysis is in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis that you're describing. The ID is part of the URL of the\n analysis.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeAnalysisDefinitionResponse": { + "type": "structure", + "members": { + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis described.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#AnalysisName", + "traits": { + "smithy.api#documentation": "

The descriptive name of the analysis.

" + } + }, + "Errors": { + "target": "com.amazonaws.quicksight#AnalysisErrorList", + "traits": { + "smithy.api#documentation": "

Errors associated with the analysis.

" + } + }, + "ResourceStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

Status associated with the analysis.

\n " + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the theme of the analysis.

" + } + }, + "Definition": { + "target": "com.amazonaws.quicksight#AnalysisDefinition", + "traits": { + "smithy.api#documentation": "

The definition of an analysis.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeAnalysisPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeAnalysisPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeAnalysisPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides the read and write permissions for an analysis.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeAnalysisPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis whose permissions you're\n describing. You must be using the Amazon Web Services account that the analysis is in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis whose permissions you're describing. The ID is part of the\n analysis URL.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeAnalysisPermissionsResponse": { + "type": "structure", + "members": { + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis whose permissions you're describing.

" + } + }, + "AnalysisArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the analysis whose permissions you're\n describing.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A structure that describes the principals and the resource-level permissions on an\n analysis.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeAnalysisRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis. You must be using the \n Amazon Web Services account that the analysis is in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis that you're describing. The ID is part of the URL of the\n analysis.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeAnalysisResponse": { + "type": "structure", + "members": { + "Analysis": { + "target": "com.amazonaws.quicksight#Analysis", + "traits": { + "smithy.api#documentation": "

A metadata structure that contains summary information for the analysis that you're\n describing.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeAssetBundleExportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeAssetBundleExportJobRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeAssetBundleExportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an existing export job.

\n

Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed.

\n

Job descriptions are available for 14 days after the job starts.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/asset-bundle-export-jobs/{AssetBundleExportJobId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeAssetBundleExportJobRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account the export job is executed in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssetBundleExportJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job that you want described. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeAssetBundleExportJobResponse": { + "type": "structure", + "members": { + "JobStatus": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobStatus", + "traits": { + "smithy.api#documentation": "

Indicates the status of a job through its queuing and execution.

\n

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

" + } + }, + "DownloadUrl": { + "target": "com.amazonaws.quicksight#SensitiveS3Uri", + "traits": { + "smithy.api#documentation": "

The URL to download the exported asset bundle data from.

\n

This URL is available only after the job has succeeded. This URL is valid for 5 minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed.

\n

The downloaded asset bundle is a zip file named assetbundle-{jobId}.qs. The file has a .qs extension.

\n

This URL can't be used in a StartAssetBundleImportJob API call and should only be used for download purposes.

" + } + }, + "Errors": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobErrorList", + "traits": { + "smithy.api#documentation": "

An array of error records that describes any failures that occurred during the export job processing.

\n

Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the export job.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the export job was created.

" + } + }, + "AssetBundleExportJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that the export job was executed in.

" + } + }, + "ResourceArns": { + "target": "com.amazonaws.quicksight#AssetBundleResourceArns", + "traits": { + "smithy.api#documentation": "

A list of resource ARNs that exported with the job.

" + } + }, + "IncludeAllDependencies": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The include dependencies flag.

" + } + }, + "ExportFormat": { + "target": "com.amazonaws.quicksight#AssetBundleExportFormat", + "traits": { + "smithy.api#documentation": "

The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON formatted file can be used in the CloudFormation console and with the CloudFormation APIs.

" + } + }, + "CloudFormationOverridePropertyConfiguration": { + "target": "com.amazonaws.quicksight#AssetBundleCloudFormationOverridePropertyConfiguration", + "traits": { + "smithy.api#documentation": "

The CloudFormation override property configuration for the export job.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the response.

", + "smithy.api#httpResponseCode": {} + } + }, + "IncludePermissions": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The include permissions flag.

" + } + }, + "IncludeTags": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The include tags flag.

" + } + }, + "ValidationStrategy": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobValidationStrategy", + "traits": { + "smithy.api#documentation": "

The validation strategy that is used to export the analysis or dashboard.

" + } + }, + "Warnings": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobWarningList", + "traits": { + "smithy.api#documentation": "

An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.

\n

This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeAssetBundleImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeAssetBundleImportJobRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeAssetBundleImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an existing import job.

\n

Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/asset-bundle-import-jobs/{AssetBundleImportJobId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeAssetBundleImportJobRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account the import job was executed in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssetBundleImportJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeAssetBundleImportJobResponse": { + "type": "structure", + "members": { + "JobStatus": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobStatus", + "traits": { + "smithy.api#documentation": "

Indicates the status of a job through its queuing and execution.

\n

Poll the DescribeAssetBundleImport API until JobStatus returns one of the following values:

\n " + } + }, + "Errors": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobErrorList", + "traits": { + "smithy.api#documentation": "

An array of error records that describes any failures that occurred during the export job processing.

\n

Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.

" + } + }, + "RollbackErrors": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobErrorList", + "traits": { + "smithy.api#documentation": "

An array of error records that describes any failures that occurred while an import job was attempting a rollback.

\n

Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the import job.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the import job was created.

" + } + }, + "AssetBundleImportJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.

" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account the import job was executed in.

" + } + }, + "AssetBundleImportSource": { + "target": "com.amazonaws.quicksight#AssetBundleImportSourceDescription", + "traits": { + "smithy.api#documentation": "

The source of the asset bundle zip file that contains the data that is imported by the job.

" + } + }, + "OverrideParameters": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideParameters", + "traits": { + "smithy.api#documentation": "

Optional overrides that are applied to the resource configuration before import.

" + } + }, + "FailureAction": { + "target": "com.amazonaws.quicksight#AssetBundleImportFailureAction", + "traits": { + "smithy.api#documentation": "

The failure action for the import job.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the response.

", + "smithy.api#httpResponseCode": {} + } + }, + "OverridePermissions": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobOverridePermissions", + "traits": { + "smithy.api#documentation": "

Optional permission overrides that are applied to the resource configuration before import.

" + } + }, + "OverrideTags": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideTags", + "traits": { + "smithy.api#documentation": "

Optional tag overrides that are applied to the resource configuration before import.

" + } + }, + "OverrideValidationStrategy": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideValidationStrategy", + "traits": { + "smithy.api#documentation": "

An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.

" + } + }, + "Warnings": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobWarningList", + "traits": { + "smithy.api#documentation": "

An array of warning records that describe all permitted errors that are encountered during the import job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeDashboard": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDashboardRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDashboardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a summary for a dashboard.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDashboardDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDashboardDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDashboardDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a detailed description of the definition of a dashboard.

\n \n

If you do not need to know details about the content of a dashboard, for instance if you\n are trying to check the status of a recently created or updated dashboard, use the\n \n DescribeDashboard\n instead.\n

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/definition", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDashboardDefinitionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're\n describing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number for the dashboard. If a version number isn't passed, the\n latest published dashboard version is described.

", + "smithy.api#httpQuery": "version-number" + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The alias name.

", + "smithy.api#httpQuery": "alias-name" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDashboardDefinitionResponse": { + "type": "structure", + "members": { + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dashboard described.

" + } + }, + "Errors": { + "target": "com.amazonaws.quicksight#DashboardErrorList", + "traits": { + "smithy.api#documentation": "

Errors associated with this dashboard version.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DashboardName", + "traits": { + "smithy.api#documentation": "

The display name of the dashboard.

" + } + }, + "ResourceStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

Status associated with the dashboard version.

\n " + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the theme of the dashboard.

" + } + }, + "Definition": { + "target": "com.amazonaws.quicksight#DashboardVersionDefinition", + "traits": { + "smithy.api#documentation": "

The definition of a dashboard.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "DashboardPublishOptions": { + "target": "com.amazonaws.quicksight#DashboardPublishOptions", + "traits": { + "smithy.api#documentation": "

Options for publishing the dashboard:

\n " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeDashboardPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDashboardPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDashboardPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes read and write permissions for a dashboard.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDashboardPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're describing\n permissions for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard, also added to the IAM policy.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDashboardPermissionsResponse": { + "type": "structure", + "members": { + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

" + } + }, + "DashboardArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dashboard.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A structure that contains the permissions for the dashboard.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "LinkSharingConfiguration": { + "target": "com.amazonaws.quicksight#LinkSharingConfiguration", + "traits": { + "smithy.api#documentation": "

A structure that contains the configuration of a shareable link that grants access to\n the dashboard. Your users can use the link to view and interact with the dashboard, if\n the dashboard has been shared with them. For more information about sharing dashboards,\n see Sharing Dashboards.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeDashboardRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're\n describing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number for the dashboard. If a version number isn't passed, the\n latest published dashboard version is described.

", + "smithy.api#httpQuery": "version-number" + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The alias name.

", + "smithy.api#httpQuery": "alias-name" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDashboardResponse": { + "type": "structure", + "members": { + "Dashboard": { + "target": "com.amazonaws.quicksight#Dashboard", + "traits": { + "smithy.api#documentation": "

Information about the dashboard.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of this request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeDashboardSnapshotJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJobRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an existing snapshot job.

\n

Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs/{SnapshotJobId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDashboardSnapshotJobRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dashboard that you have started a snapshot job for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SnapshotJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResponse": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

\n The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.\n

" + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dashboard that you have started a snapshot job for.

" + } + }, + "SnapshotJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

" + } + }, + "UserConfiguration": { + "target": "com.amazonaws.quicksight#SnapshotUserConfigurationRedacted", + "traits": { + "smithy.api#documentation": "

The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.

" + } + }, + "SnapshotConfiguration": { + "target": "com.amazonaws.quicksight#SnapshotConfiguration", + "traits": { + "smithy.api#documentation": "

The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.quicksight#SnapshotJobStatus", + "traits": { + "smithy.api#documentation": "

Indicates the status of a job. The status updates as the job executes. This shows one of the following values.

\n " + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The time that the snapshot job was created.\n

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The time that the snapshot job status was last updated.\n

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services request ID for this operation.\n

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResult": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResultRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResultResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the result of an existing snapshot job that has finished running.

\n

A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call.

\n

If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id has not reached a terminal state..

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs/{SnapshotJobId}/result", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResultRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dashboard that you have started a snapshot job for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SnapshotJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResultResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.quicksight#SnapshotJobStatus", + "traits": { + "smithy.api#documentation": "

Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that a snapshot job was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that a snapshot job status was last updated.

" + } + }, + "Result": { + "target": "com.amazonaws.quicksight#SnapshotJobResult", + "traits": { + "smithy.api#documentation": "

The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.

" + } + }, + "ErrorInfo": { + "target": "com.amazonaws.quicksight#SnapshotJobErrorInfo", + "traits": { + "smithy.api#documentation": "

Displays information for the error that caused a job to fail.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDataSetRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDataSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDataSetPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDataSetPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDataSetPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the permissions on a dataset.

\n

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDataSetPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSetPermissionsResponse": { + "type": "structure", + "members": { + "DataSetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions on the dataset.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSetRefreshProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the refresh properties of a dataset.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "DataSetRefreshProperties": { + "target": "com.amazonaws.quicksight#DataSetRefreshProperties", + "traits": { + "smithy.api#documentation": "

The dataset refresh properties.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSetRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSetResponse": { + "type": "structure", + "members": { + "DataSet": { + "target": "com.amazonaws.quicksight#DataSet", + "traits": { + "smithy.api#documentation": "

Information on the dataset.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a data source.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDataSourcePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDataSourcePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDataSourcePermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the resource permissions for a data source.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDataSourcePermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSourcePermissionsResponse": { + "type": "structure", + "members": { + "DataSourceArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions on the data source.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSourceRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSourceResponse": { + "type": "structure", + "members": { + "DataSource": { + "target": "com.amazonaws.quicksight#DataSource", + "traits": { + "smithy.api#documentation": "

The information on the data source.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeFolder": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeFolderRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeFolderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a folder.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeFolderPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeFolderPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeFolderPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes permissions for a folder.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/permissions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Permissions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#DescribeFolderPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the folder whose permissions you want described.

", + "smithy.api#httpQuery": "namespace" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token for the next set of results.

", + "smithy.api#httpQuery": "next-token" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeFolderPermissionsResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the folder.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

Information about the permissions on the folder.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The pagination token for the next set of results, or null if there are no more results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeFolderRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeFolderResolvedPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeFolderResolvedPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeFolderResolvedPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/resolved-permissions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Permissions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#DescribeFolderResolvedPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the folder whose permissions you want described.

", + "smithy.api#httpQuery": "namespace" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token for the next set of results.

", + "smithy.api#httpQuery": "next-token" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeFolderResolvedPermissionsResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the folder.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

Information about the permissions for the folder.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token for the next set of results, or null if there are no more results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeFolderResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "Folder": { + "target": "com.amazonaws.quicksight#Folder", + "traits": { + "smithy.api#documentation": "

Information about the folder.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeGroupRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeGroupMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeGroupMembershipRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeGroupMembershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Use the DescribeGroupMembership operation to determine if a user is a\n\t\t\tmember of the specified group. If the user exists and is a member of the specified\n\t\t\tgroup, an associated GroupMember object is returned.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeGroupMembershipRequest": { + "type": "structure", + "members": { + "MemberName": { + "target": "com.amazonaws.quicksight#GroupMemberName", + "traits": { + "smithy.api#documentation": "

The user name of the user that you want to search for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group that you want to search.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the \n Amazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that includes the group you are searching within.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeGroupMembershipResponse": { + "type": "structure", + "members": { + "GroupMember": { + "target": "com.amazonaws.quicksight#GroupMember" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeGroupRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group that you want to describe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the group that you want described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeGroupResponse": { + "type": "structure", + "members": { + "Group": { + "target": "com.amazonaws.quicksight#Group", + "traits": { + "smithy.api#documentation": "

The name of the group.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeIAMPolicyAssignment": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an existing IAM policy assignment, as specified by the\n\t\t\tassignment name.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/{AssignmentName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the assignment that you want to\n\t\t\tdescribe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "traits": { + "smithy.api#documentation": "

The name of the assignment, also called a rule.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that contains the assignment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentResponse": { + "type": "structure", + "members": { + "IAMPolicyAssignment": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignment", + "traits": { + "smithy.api#documentation": "

Information describing the IAM policy assignment.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeIngestion": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeIngestionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeIngestionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a SPICE ingestion.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeIngestionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the dataset used in the ingestion.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IngestionId": { + "target": "com.amazonaws.quicksight#IngestionId", + "traits": { + "smithy.api#documentation": "

An ID for the ingestion.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeIngestionResponse": { + "type": "structure", + "members": { + "Ingestion": { + "target": "com.amazonaws.quicksight#Ingestion", + "traits": { + "smithy.api#documentation": "

Information about the ingestion.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeIpRestriction": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeIpRestrictionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeIpRestrictionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a summary and status of IP rules.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/ip-restriction", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeIpRestrictionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the IP rules.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeIpRestrictionResponse": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the IP rules.

" + } + }, + "IpRestrictionRuleMap": { + "target": "com.amazonaws.quicksight#IpRestrictionRuleMap", + "traits": { + "smithy.api#documentation": "

A map that describes the IP rules with CIDR range and description.

" + } + }, + "VpcIdRestrictionRuleMap": { + "target": "com.amazonaws.quicksight#VpcIdRestrictionRuleMap", + "traits": { + "smithy.api#documentation": "

A map of allowed VPC IDs and their rule descriptions.

" + } + }, + "VpcEndpointIdRestrictionRuleMap": { + "target": "com.amazonaws.quicksight#VpcEndpointIdRestrictionRuleMap", + "traits": { + "smithy.api#documentation": "

A map of allowed VPC endpoint IDs and their rule descriptions.

" + } + }, + "Enabled": { + "target": "com.amazonaws.quicksight#NullableBoolean", + "traits": { + "smithy.api#documentation": "

A value that specifies whether IP rules are turned on.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.\n\t\t\t

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeKeyRegistration": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeKeyRegistrationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeKeyRegistrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes all customer managed key registrations in a Amazon QuickSight account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/key-registration", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeKeyRegistrationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the customer managed key registration that you want to describe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DefaultKeyOnly": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Determines whether the request returns the default key only.

", + "smithy.api#httpQuery": "default-key-only" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeKeyRegistrationResponse": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the customer managed key registration specified in the request.

" + } + }, + "KeyRegistration": { + "target": "com.amazonaws.quicksight#KeyRegistration", + "traits": { + "smithy.api#documentation": "

A list of RegisteredCustomerManagedKey objects in a Amazon QuickSight account.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeNamespaceRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeNamespaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the current namespace.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeNamespaceRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that you want to describe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeNamespaceResponse": { + "type": "structure", + "members": { + "Namespace": { + "target": "com.amazonaws.quicksight#NamespaceInfoV2", + "traits": { + "smithy.api#documentation": "

The information about the namespace that you're describing. The response includes \n the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. DescribeNamespace also\n works for namespaces that are in the process of being created. For incomplete namespaces,\n this API operation lists the namespace error types and messages associated with the creation process.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a summary of a refresh schedule.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeRefreshScheduleRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the refresh schedule.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeRefreshScheduleResponse": { + "type": "structure", + "members": { + "RefreshSchedule": { + "target": "com.amazonaws.quicksight#RefreshSchedule", + "traits": { + "smithy.api#documentation": "

The refresh schedule.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the refresh schedule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeRoleCustomPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeRoleCustomPermissionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeRoleCustomPermissionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes all custom permissions that are mapped to a role.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeRoleCustomPermissionRequest": { + "type": "structure", + "members": { + "Role": { + "target": "com.amazonaws.quicksight#Role", + "traits": { + "smithy.api#documentation": "

The name of the role whose permissions you want described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that contains the role.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeRoleCustomPermissionResponse": { + "type": "structure", + "members": { + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#RoleName", + "traits": { + "smithy.api#documentation": "

The name of the custom permission that is described.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeTemplateRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a template's metadata.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeTemplateAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeTemplateAliasRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeTemplateAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the template alias for a template.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeTemplateAliasRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template alias that you're\n\t\t\tdescribing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The name of the template alias that you want to describe. If you name a specific alias, you\n\t\t\tdescribe the version that the alias points to. You can specify the latest version of the\n\t\t\ttemplate by providing the keyword $LATEST in the AliasName\n\t\t\tparameter. The keyword $PUBLISHED doesn't apply to templates.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeTemplateAliasResponse": { + "type": "structure", + "members": { + "TemplateAlias": { + "target": "com.amazonaws.quicksight#TemplateAlias", + "traits": { + "smithy.api#documentation": "

Information about the template alias.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeTemplateDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeTemplateDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeTemplateDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a detailed description of the definition of a template.

\n \n

If you do not need to know details about the content of a template, for instance if you\n\t\t\t\tare trying to check the status of a recently created or updated template, use the\n\t\t\t\t\n DescribeTemplate\n instead.\n\t\t\t

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/definition", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeTemplateDefinitionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template. You must be using the\n\t\t\t Amazon Web Services account that the template is in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the template that you're describing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the template.

", + "smithy.api#httpQuery": "version-number" + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The alias of the template that you want to describe. If you name a specific alias, you\n\t\t\t describe the version that the alias points to. You can specify the latest version of the\n\t\t\t template by providing the keyword $LATEST in the AliasName\n\t\t\t parameter. The keyword $PUBLISHED doesn't apply to templates.

", + "smithy.api#httpQuery": "alias-name" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeTemplateDefinitionResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#TemplateName", + "traits": { + "smithy.api#documentation": "

The descriptive name of the template.

" + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the template described.

" + } + }, + "Errors": { + "target": "com.amazonaws.quicksight#TemplateErrorList", + "traits": { + "smithy.api#documentation": "

Errors associated with the template version.

" + } + }, + "ResourceStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

Status associated with the template.

\n " + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the theme of the template.

" + } + }, + "Definition": { + "target": "com.amazonaws.quicksight#TemplateVersionDefinition", + "traits": { + "smithy.api#documentation": "

The definition of the template.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeTemplatePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeTemplatePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeTemplatePermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes read and write permissions on a template.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeTemplatePermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template that you're describing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeTemplatePermissionsResponse": { + "type": "structure", + "members": { + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template.

" + } + }, + "TemplateArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions to be set on the template.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeTemplateRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template that you're describing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

(Optional) The number for the version to describe. If a VersionNumber parameter\n\t\t\tvalue isn't provided, the latest version of the template is described.

", + "smithy.api#httpQuery": "version-number" + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The alias of the template that you want to describe. If you name a specific alias, you\n\t\t\tdescribe the version that the alias points to. You can specify the latest version of the\n\t\t\ttemplate by providing the keyword $LATEST in the AliasName\n\t\t\tparameter. The keyword $PUBLISHED doesn't apply to templates.

", + "smithy.api#httpQuery": "alias-name" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeTemplateResponse": { + "type": "structure", + "members": { + "Template": { + "target": "com.amazonaws.quicksight#Template", + "traits": { + "smithy.api#documentation": "

The template structure for the object you want to describe.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeTheme": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeThemeRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeThemeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a theme.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeThemeAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeThemeAliasRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeThemeAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the alias for a theme.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeThemeAliasRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme alias that you're\n\t\t\tdescribing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The name of the theme alias that you want to describe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeThemeAliasResponse": { + "type": "structure", + "members": { + "ThemeAlias": { + "target": "com.amazonaws.quicksight#ThemeAlias", + "traits": { + "smithy.api#documentation": "

Information about the theme alias.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeThemePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeThemePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeThemePermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the read and write permissions for a theme.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeThemePermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme that you're describing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme that you want to describe permissions for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeThemePermissionsResponse": { + "type": "structure", + "members": { + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme.

" + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions set on the theme.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeThemeRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAndAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme that you're describing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number for the version to describe. If a VersionNumber parameter\n\t\t\tvalue isn't provided, the latest version of the theme is described.

", + "smithy.api#httpQuery": "version-number" + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The alias of the theme that you want to describe. If you name a specific alias, you\n\t\t\tdescribe the version that the alias points to. You can specify the latest version of the\n\t\t\ttheme by providing the keyword $LATEST in the AliasName\n\t\t\tparameter. The keyword $PUBLISHED doesn't apply to themes.

", + "smithy.api#httpQuery": "alias-name" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeThemeResponse": { + "type": "structure", + "members": { + "Theme": { + "target": "com.amazonaws.quicksight#Theme", + "traits": { + "smithy.api#documentation": "

The information about the theme that you are describing.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeTopic": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeTopicRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeTopicResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a topic.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeTopicPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeTopicPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeTopicPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the permissions of a topic.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeTopicPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic that you want\n described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeTopicPermissionsResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions that are configured to the topic.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeTopicRefresh": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeTopicRefreshRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeTopicRefreshResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the status of a topic refresh.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/refresh/{RefreshId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeTopicRefreshRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic whose refresh you want\n to describe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RefreshId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the refresh, which is performed when the topic is created or updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeTopicRefreshResponse": { + "type": "structure", + "members": { + "RefreshDetails": { + "target": "com.amazonaws.quicksight#TopicRefreshDetails", + "traits": { + "smithy.api#documentation": "

Details of the refresh, which is performed when the topic is created or updated.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeTopicRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeTopicRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeTopicRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a topic refresh schedule.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules/{DatasetId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeTopicRefreshScheduleRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that contains the refresh schedule that you want to describe. This\n ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DatasetId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeTopicRefreshScheduleResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that contains the refresh schedule that you want to describe. This\n ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "RefreshSchedule": { + "target": "com.amazonaws.quicksight#TopicRefreshSchedule", + "traits": { + "smithy.api#documentation": "

The definition of a refresh schedule.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeTopicRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeTopicResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "Topic": { + "target": "com.amazonaws.quicksight#TopicDetails", + "traits": { + "smithy.api#documentation": "

The definition of a topic.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeUserRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a user, given the user name.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeUserRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.quicksight#UserName", + "traits": { + "smithy.api#documentation": "

The name of the user that you want to describe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeUserResponse": { + "type": "structure", + "members": { + "User": { + "target": "com.amazonaws.quicksight#User", + "traits": { + "smithy.api#documentation": "

The user name.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeVPCConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeVPCConnectionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeVPCConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a VPC connection.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeVPCConnectionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the account that contains the VPC connection that\n\t\t\tyou want described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", + "traits": { + "smithy.api#documentation": "

The ID of the VPC connection that\n\t\t\tyou're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeVPCConnectionResponse": { + "type": "structure", + "members": { + "VPCConnection": { + "target": "com.amazonaws.quicksight#VPCConnection", + "traits": { + "smithy.api#documentation": "

A response object that provides information for the specified VPC connection.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DestinationParameterValueConfiguration": { + "type": "structure", + "members": { + "CustomValuesConfiguration": { + "target": "com.amazonaws.quicksight#CustomValuesConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration.

" + } + }, + "SelectAllValueOptions": { + "target": "com.amazonaws.quicksight#SelectAllValueOptions", + "traits": { + "smithy.api#documentation": "

The configuration that selects all options.

" + } + }, + "SourceParameterName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The source parameter name of the destination parameter.

" + } + }, + "SourceField": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The source field ID of the destination parameter.

" + } + }, + "SourceColumn": { + "target": "com.amazonaws.quicksight#ColumnIdentifier" + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of destination parameter values.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#DimensionField": { + "type": "structure", + "members": { + "NumericalDimensionField": { + "target": "com.amazonaws.quicksight#NumericalDimensionField", + "traits": { + "smithy.api#documentation": "

The dimension type field with numerical type columns.

" + } + }, + "CategoricalDimensionField": { + "target": "com.amazonaws.quicksight#CategoricalDimensionField", + "traits": { + "smithy.api#documentation": "

The dimension type field with categorical type columns.

" + } + }, + "DateDimensionField": { + "target": "com.amazonaws.quicksight#DateDimensionField", + "traits": { + "smithy.api#documentation": "

The dimension type field with date type columns.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The dimension type field.

" + } + }, + "com.amazonaws.quicksight#DimensionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#DisplayFormat": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "PERCENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENT" + } + }, + "CURRENCY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CURRENCY" + } + }, + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMBER" + } + }, + "DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE" + } + }, + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + } + } + }, + "com.amazonaws.quicksight#DisplayFormatOptions": { + "type": "structure", + "members": { + "UseBlankCellFormat": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that indicates whether to use blank cell format.

" + } + }, + "BlankCellFormat": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

Determines the blank cell format.

" + } + }, + "DateFormat": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

Determines the DateTime format.

" + } + }, + "DecimalSeparator": { + "target": "com.amazonaws.quicksight#TopicNumericSeparatorSymbol", + "traits": { + "smithy.api#documentation": "

Determines the decimal separator.

" + } + }, + "GroupingSeparator": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

Determines the grouping separator.

" + } + }, + "UseGrouping": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that indicates whether to use grouping.

" + } + }, + "FractionDigits": { + "target": "com.amazonaws.quicksight#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Determines the number of fraction digits.

" + } + }, + "Prefix": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The prefix value for a display format.

" + } + }, + "Suffix": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The suffix value for a display format.

" + } + }, + "UnitScaler": { + "target": "com.amazonaws.quicksight#NumberScale", + "traits": { + "smithy.api#documentation": "

The unit scaler. Valid values for this structure are: NONE,\n AUTO, THOUSANDS, MILLIONS,\n BILLIONS,\n and TRILLIONS.

" + } + }, + "NegativeFormat": { + "target": "com.amazonaws.quicksight#NegativeFormat", + "traits": { + "smithy.api#documentation": "

The negative format.

" + } + }, + "CurrencySymbol": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The currency symbol, such as USD.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents additional options for display formatting.

" + } + }, + "com.amazonaws.quicksight#DnsResolverList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#IPv4Address" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 15 + } + } + }, + "com.amazonaws.quicksight#Domain": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#DomainNotWhitelistedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The domain specified isn't on the allow list. All domains for embedded dashboards must be\n\t\t\tadded to the approved list by an Amazon QuickSight admin.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.quicksight#DonutCenterOptions": { + "type": "structure", + "members": { + "LabelVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines the visibility of the label in a donut chart. In the Amazon QuickSight console, this option is called 'Show total'.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.

" + } + }, + "com.amazonaws.quicksight#DonutOptions": { + "type": "structure", + "members": { + "ArcOptions": { + "target": "com.amazonaws.quicksight#ArcOptions", + "traits": { + "smithy.api#documentation": "

The option for define the arc of the chart shape. Valid values are as follows:

\n " + } + }, + "DonutCenterOptions": { + "target": "com.amazonaws.quicksight#DonutCenterOptions", + "traits": { + "smithy.api#documentation": "

The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for configuring a donut chart or pie chart.

" + } + }, + "com.amazonaws.quicksight#Double": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.quicksight#DrillDownFilter": { + "type": "structure", + "members": { + "NumericEqualityFilter": { + "target": "com.amazonaws.quicksight#NumericEqualityDrillDownFilter", + "traits": { + "smithy.api#documentation": "

The numeric equality type drill down filter. This filter is used for number type columns.

" + } + }, + "CategoryFilter": { + "target": "com.amazonaws.quicksight#CategoryDrillDownFilter", + "traits": { + "smithy.api#documentation": "

The category type drill down filter. This filter is used for string type columns.

" + } + }, + "TimeRangeFilter": { + "target": "com.amazonaws.quicksight#TimeRangeDrillDownFilter", + "traits": { + "smithy.api#documentation": "

The time range drill down filter. This filter is used for date time columns.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The drill down filter for the column hierarchies.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#DrillDownFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DrillDownFilter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#DropDownControlDisplayOptions": { + "type": "structure", + "members": { + "SelectAllOptions": { + "target": "com.amazonaws.quicksight#ListControlSelectAllOptions", + "traits": { + "smithy.api#documentation": "

The configuration of the Select all options in a\n dropdown control.

" + } + }, + "TitleOptions": { + "target": "com.amazonaws.quicksight#LabelOptions", + "traits": { + "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" + } + }, + "InfoIconLabelOptions": { + "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", + "traits": { + "smithy.api#documentation": "

The configuration of info icon label options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "com.amazonaws.quicksight#DynamicDefaultValue": { + "type": "structure", + "members": { + "UserNameColumn": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that contains the username.

" + } + }, + "GroupNameColumn": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that contains the group name.

" + } + }, + "DefaultValueColumn": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that contains the default value of each user or group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines different defaults to the users or groups based on mapping.

" + } + }, + "com.amazonaws.quicksight#Edition": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + }, + "ENTERPRISE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENTERPRISE" + } + }, + "ENTERPRISE_AND_Q": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENTERPRISE_AND_Q" + } + } + } + }, + "com.amazonaws.quicksight#EmbeddingIdentityType": { + "type": "enum", + "members": { + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM" + } + }, + "QUICKSIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT" + } + }, + "ANONYMOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANONYMOUS" + } + } + } + }, + "com.amazonaws.quicksight#EmbeddingUrl": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#EmptyVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", + "smithy.api#required": {} + } + }, + "DataSetIdentifier": { + "target": "com.amazonaws.quicksight#DataSetIdentifier", + "traits": { + "smithy.api#documentation": "

The data set that is used in the empty visual. Every visual requires a dataset to render.

", + "smithy.api#required": {} + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An empty visual.

\n

Empty visuals are used in layouts but have not been configured to show any data. A new visual created in the Amazon QuickSight console is considered an EmptyVisual until a visual type is selected.

" + } + }, + "com.amazonaws.quicksight#Entity": { + "type": "structure", + "members": { + "Path": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The hierarchical path of the entity within the analysis, template, or dashboard definition tree.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object, structure, or sub-structure of an analysis, template, or dashboard.

" + } + }, + "com.amazonaws.quicksight#EntityList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Entity" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#EntryPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.quicksight#EntryPoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.quicksight#ErrorInfo": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#IngestionErrorType", + "traits": { + "smithy.api#documentation": "

Error type.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

Error message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Error information for the SPICE ingestion of a dataset.

" + } + }, + "com.amazonaws.quicksight#ExasolParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

The hostname or IP address of the Exasol data source.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

The port for the Exasol data source.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The required parameters for connecting to an Exasol data source.

" + } + }, + "com.amazonaws.quicksight#ExceptionResourceType": { + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER" + } + }, + "GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GROUP" + } + }, + "NAMESPACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAMESPACE" + } + }, + "ACCOUNT_SETTINGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_SETTINGS" + } + }, + "IAMPOLICY_ASSIGNMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAMPOLICY_ASSIGNMENT" + } + }, + "DATA_SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SOURCE" + } + }, + "DATA_SET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SET" + } + }, + "VPC_CONNECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC_CONNECTION" + } + }, + "INGESTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INGESTION" + } + } + } + }, + "com.amazonaws.quicksight#ExcludePeriodConfiguration": { + "type": "structure", + "members": { + "Amount": { + "target": "com.amazonaws.quicksight#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The amount or number of the exclude period.

", + "smithy.api#required": {} + } + }, + "Granularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The granularity or unit (day, month, year) of the exclude period.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.quicksight#WidgetStatus", + "traits": { + "smithy.api#documentation": "

The status of the exclude period. Choose from the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The exclude period of TimeRangeFilter or RelativeDatesFilter.

" + } + }, + "com.amazonaws.quicksight#ExplicitHierarchy": { + "type": "structure", + "members": { + "HierarchyId": { + "target": "com.amazonaws.quicksight#HierarchyId", + "traits": { + "smithy.api#documentation": "

The hierarchy ID of the explicit hierarchy.

", + "smithy.api#required": {} + } + }, + "Columns": { + "target": "com.amazonaws.quicksight#ExplicitHierarchyColumnList", + "traits": { + "smithy.api#documentation": "

The list of columns that define the explicit hierarchy.

", + "smithy.api#required": {} + } + }, + "DrillDownFilters": { + "target": "com.amazonaws.quicksight#DrillDownFilterList", + "traits": { + "smithy.api#documentation": "

The option that determines the drill down filters for the explicit hierarchy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.

" + } + }, + "com.amazonaws.quicksight#ExplicitHierarchyColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#ExportHiddenFieldsOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

The status of the export hidden fields options of a dashbaord.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines if hidden fields are included in an exported dashboard.

" + } + }, + "com.amazonaws.quicksight#ExportToCSVOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

Availability status.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Export to .csv option.

" + } + }, + "com.amazonaws.quicksight#ExportWithHiddenFieldsOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

The status of the export with hidden fields options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines whether or not hidden fields are visible on exported dashbaords.

" + } + }, + "com.amazonaws.quicksight#Expression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#FailedKeyRegistrationEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FailedKeyRegistrationEntry" + } + }, + "com.amazonaws.quicksight#FailedKeyRegistrationEntry": { + "type": "structure", + "members": { + "KeyArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key that failed to update.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A message that provides information about why a FailedKeyRegistrationEntry error occurred.

", + "smithy.api#required": {} + } + }, + "StatusCode": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of a FailedKeyRegistrationEntry error.

", + "smithy.api#required": {} + } + }, + "SenderFault": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A boolean that indicates whether a FailedKeyRegistrationEntry resulted from user error. If the value of this property is True, the error was caused by user error. If the value of this property is False, the error occurred on the backend. If your job continues fail and with a False\n SenderFault value, contact Amazon Web Services Support.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An entry that appears when a KeyRegistration update to Amazon QuickSight fails.

" + } + }, + "com.amazonaws.quicksight#FieldBasedTooltip": { + "type": "structure", + "members": { + "AggregationVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of Show aggregations.

" + } + }, + "TooltipTitleType": { + "target": "com.amazonaws.quicksight#TooltipTitleType", + "traits": { + "smithy.api#documentation": "

The type for the >tooltip title. Choose one of the following options:

\n " + } + }, + "TooltipFields": { + "target": "com.amazonaws.quicksight#TooltipItemList", + "traits": { + "smithy.api#documentation": "

The fields configuration in the\n tooltip.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The setup for the detailed tooltip.

" + } + }, + "com.amazonaws.quicksight#FieldFolder": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.quicksight#FieldFolderDescription", + "traits": { + "smithy.api#documentation": "

The description for a field folder.

" + } + }, + "columns": { + "target": "com.amazonaws.quicksight#FolderColumnList", + "traits": { + "smithy.api#documentation": "

A folder has a list of columns. A column can only be in one folder.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A FieldFolder element is a folder that contains fields and nested subfolders.

" + } + }, + "com.amazonaws.quicksight#FieldFolderDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.quicksight#FieldFolderMap": { + "type": "map", + "key": { + "target": "com.amazonaws.quicksight#FieldFolderPath" + }, + "value": { + "target": "com.amazonaws.quicksight#FieldFolder" + } + }, + "com.amazonaws.quicksight#FieldFolderPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.quicksight#FieldId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.quicksight#FieldLabelType": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

Indicates the field that is targeted by the field\n label.

" + } + }, + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the field label.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field label type.

" + } + }, + "com.amazonaws.quicksight#FieldOrderList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FieldId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#FieldSeriesItem": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID of the field for which you are setting the axis binding.

", + "smithy.api#required": {} + } + }, + "AxisBinding": { + "target": "com.amazonaws.quicksight#AxisBinding", + "traits": { + "smithy.api#documentation": "

The axis that you are binding the field to.

", + "smithy.api#required": {} + } + }, + "Settings": { + "target": "com.amazonaws.quicksight#LineChartSeriesSettings", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of line series associated to the field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field series item configuration of a line chart.

" + } + }, + "com.amazonaws.quicksight#FieldSort": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The sort configuration target field.

", + "smithy.api#required": {} + } + }, + "Direction": { + "target": "com.amazonaws.quicksight#SortDirection", + "traits": { + "smithy.api#documentation": "

The sort direction. Choose one of the following\n options:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration for a field in a\n field well.

" + } + }, + "com.amazonaws.quicksight#FieldSortOptions": { + "type": "structure", + "members": { + "FieldSort": { + "target": "com.amazonaws.quicksight#FieldSort", + "traits": { + "smithy.api#documentation": "

The sort configuration for a field in a field well.

" + } + }, + "ColumnSort": { + "target": "com.amazonaws.quicksight#ColumnSort", + "traits": { + "smithy.api#documentation": "

The sort configuration for a column that is not used in a field well.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field sort options in a chart configuration.

" + } + }, + "com.amazonaws.quicksight#FieldSortOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FieldSortOptions" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#FieldTooltipItem": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The unique ID of the field that is targeted by the tooltip.

", + "smithy.api#required": {} + } + }, + "Label": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The label of the tooltip item.

" + } + }, + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the tooltip item.

" + } + }, + "TooltipTarget": { + "target": "com.amazonaws.quicksight#TooltipTarget", + "traits": { + "smithy.api#documentation": "

Determines the target of the field tooltip item in a combo chart visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tooltip item for the fields.

" + } + }, + "com.amazonaws.quicksight#FieldValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#FileFormat": { + "type": "enum", + "members": { + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + }, + "TSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TSV" + } + }, + "CLF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLF" + } + }, + "ELF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ELF" + } + }, + "XLSX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XLSX" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + } + } + }, + "com.amazonaws.quicksight#FilledMapAggregatedFieldWells": { + "type": "structure", + "members": { + "Geospatial": { + "target": "com.amazonaws.quicksight#FilledMapDimensionFieldList", + "traits": { + "smithy.api#documentation": "

The aggregated location field well of the filled map. Values are grouped by location fields.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#FilledMapMeasureFieldList", + "traits": { + "smithy.api#documentation": "

The aggregated color field well of a filled map. Values are aggregated based on location fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The aggregated field well of the filled map.

" + } + }, + "com.amazonaws.quicksight#FilledMapConditionalFormatting": { + "type": "structure", + "members": { + "ConditionalFormattingOptions": { + "target": "com.amazonaws.quicksight#FilledMapConditionalFormattingOptionList", + "traits": { + "smithy.api#documentation": "

Conditional formatting options of a FilledMapVisual.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting of a FilledMapVisual.

" + } + }, + "com.amazonaws.quicksight#FilledMapConditionalFormattingOption": { + "type": "structure", + "members": { + "Shape": { + "target": "com.amazonaws.quicksight#FilledMapShapeConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting that determines the shape of the filled map.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Conditional formatting options of a FilledMapVisual.

" + } + }, + "com.amazonaws.quicksight#FilledMapConditionalFormattingOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FilledMapConditionalFormattingOption" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#FilledMapConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#FilledMapFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#FilledMapSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a FilledMapVisual.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "

The legend display setup of the visual.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The tooltip display setup of the visual.

" + } + }, + "WindowOptions": { + "target": "com.amazonaws.quicksight#GeospatialWindowOptions", + "traits": { + "smithy.api#documentation": "

The window options of the filled map visual.

" + } + }, + "MapStyleOptions": { + "target": "com.amazonaws.quicksight#GeospatialMapStyleOptions", + "traits": { + "smithy.api#documentation": "

The map style options of the filled map visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a FilledMapVisual.

" + } + }, + "com.amazonaws.quicksight#FilledMapDimensionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#FilledMapFieldWells": { + "type": "structure", + "members": { + "FilledMapAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#FilledMapAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field well of the filled map.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field wells of a FilledMapVisual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#FilledMapMeasureFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MeasureField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#FilledMapShapeConditionalFormatting": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID of the filled map shape.

", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.quicksight#ShapeConditionalFormat", + "traits": { + "smithy.api#documentation": "

The conditional formatting that determines the background color of a filled map's shape.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting that determines the shape of the filled map.

" + } + }, + "com.amazonaws.quicksight#FilledMapSortConfiguration": { + "type": "structure", + "members": { + "CategorySort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the location fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a FilledMapVisual.

" + } + }, + "com.amazonaws.quicksight#FilledMapVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#FilledMapConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "ConditionalFormatting": { + "target": "com.amazonaws.quicksight#FilledMapConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting of a FilledMapVisual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A filled map.

\n

For more information, see Creating filled maps in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#Filter": { + "type": "structure", + "members": { + "CategoryFilter": { + "target": "com.amazonaws.quicksight#CategoryFilter", + "traits": { + "smithy.api#documentation": "

A CategoryFilter filters text values.

\n

For more information, see Adding text filters in the Amazon QuickSight User Guide.

" + } + }, + "NumericRangeFilter": { + "target": "com.amazonaws.quicksight#NumericRangeFilter", + "traits": { + "smithy.api#documentation": "

A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.

" + } + }, + "NumericEqualityFilter": { + "target": "com.amazonaws.quicksight#NumericEqualityFilter", + "traits": { + "smithy.api#documentation": "

A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.

" + } + }, + "TimeEqualityFilter": { + "target": "com.amazonaws.quicksight#TimeEqualityFilter", + "traits": { + "smithy.api#documentation": "

A TimeEqualityFilter filters date-time values that equal or do not equal\n a given date/time value.

" + } + }, + "TimeRangeFilter": { + "target": "com.amazonaws.quicksight#TimeRangeFilter", + "traits": { + "smithy.api#documentation": "

A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.

" + } + }, + "RelativeDatesFilter": { + "target": "com.amazonaws.quicksight#RelativeDatesFilter", + "traits": { + "smithy.api#documentation": "

A RelativeDatesFilter filters date values that are relative to a given date.

" + } + }, + "TopBottomFilter": { + "target": "com.amazonaws.quicksight#TopBottomFilter", + "traits": { + "smithy.api#documentation": "

A TopBottomFilter filters data to the top or bottom values for a given column.

" + } + }, + "NestedFilter": { + "target": "com.amazonaws.quicksight#NestedFilter", + "traits": { + "smithy.api#documentation": "

A NestedFilter filters data with a subset of data that is defined by the nested inner filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

With a Filter, you can remove portions of data from a particular visual or view.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#FilterAggMetrics": { + "type": "structure", + "members": { + "MetricOperand": { + "target": "com.amazonaws.quicksight#Identifier", + "traits": { + "smithy.api#documentation": "

The metric operand of the FilterAggMetrics.

" + } + }, + "Function": { + "target": "com.amazonaws.quicksight#AggType", + "traits": { + "smithy.api#documentation": "

The function for the FilterAggMetrics.

" + } + }, + "SortDirection": { + "target": "com.amazonaws.quicksight#TopicSortDirection", + "traits": { + "smithy.api#documentation": "

The sort direction for FilterAggMetrics.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for the FilterAggMetrics.

" + } + }, + "com.amazonaws.quicksight#FilterAggMetricsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FilterAggMetrics" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#FilterClass": { + "type": "enum", + "members": { + "ENFORCED_VALUE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENFORCED_VALUE_FILTER" + } + }, + "CONDITIONAL_VALUE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONDITIONAL_VALUE_FILTER" + } + }, + "NAMED_VALUE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAMED_VALUE_FILTER" + } + } + } + }, + "com.amazonaws.quicksight#FilterControl": { + "type": "structure", + "members": { + "DateTimePicker": { + "target": "com.amazonaws.quicksight#FilterDateTimePickerControl", + "traits": { + "smithy.api#documentation": "

A control from a date filter that is used to specify date and time.

" + } + }, + "List": { + "target": "com.amazonaws.quicksight#FilterListControl", + "traits": { + "smithy.api#documentation": "

A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.

" + } + }, + "Dropdown": { + "target": "com.amazonaws.quicksight#FilterDropDownControl", + "traits": { + "smithy.api#documentation": "

A control to display a dropdown list with buttons that are used to select a single value.

" + } + }, + "TextField": { + "target": "com.amazonaws.quicksight#FilterTextFieldControl", + "traits": { + "smithy.api#documentation": "

A control to display a text box that is used to enter a single entry.

" + } + }, + "TextArea": { + "target": "com.amazonaws.quicksight#FilterTextAreaControl", + "traits": { + "smithy.api#documentation": "

A control to display a text box that is used to enter multiple entries.

" + } + }, + "Slider": { + "target": "com.amazonaws.quicksight#FilterSliderControl", + "traits": { + "smithy.api#documentation": "

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

" + } + }, + "RelativeDateTime": { + "target": "com.amazonaws.quicksight#FilterRelativeDateTimeControl", + "traits": { + "smithy.api#documentation": "

A control from a date filter that is used to specify the relative date.

" + } + }, + "CrossSheet": { + "target": "com.amazonaws.quicksight#FilterCrossSheetControl", + "traits": { + "smithy.api#documentation": "

A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The control of a filter that is used to interact with a dashboard or an analysis.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#FilterControlList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FilterControl" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#FilterCrossSheetControl": { + "type": "structure", + "members": { + "FilterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the FilterCrossSheetControl.

", + "smithy.api#required": {} + } + }, + "SourceFilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The source filter ID of the FilterCrossSheetControl.

", + "smithy.api#required": {} + } + }, + "CascadingControlConfiguration": { + "target": "com.amazonaws.quicksight#CascadingControlConfiguration", + "traits": { + "smithy.api#documentation": "

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet

" + } + }, + "com.amazonaws.quicksight#FilterDateTimePickerControl": { + "type": "structure", + "members": { + "FilterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the FilterDateTimePickerControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the FilterDateTimePickerControl.

", + "smithy.api#required": {} + } + }, + "SourceFilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The source filter ID of the FilterDateTimePickerControl.

", + "smithy.api#required": {} + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#DateTimePickerControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#SheetControlDateTimePickerType", + "traits": { + "smithy.api#documentation": "

The type of the FilterDropDownControl. Choose one of the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A control from a date filter that is used to specify date and time.

" + } + }, + "com.amazonaws.quicksight#FilterDropDownControl": { + "type": "structure", + "members": { + "FilterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the FilterDropDownControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the FilterDropDownControl.

", + "smithy.api#required": {} + } + }, + "SourceFilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The source filter ID of the FilterDropDownControl.

", + "smithy.api#required": {} + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#DropDownControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of the FilterDropDownControl.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#SheetControlListType", + "traits": { + "smithy.api#documentation": "

The type of the FilterDropDownControl. Choose one of the following options:

\n " + } + }, + "SelectableValues": { + "target": "com.amazonaws.quicksight#FilterSelectableValues", + "traits": { + "smithy.api#documentation": "

A list of selectable values that are used in a control.

" + } + }, + "CascadingControlConfiguration": { + "target": "com.amazonaws.quicksight#CascadingControlConfiguration", + "traits": { + "smithy.api#documentation": "

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control to display a dropdown list with buttons that are used to select a single value.

" + } + }, + "com.amazonaws.quicksight#FilterGroup": { + "type": "structure", + "members": { + "FilterGroupId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.quicksight#FilterList", + "traits": { + "smithy.api#documentation": "

The list of filters that are present in a FilterGroup.

", + "smithy.api#required": {} + } + }, + "ScopeConfiguration": { + "target": "com.amazonaws.quicksight#FilterScopeConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that specifies what scope to apply to a FilterGroup.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.quicksight#WidgetStatus", + "traits": { + "smithy.api#documentation": "

The status of the FilterGroup.

" + } + }, + "CrossDataset": { + "target": "com.amazonaws.quicksight#CrossDatasetTypes", + "traits": { + "smithy.api#documentation": "

The filter new feature which can apply filter group to all data sets. Choose one of the following options:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A grouping of individual filters. Filter groups are applied to the same group of visuals.

\n

For more information, see Adding filter conditions (group filters) with AND and OR operators in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#FilterGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FilterGroup" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.quicksight#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Filter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#FilterListConfiguration": { + "type": "structure", + "members": { + "MatchOperator": { + "target": "com.amazonaws.quicksight#CategoryFilterMatchOperator", + "traits": { + "smithy.api#documentation": "

The match operator that is used to determine if a filter should be applied.

", + "smithy.api#required": {} + } + }, + "CategoryValues": { + "target": "com.amazonaws.quicksight#CategoryValueList", + "traits": { + "smithy.api#documentation": "

The list of category values for the filter.

" + } + }, + "SelectAllOptions": { + "target": "com.amazonaws.quicksight#CategoryFilterSelectAllOptions", + "traits": { + "smithy.api#documentation": "

Select all of the values. Null is not the assigned value of select all.

\n " + } + }, + "NullOption": { + "target": "com.amazonaws.quicksight#FilterNullOption", + "traits": { + "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of filter configurations.

" + } + }, + "com.amazonaws.quicksight#FilterListControl": { + "type": "structure", + "members": { + "FilterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the FilterListControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the FilterListControl.

", + "smithy.api#required": {} + } + }, + "SourceFilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The source filter ID of the FilterListControl.

", + "smithy.api#required": {} + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#ListControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#SheetControlListType", + "traits": { + "smithy.api#documentation": "

The type of the FilterListControl. Choose one of the following options:

\n " + } + }, + "SelectableValues": { + "target": "com.amazonaws.quicksight#FilterSelectableValues", + "traits": { + "smithy.api#documentation": "

A list of selectable values that are used in a control.

" + } + }, + "CascadingControlConfiguration": { + "target": "com.amazonaws.quicksight#CascadingControlConfiguration", + "traits": { + "smithy.api#documentation": "

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.

" + } + }, + "com.amazonaws.quicksight#FilterNullOption": { + "type": "enum", + "members": { + "ALL_VALUES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_VALUES" + } + }, + "NULLS_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NULLS_ONLY" + } + }, + "NON_NULLS_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NON_NULLS_ONLY" + } + } + } + }, + "com.amazonaws.quicksight#FilterOperation": { + "type": "structure", + "members": { + "ConditionExpression": { + "target": "com.amazonaws.quicksight#Expression", + "traits": { + "smithy.api#documentation": "

An expression that must evaluate to a Boolean value. Rows for which the expression\n evaluates to true are kept in the dataset.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A transform operation that filters rows based on a condition.

" + } + }, + "com.amazonaws.quicksight#FilterOperationSelectedFieldsConfiguration": { + "type": "structure", + "members": { + "SelectedFields": { + "target": "com.amazonaws.quicksight#SelectedFieldList", + "traits": { + "smithy.api#documentation": "

Chooses the fields that are filtered in CustomActionFilterOperation.

" + } + }, + "SelectedFieldOptions": { + "target": "com.amazonaws.quicksight#SelectedFieldOptions", + "traits": { + "smithy.api#documentation": "

A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation.

\n

Valid values are defined as follows:

\n " + } + }, + "SelectedColumns": { + "target": "com.amazonaws.quicksight#CustomActionColumnList", + "traits": { + "smithy.api#documentation": "

The selected columns of a dataset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of selected fields in theCustomActionFilterOperation.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#FilterOperationTargetVisualsConfiguration": { + "type": "structure", + "members": { + "SameSheetTargetVisualConfiguration": { + "target": "com.amazonaws.quicksight#SameSheetTargetVisualConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the same-sheet target visuals that you want to be filtered.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of target visuals that you want to be filtered.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#FilterOperator": { + "type": "enum", + "members": { + "StringEquals": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StringEquals" + } + }, + "StringLike": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StringLike" + } + } + } + }, + "com.amazonaws.quicksight#FilterRelativeDateTimeControl": { + "type": "structure", + "members": { + "FilterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the FilterTextAreaControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the FilterTextAreaControl.

", + "smithy.api#required": {} + } + }, + "SourceFilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The source filter ID of the FilterTextAreaControl.

", + "smithy.api#required": {} + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#RelativeDateTimeControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control from a date filter that is used to specify the relative date.

" + } + }, + "com.amazonaws.quicksight#FilterScopeConfiguration": { + "type": "structure", + "members": { + "SelectedSheets": { + "target": "com.amazonaws.quicksight#SelectedSheetsFilterScopeConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for applying a filter to specific sheets.

" + } + }, + "AllSheets": { + "target": "com.amazonaws.quicksight#AllSheetsFilterScopeConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that applies a filter to all sheets. When you choose AllSheets as the value for a FilterScopeConfiguration, this filter is applied to all visuals of all sheets in an Analysis, Dashboard, or Template. The AllSheetsFilterScopeConfiguration is chosen.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The scope configuration for a FilterGroup.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#FilterSelectableValues": { + "type": "structure", + "members": { + "Values": { + "target": "com.amazonaws.quicksight#ParameterSelectableValueList", + "traits": { + "smithy.api#documentation": "

The values that are used in the FilterSelectableValues.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of selectable values that are used in a control.

" + } + }, + "com.amazonaws.quicksight#FilterSliderControl": { + "type": "structure", + "members": { + "FilterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the FilterSliderControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the FilterSliderControl.

", + "smithy.api#required": {} + } + }, + "SourceFilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The source filter ID of the FilterSliderControl.

", + "smithy.api#required": {} + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#SliderControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#SheetControlSliderType", + "traits": { + "smithy.api#documentation": "

The type of the FilterSliderControl. Choose one of the following options:

\n " + } + }, + "MaximumValue": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The larger value that is displayed at the right of the slider.

", + "smithy.api#required": {} + } + }, + "MinimumValue": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The smaller value that is displayed at the left of the slider.

", + "smithy.api#required": {} + } + }, + "StepSize": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of increments that the slider bar is divided into.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

" + } + }, + "com.amazonaws.quicksight#FilterTextAreaControl": { + "type": "structure", + "members": { + "FilterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the FilterTextAreaControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the FilterTextAreaControl.

", + "smithy.api#required": {} + } + }, + "SourceFilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The source filter ID of the FilterTextAreaControl.

", + "smithy.api#required": {} + } + }, + "Delimiter": { + "target": "com.amazonaws.quicksight#TextAreaControlDelimiter", + "traits": { + "smithy.api#documentation": "

The delimiter that is used to separate the lines in text.

" + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#TextAreaControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control to display a text box that is used to enter multiple entries.

" + } + }, + "com.amazonaws.quicksight#FilterTextFieldControl": { + "type": "structure", + "members": { + "FilterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the FilterTextFieldControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the FilterTextFieldControl.

", + "smithy.api#required": {} + } + }, + "SourceFilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The source filter ID of the FilterTextFieldControl.

", + "smithy.api#required": {} + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#TextFieldControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control to display a text box that is used to enter a single entry.

" + } + }, + "com.amazonaws.quicksight#FilterVisualScope": { + "type": "enum", + "members": { + "ALL_VISUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_VISUALS" + } + }, + "SELECTED_VISUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SELECTED_VISUALS" + } + } + } + }, + "com.amazonaws.quicksight#FilteredVisualsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#Folder": { + "type": "structure", + "members": { + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the folder.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#FolderName", + "traits": { + "smithy.api#documentation": "

A display name for the folder.

" + } + }, + "FolderType": { + "target": "com.amazonaws.quicksight#FolderType", + "traits": { + "smithy.api#documentation": "

The type of folder it is.

" + } + }, + "FolderPath": { + "target": "com.amazonaws.quicksight#Path", + "traits": { + "smithy.api#documentation": "

An array of ancestor ARN strings for the folder.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the folder was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the folder was last updated.

" + } + }, + "SharingModel": { + "target": "com.amazonaws.quicksight#SharingModel", + "traits": { + "smithy.api#documentation": "

The sharing scope of the folder.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A folder in Amazon QuickSight.

" + } + }, + "com.amazonaws.quicksight#FolderArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Arn" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#FolderColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5000 + } + } + }, + "com.amazonaws.quicksight#FolderFilterAttribute": { + "type": "enum", + "members": { + "PARENT_FOLDER_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARENT_FOLDER_ARN" + } + }, + "DIRECT_QUICKSIGHT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_OWNER" + } + }, + "DIRECT_QUICKSIGHT_SOLE_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_SOLE_OWNER" + } + }, + "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" + } + }, + "QUICKSIGHT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_OWNER" + } + }, + "QUICKSIGHT_VIEWER_OR_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_VIEWER_OR_OWNER" + } + }, + "FOLDER_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FOLDER_NAME" + } + } + } + }, + "com.amazonaws.quicksight#FolderMember": { + "type": "structure", + "members": { + "MemberId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of an asset in the folder.

" + } + }, + "MemberType": { + "target": "com.amazonaws.quicksight#MemberType", + "traits": { + "smithy.api#documentation": "

The type of asset that it is.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An asset in a Amazon QuickSight folder, such as a dashboard, analysis, or dataset.

" + } + }, + "com.amazonaws.quicksight#FolderMemberList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MemberIdArnPair" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#FolderName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#FolderSearchFilter": { + "type": "structure", + "members": { + "Operator": { + "target": "com.amazonaws.quicksight#FilterOperator", + "traits": { + "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\": \"StringEquals\". Valid values are \"StringEquals\" and \"StringLike\".

\n

If you set the operator value to \"StringEquals\", you need to provide an ownership related filter in the \"NAME\" field and the arn of the user or group whose folders you want to search in the \"Value\" field. For example, \"Name\":\"DIRECT_QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

\n

If you set the value to \"StringLike\", you need to provide the name of the folders you are searching for. For example, \"Name\":\"FOLDER_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\". The \"StringLike\" operator only supports the NAME value FOLDER_NAME.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#FolderFilterAttribute", + "traits": { + "smithy.api#documentation": "

The name of a value that you want to use in the filter. For example, \"Name\": \"QUICKSIGHT_OWNER\".

\n

Valid values are defined as follows:

\n " + } + }, + "Value": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The value of the named item (in this example, PARENT_FOLDER_ARN), that you want to use as a filter. For example, \"Value\": \"arn:aws:quicksight:us-east-1:1:folder/folderId\".

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter to use to search an Amazon QuickSight folder.

" + } + }, + "com.amazonaws.quicksight#FolderSearchFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FolderSearchFilter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#FolderSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the folder.

" + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#FolderName", + "traits": { + "smithy.api#documentation": "

The display name of the folder.

" + } + }, + "FolderType": { + "target": "com.amazonaws.quicksight#FolderType", + "traits": { + "smithy.api#documentation": "

The type of folder.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the folder was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the folder was last updated.

" + } + }, + "SharingModel": { + "target": "com.amazonaws.quicksight#SharingModel", + "traits": { + "smithy.api#documentation": "

The sharing scope of the folder.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of information about an existing Amazon QuickSight folder.

" + } + }, + "com.amazonaws.quicksight#FolderSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FolderSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#FolderType": { + "type": "enum", + "members": { + "SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED" + } + }, + "RESTRICTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESTRICTED" + } + } + } + }, + "com.amazonaws.quicksight#Font": { + "type": "structure", + "members": { + "FontFamily": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

Determines the font family settings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the font settings.

" + } + }, + "com.amazonaws.quicksight#FontConfiguration": { + "type": "structure", + "members": { + "FontSize": { + "target": "com.amazonaws.quicksight#FontSize", + "traits": { + "smithy.api#documentation": "

The option that determines the text display size.

" + } + }, + "FontDecoration": { + "target": "com.amazonaws.quicksight#FontDecoration", + "traits": { + "smithy.api#documentation": "

Determines the appearance of decorative lines on the text.

" + } + }, + "FontColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

Determines the color of the text.

" + } + }, + "FontWeight": { + "target": "com.amazonaws.quicksight#FontWeight", + "traits": { + "smithy.api#documentation": "

The option that determines the text display weight, or boldness.

" + } + }, + "FontStyle": { + "target": "com.amazonaws.quicksight#FontStyle", + "traits": { + "smithy.api#documentation": "

Determines the text display face that is inherited by the given font family.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures the display properties of the given text.

" + } + }, + "com.amazonaws.quicksight#FontDecoration": { + "type": "enum", + "members": { + "UNDERLINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNDERLINE" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.quicksight#FontList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Font" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.quicksight#FontSize": { + "type": "structure", + "members": { + "Relative": { + "target": "com.amazonaws.quicksight#RelativeFontSize", + "traits": { + "smithy.api#documentation": "

The lexical name for the text size, proportional to its surrounding context.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The option that determines the text display size.

" + } + }, + "com.amazonaws.quicksight#FontStyle": { + "type": "enum", + "members": { + "NORMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NORMAL" + } + }, + "ITALIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ITALIC" + } + } + } + }, + "com.amazonaws.quicksight#FontWeight": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#FontWeightName", + "traits": { + "smithy.api#documentation": "

The lexical name for the level of boldness of the text display.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The option that determines the text display weight, or boldness.

" + } + }, + "com.amazonaws.quicksight#FontWeightName": { + "type": "enum", + "members": { + "NORMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NORMAL" + } + }, + "BOLD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOLD" + } + } + } + }, + "com.amazonaws.quicksight#ForecastComputation": { + "type": "structure", + "members": { + "ComputationId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for a computation.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of a computation.

" + } + }, + "Time": { + "target": "com.amazonaws.quicksight#DimensionField", + "traits": { + "smithy.api#documentation": "

The time field that is used in a computation.

" + } + }, + "Value": { + "target": "com.amazonaws.quicksight#MeasureField", + "traits": { + "smithy.api#documentation": "

The value field that is used in a computation.

" + } + }, + "PeriodsForward": { + "target": "com.amazonaws.quicksight#PeriodsForward", + "traits": { + "smithy.api#documentation": "

The periods forward setup of a forecast computation.

" + } + }, + "PeriodsBackward": { + "target": "com.amazonaws.quicksight#PeriodsBackward", + "traits": { + "smithy.api#documentation": "

The periods backward setup of a forecast computation.

" + } + }, + "UpperBoundary": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The upper boundary setup of a forecast computation.

" + } + }, + "LowerBoundary": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The lower boundary setup of a forecast computation.

" + } + }, + "PredictionInterval": { + "target": "com.amazonaws.quicksight#PredictionInterval", + "traits": { + "smithy.api#documentation": "

The prediction interval setup of a forecast computation.

" + } + }, + "Seasonality": { + "target": "com.amazonaws.quicksight#ForecastComputationSeasonality", + "traits": { + "smithy.api#documentation": "

The seasonality setup of a forecast computation. Choose one of the following options:

\n " + } + }, + "CustomSeasonalityValue": { + "target": "com.amazonaws.quicksight#ForecastComputationCustomSeasonalityValue", + "traits": { + "smithy.api#documentation": "

The custom seasonality value setup of a forecast computation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The forecast computation configuration.

" + } + }, + "com.amazonaws.quicksight#ForecastComputationCustomSeasonalityValue": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 180 + } + } + }, + "com.amazonaws.quicksight#ForecastComputationSeasonality": { + "type": "enum", + "members": { + "AUTOMATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTOMATIC" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } + } + }, + "com.amazonaws.quicksight#ForecastConfiguration": { + "type": "structure", + "members": { + "ForecastProperties": { + "target": "com.amazonaws.quicksight#TimeBasedForecastProperties", + "traits": { + "smithy.api#documentation": "

The forecast properties setup of a forecast in the line\n chart.

" + } + }, + "Scenario": { + "target": "com.amazonaws.quicksight#ForecastScenario", + "traits": { + "smithy.api#documentation": "

The forecast scenario of a forecast in the line chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The forecast configuration that is used in a line chart's display properties.

" + } + }, + "com.amazonaws.quicksight#ForecastConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ForecastConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#ForecastScenario": { + "type": "structure", + "members": { + "WhatIfPointScenario": { + "target": "com.amazonaws.quicksight#WhatIfPointScenario", + "traits": { + "smithy.api#documentation": "

The what-if analysis forecast setup with the target date.

" + } + }, + "WhatIfRangeScenario": { + "target": "com.amazonaws.quicksight#WhatIfRangeScenario", + "traits": { + "smithy.api#documentation": "

The what-if analysis forecast setup with the date range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The forecast scenario of a forecast in the line chart.

" + } + }, + "com.amazonaws.quicksight#FormatConfiguration": { + "type": "structure", + "members": { + "StringFormatConfiguration": { + "target": "com.amazonaws.quicksight#StringFormatConfiguration", + "traits": { + "smithy.api#documentation": "

Formatting configuration for string fields.

" + } + }, + "NumberFormatConfiguration": { + "target": "com.amazonaws.quicksight#NumberFormatConfiguration", + "traits": { + "smithy.api#documentation": "

Formatting configuration for number fields.

" + } + }, + "DateTimeFormatConfiguration": { + "target": "com.amazonaws.quicksight#DateTimeFormatConfiguration", + "traits": { + "smithy.api#documentation": "

Formatting configuration for DateTime fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The formatting configuration for all types of field.

" + } + }, + "com.amazonaws.quicksight#FreeFormLayoutCanvasSizeOptions": { + "type": "structure", + "members": { + "ScreenCanvasSizeOptions": { + "target": "com.amazonaws.quicksight#FreeFormLayoutScreenCanvasSizeOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the sizing of the canvas used in a free-form layout.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration options for the canvas of a free-form layout.

" + } + }, + "com.amazonaws.quicksight#FreeFormLayoutConfiguration": { + "type": "structure", + "members": { + "Elements": { + "target": "com.amazonaws.quicksight#FreeFromLayoutElementList", + "traits": { + "smithy.api#documentation": "

The elements that are included in a free-form layout.

", + "smithy.api#required": {} + } + }, + "CanvasSizeOptions": { + "target": "com.amazonaws.quicksight#FreeFormLayoutCanvasSizeOptions" + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a free-form layout.

" + } + }, + "com.amazonaws.quicksight#FreeFormLayoutElement": { + "type": "structure", + "members": { + "ElementId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

A unique identifier for an element within a free-form layout.

", + "smithy.api#required": {} + } + }, + "ElementType": { + "target": "com.amazonaws.quicksight#LayoutElementType", + "traits": { + "smithy.api#documentation": "

The type of element.

", + "smithy.api#required": {} + } + }, + "XAxisLocation": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The x-axis coordinate of the element.

", + "smithy.api#required": {} + } + }, + "YAxisLocation": { + "target": "com.amazonaws.quicksight#UnlimitedPixelLength", + "traits": { + "smithy.api#documentation": "

The y-axis coordinate of the element.

", + "smithy.api#required": {} + } + }, + "Width": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The width of an element within a free-form layout.

", + "smithy.api#required": {} + } + }, + "Height": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The height of an element within a free-form layout.

", + "smithy.api#required": {} + } + }, + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of an element within a free-form layout.

" + } + }, + "RenderingRules": { + "target": "com.amazonaws.quicksight#SheetElementRenderingRuleList", + "traits": { + "smithy.api#documentation": "

The rendering rules that determine when an element should be displayed within a free-form layout.

" + } + }, + "BorderStyle": { + "target": "com.amazonaws.quicksight#FreeFormLayoutElementBorderStyle", + "traits": { + "smithy.api#documentation": "

The border style configuration of a free-form layout element.

" + } + }, + "SelectedBorderStyle": { + "target": "com.amazonaws.quicksight#FreeFormLayoutElementBorderStyle", + "traits": { + "smithy.api#documentation": "

The border style configuration of a free-form layout element. This border style is used when the element is selected.

" + } + }, + "BackgroundStyle": { + "target": "com.amazonaws.quicksight#FreeFormLayoutElementBackgroundStyle", + "traits": { + "smithy.api#documentation": "

The background style configuration of a free-form layout element.

" + } + }, + "LoadingAnimation": { + "target": "com.amazonaws.quicksight#LoadingAnimation", + "traits": { + "smithy.api#documentation": "

The loading animation configuration of a free-form layout element.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An element within a free-form layout.

" + } + }, + "com.amazonaws.quicksight#FreeFormLayoutElementBackgroundStyle": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The background visibility of a free-form layout element.

" + } + }, + "Color": { + "target": "com.amazonaws.quicksight#HexColorWithTransparency", + "traits": { + "smithy.api#documentation": "

The background color of a free-form layout element.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The background style configuration of a free-form layout element.

" + } + }, + "com.amazonaws.quicksight#FreeFormLayoutElementBorderStyle": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The border visibility of a free-form layout element.

" + } + }, + "Color": { + "target": "com.amazonaws.quicksight#HexColorWithTransparency", + "traits": { + "smithy.api#documentation": "

The border color of a free-form layout element.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The background style configuration of a free-form layout element.

" + } + }, + "com.amazonaws.quicksight#FreeFormLayoutScreenCanvasSizeOptions": { + "type": "structure", + "members": { + "OptimizedViewPortWidth": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The width that the view port will be optimized for when the layout renders.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the sizing of the canvas used in a free-form layout.

" + } + }, + "com.amazonaws.quicksight#FreeFormSectionLayoutConfiguration": { + "type": "structure", + "members": { + "Elements": { + "target": "com.amazonaws.quicksight#FreeFromLayoutElementList", + "traits": { + "smithy.api#documentation": "

The elements that are included in the free-form layout.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The free-form layout configuration of a section.

" + } + }, + "com.amazonaws.quicksight#FreeFromLayoutElementList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FreeFormLayoutElement" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 430 + } + } + }, + "com.amazonaws.quicksight#FunnelChartAggregatedFieldWells": { + "type": "structure", + "members": { + "Category": { + "target": "com.amazonaws.quicksight#FunnelChartDimensionFieldList", + "traits": { + "smithy.api#documentation": "

The category field wells of a funnel chart. Values are grouped by category fields.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#FunnelChartMeasureFieldList", + "traits": { + "smithy.api#documentation": "

The value field wells of a funnel chart. Values are aggregated based on categories.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a FunnelChartVisual.

" + } + }, + "com.amazonaws.quicksight#FunnelChartConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#FunnelChartFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a FunnelChartVisual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#FunnelChartSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a FunnelChartVisual.

" + } + }, + "CategoryLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options of the categories that are displayed in a FunnelChartVisual.

" + } + }, + "ValueLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options for the values that are displayed in a FunnelChartVisual.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The tooltip configuration of a FunnelChartVisual.

" + } + }, + "DataLabelOptions": { + "target": "com.amazonaws.quicksight#FunnelChartDataLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the data labels.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "

The visual palette configuration of a FunnelChartVisual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a FunnelChartVisual.

" + } + }, + "com.amazonaws.quicksight#FunnelChartDataLabelOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility option that determines if data labels are displayed.

" + } + }, + "CategoryLabelVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the category labels within the data labels.

" + } + }, + "MeasureLabelVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the measure labels within the data labels.

" + } + }, + "Position": { + "target": "com.amazonaws.quicksight#DataLabelPosition", + "traits": { + "smithy.api#documentation": "

Determines the positioning of the data label relative to a section of the funnel.

" + } + }, + "LabelFontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration", + "traits": { + "smithy.api#documentation": "

The font configuration for the data labels.

\n

Only the FontSize attribute of the font configuration is used for data labels.

" + } + }, + "LabelColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color of the data label text.

" + } + }, + "MeasureDataLabelStyle": { + "target": "com.amazonaws.quicksight#FunnelChartMeasureDataLabelStyle", + "traits": { + "smithy.api#documentation": "

Determines the style of the metric labels.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the data labels.

" + } + }, + "com.amazonaws.quicksight#FunnelChartDimensionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#FunnelChartFieldWells": { + "type": "structure", + "members": { + "FunnelChartAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#FunnelChartAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a FunnelChartVisual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a FunnelChartVisual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#FunnelChartMeasureDataLabelStyle": { + "type": "enum", + "members": { + "VALUE_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALUE_ONLY" + } + }, + "PERCENTAGE_BY_FIRST_STAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENTAGE_BY_FIRST_STAGE" + } + }, + "PERCENTAGE_BY_PREVIOUS_STAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENTAGE_BY_PREVIOUS_STAGE" + } + }, + "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE" + } + }, + "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE" + } + } + } + }, + "com.amazonaws.quicksight#FunnelChartMeasureFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MeasureField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#FunnelChartSortConfiguration": { + "type": "structure", + "members": { + "CategorySort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the category fields.

" + } + }, + "CategoryItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of categories displayed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a FunnelChartVisual.

" + } + }, + "com.amazonaws.quicksight#FunnelChartVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#FunnelChartConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of a FunnelChartVisual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A funnel chart.

\n

For more information, see Using funnel charts in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#GaugeChartArcConditionalFormatting": { + "type": "structure", + "members": { + "ForegroundColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the arc foreground color.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the arc of a GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#GaugeChartColorConfiguration": { + "type": "structure", + "members": { + "ForegroundColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The foreground color configuration of a GaugeChartVisual.

" + } + }, + "BackgroundColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The background color configuration of a GaugeChartVisual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The color configuration of a GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#GaugeChartConditionalFormatting": { + "type": "structure", + "members": { + "ConditionalFormattingOptions": { + "target": "com.amazonaws.quicksight#GaugeChartConditionalFormattingOptionList", + "traits": { + "smithy.api#documentation": "

Conditional formatting options of a GaugeChartVisual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting of a GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#GaugeChartConditionalFormattingOption": { + "type": "structure", + "members": { + "PrimaryValue": { + "target": "com.amazonaws.quicksight#GaugeChartPrimaryValueConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting for the primary value of a GaugeChartVisual.

" + } + }, + "Arc": { + "target": "com.amazonaws.quicksight#GaugeChartArcConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the arc of a GaugeChartVisual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Conditional formatting options of a GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#GaugeChartConditionalFormattingOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#GaugeChartConditionalFormattingOption" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#GaugeChartConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#GaugeChartFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a GaugeChartVisual.

" + } + }, + "GaugeChartOptions": { + "target": "com.amazonaws.quicksight#GaugeChartOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the GaugeChartVisual.

" + } + }, + "DataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The data label configuration of a GaugeChartVisual.

" + } + }, + "TooltipOptions": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The tooltip configuration of a GaugeChartVisual.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "

The visual palette configuration of a GaugeChartVisual.

" + } + }, + "ColorConfiguration": { + "target": "com.amazonaws.quicksight#GaugeChartColorConfiguration", + "traits": { + "smithy.api#documentation": "

The color configuration of a GaugeChartVisual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#GaugeChartFieldWells": { + "type": "structure", + "members": { + "Values": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The value field wells of a GaugeChartVisual.

" + } + }, + "TargetValues": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The target value field wells of a GaugeChartVisual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#GaugeChartOptions": { + "type": "structure", + "members": { + "PrimaryValueDisplayType": { + "target": "com.amazonaws.quicksight#PrimaryValueDisplayType", + "traits": { + "smithy.api#documentation": "

The options that determine the primary value display type.

" + } + }, + "Comparison": { + "target": "com.amazonaws.quicksight#ComparisonConfiguration", + "traits": { + "smithy.api#documentation": "

The comparison configuration of a GaugeChartVisual.

" + } + }, + "ArcAxis": { + "target": "com.amazonaws.quicksight#ArcAxisConfiguration", + "traits": { + "smithy.api#documentation": "

The arc axis configuration of a GaugeChartVisual.

" + } + }, + "Arc": { + "target": "com.amazonaws.quicksight#ArcConfiguration", + "traits": { + "smithy.api#documentation": "

The arc configuration of a GaugeChartVisual.

" + } + }, + "PrimaryValueFontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the primary value font configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#GaugeChartPrimaryValueConditionalFormatting": { + "type": "structure", + "members": { + "TextColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the primary value text color.

" + } + }, + "Icon": { + "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the primary value icon.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting for the primary value of a GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#GaugeChartVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#GaugeChartConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of a GaugeChartVisual.

" + } + }, + "ConditionalFormatting": { + "target": "com.amazonaws.quicksight#GaugeChartConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting of a GaugeChartVisual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A gauge chart.

\n

For more information, see Using gauge charts in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUserRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#SessionLifetimeInMinutesInvalidException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedPricingPlanException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.

\n

The following rules apply to the generated URL:

\n \n

For more information, see Embedded Analytics in the Amazon QuickSight User\n Guide.

\n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/embed-url/anonymous-user", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUserRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SessionLifetimeInMinutes": { + "target": "com.amazonaws.quicksight#SessionLifetimeInMinutes", + "traits": { + "smithy.api#documentation": "

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.

", + "smithy.api#required": {} + } + }, + "SessionTags": { + "target": "com.amazonaws.quicksight#SessionTagList", + "traits": { + "smithy.api#documentation": "

The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

\n

These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.

" + } + }, + "AuthorizedResourceArns": { + "target": "com.amazonaws.quicksight#ArnList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user\n is authorized to access during the lifetime of the session.

\n

If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the\n account that you want the user to be able to view.

\n

If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to.

\n

Currently, you can pass up to 25 theme ARNs in each API call.

", + "smithy.api#required": {} + } + }, + "ExperienceConfiguration": { + "target": "com.amazonaws.quicksight#AnonymousUserEmbeddingExperienceConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the experience that you are embedding.

", + "smithy.api#required": {} + } + }, + "AllowedDomains": { + "target": "com.amazonaws.quicksight#StringList", + "traits": { + "smithy.api#documentation": "

The domains that you want to add to the allow list for access to the generated URL that\n is then embedded. This optional parameter overrides the static domains that are\n configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it\n allows only the domains that you include in this parameter. You can list up to three\n domains or subdomains in each API call.

\n

To include all subdomains under a specific domain to the allow list, use *.\n For example, https://*.sapp.amazon.com includes all subdomains under\n https://sapp.amazon.com.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUserResponse": { + "type": "structure", + "members": { + "EmbedUrl": { + "target": "com.amazonaws.quicksight#EmbeddingUrl", + "traits": { + "smithy.api#documentation": "

The embed URL for the dashboard.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {}, + "smithy.api#required": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

", + "smithy.api#required": {} + } + }, + "AnonymousUserArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#QuickSightUserNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#SessionLifetimeInMinutesInvalidException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedPricingPlanException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. \n Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.

\n

The following rules apply to the generated URL:

\n \n

For more information, see Embedded Analytics in the Amazon QuickSight User\n Guide.

\n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/embed-url/registered-user", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SessionLifetimeInMinutes": { + "target": "com.amazonaws.quicksight#SessionLifetimeInMinutes", + "traits": { + "smithy.api#documentation": "

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

" + } + }, + "UserArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name for the registered user.

", + "smithy.api#required": {} + } + }, + "ExperienceConfiguration": { + "target": "com.amazonaws.quicksight#RegisteredUserEmbeddingExperienceConfiguration", + "traits": { + "smithy.api#documentation": "

The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire Amazon QuickSight console.

", + "smithy.api#required": {} + } + }, + "AllowedDomains": { + "target": "com.amazonaws.quicksight#StringList", + "traits": { + "smithy.api#documentation": "

The domains that you want to add to the allow list for access to the generated URL that \n is then embedded. This optional parameter overrides the static domains that are \n configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it \n allows only the domains that you include in this parameter. You can list up to three \n domains or subdomains in each API call.

\n

To include all subdomains under a specific domain to the allow list, use *.\n For example, https://*.sapp.amazon.com includes all subdomains under\n https://sapp.amazon.com.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserResponse": { + "type": "structure", + "members": { + "EmbedUrl": { + "target": "com.amazonaws.quicksight#EmbeddingUrl", + "traits": { + "smithy.api#documentation": "

The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, Generative Q&A experience, or console.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {}, + "smithy.api#required": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#GeoSpatialColumnGroup": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#ColumnGroupName", + "traits": { + "smithy.api#documentation": "

A display name for the hierarchy.

", + "smithy.api#required": {} + } + }, + "CountryCode": { + "target": "com.amazonaws.quicksight#GeoSpatialCountryCode", + "traits": { + "smithy.api#documentation": "

Country code.

" + } + }, + "Columns": { + "target": "com.amazonaws.quicksight#ColumnList", + "traits": { + "smithy.api#documentation": "

Columns in this hierarchy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Geospatial column group that denotes a hierarchy.

" + } + }, + "com.amazonaws.quicksight#GeoSpatialCountryCode": { + "type": "enum", + "members": { + "US": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US" + } + } + } + }, + "com.amazonaws.quicksight#GeoSpatialDataRole": { + "type": "enum", + "members": { + "COUNTRY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNTRY" + } + }, + "STATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATE" + } + }, + "COUNTY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNTY" + } + }, + "CITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CITY" + } + }, + "POSTCODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSTCODE" + } + }, + "LONGITUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LONGITUDE" + } + }, + "LATITUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LATITUDE" + } + } + } + }, + "com.amazonaws.quicksight#GeospatialCoordinateBounds": { + "type": "structure", + "members": { + "North": { + "target": "com.amazonaws.quicksight#Latitude", + "traits": { + "smithy.api#documentation": "

The latitude of the north bound of the geospatial coordinate bounds.

", + "smithy.api#required": {} + } + }, + "South": { + "target": "com.amazonaws.quicksight#Latitude", + "traits": { + "smithy.api#documentation": "

The latitude of the south bound of the geospatial coordinate bounds.

", + "smithy.api#required": {} + } + }, + "West": { + "target": "com.amazonaws.quicksight#Longitude", + "traits": { + "smithy.api#documentation": "

The longitude of the west bound of the geospatial coordinate bounds.

", + "smithy.api#required": {} + } + }, + "East": { + "target": "com.amazonaws.quicksight#Longitude", + "traits": { + "smithy.api#documentation": "

The longitude of the east bound of the geospatial coordinate bounds.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The bound\n options (north, south, west, east) of the geospatial window options.

" + } + }, + "com.amazonaws.quicksight#GeospatialHeatmapColorScale": { + "type": "structure", + "members": { + "Colors": { + "target": "com.amazonaws.quicksight#GeospatialHeatmapDataColorList", + "traits": { + "smithy.api#documentation": "

The list of colors to be used in heatmap point style.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The color scale specification for the heatmap point style.

" + } + }, + "com.amazonaws.quicksight#GeospatialHeatmapConfiguration": { + "type": "structure", + "members": { + "HeatmapColor": { + "target": "com.amazonaws.quicksight#GeospatialHeatmapColorScale", + "traits": { + "smithy.api#documentation": "

The color scale specification for the heatmap point style.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The heatmap configuration of the geospatial point style.

" + } + }, + "com.amazonaws.quicksight#GeospatialHeatmapDataColor": { + "type": "structure", + "members": { + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The hex color to be used in the heatmap point style.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The color to be used in the heatmap point style.

" + } + }, + "com.amazonaws.quicksight#GeospatialHeatmapDataColorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#GeospatialHeatmapDataColor" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, + "com.amazonaws.quicksight#GeospatialMapAggregatedFieldWells": { + "type": "structure", + "members": { + "Geospatial": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The geospatial field wells of a geospatial map. Values are grouped by geospatial fields.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The size field wells of a geospatial map. Values are aggregated based on geospatial fields.

" + } + }, + "Colors": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The color field wells of a geospatial map.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The aggregated field wells for a geospatial map.

" + } + }, + "com.amazonaws.quicksight#GeospatialMapConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#GeospatialMapFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "

The legend display setup of the visual.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The tooltip display setup of the visual.

" + } + }, + "WindowOptions": { + "target": "com.amazonaws.quicksight#GeospatialWindowOptions", + "traits": { + "smithy.api#documentation": "

The window options of the geospatial map.

" + } + }, + "MapStyleOptions": { + "target": "com.amazonaws.quicksight#GeospatialMapStyleOptions", + "traits": { + "smithy.api#documentation": "

The map style options of the geospatial map.

" + } + }, + "PointStyleOptions": { + "target": "com.amazonaws.quicksight#GeospatialPointStyleOptions", + "traits": { + "smithy.api#documentation": "

The point style options of the geospatial map.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette" + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a GeospatialMapVisual.

" + } + }, + "com.amazonaws.quicksight#GeospatialMapFieldWells": { + "type": "structure", + "members": { + "GeospatialMapAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#GeospatialMapAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field well for a geospatial map.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field wells of a GeospatialMapVisual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#GeospatialMapStyleOptions": { + "type": "structure", + "members": { + "BaseMapStyle": { + "target": "com.amazonaws.quicksight#BaseMapStyleType", + "traits": { + "smithy.api#documentation": "

The base map style of the geospatial map.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The map style options of the geospatial map.

" + } + }, + "com.amazonaws.quicksight#GeospatialMapVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#GeospatialMapConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A geospatial map or a points on map visual.

\n

For more information, see Creating point maps in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#GeospatialPointStyleOptions": { + "type": "structure", + "members": { + "SelectedPointStyle": { + "target": "com.amazonaws.quicksight#GeospatialSelectedPointStyle", + "traits": { + "smithy.api#documentation": "

The selected point styles (point, cluster) of the geospatial map.

" + } + }, + "ClusterMarkerConfiguration": { + "target": "com.amazonaws.quicksight#ClusterMarkerConfiguration", + "traits": { + "smithy.api#documentation": "

The cluster marker configuration of the geospatial point style.

" + } + }, + "HeatmapConfiguration": { + "target": "com.amazonaws.quicksight#GeospatialHeatmapConfiguration", + "traits": { + "smithy.api#documentation": "

The heatmap configuration of the geospatial point style.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The point style of the geospatial map.

" + } + }, + "com.amazonaws.quicksight#GeospatialSelectedPointStyle": { + "type": "enum", + "members": { + "POINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POINT" + } + }, + "CLUSTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLUSTER" + } + }, + "HEATMAP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEATMAP" + } + } + } + }, + "com.amazonaws.quicksight#GeospatialWindowOptions": { + "type": "structure", + "members": { + "Bounds": { + "target": "com.amazonaws.quicksight#GeospatialCoordinateBounds", + "traits": { + "smithy.api#documentation": "

The bounds options (north, south, west, east) of the geospatial window options.

" + } + }, + "MapZoomMode": { + "target": "com.amazonaws.quicksight#MapZoomMode", + "traits": { + "smithy.api#documentation": "

The map zoom modes (manual, auto) of the geospatial window options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The window options of the geospatial map visual.

" + } + }, + "com.amazonaws.quicksight#GetDashboardEmbedUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#GetDashboardEmbedUrlRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#GetDashboardEmbedUrlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#DomainNotWhitelistedException" + }, + { + "target": "com.amazonaws.quicksight#IdentityTypeNotSupportedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#QuickSightUserNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#SessionLifetimeInMinutesInvalidException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedPricingPlanException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions.

\n

Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the generated URL:

\n \n

For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User\n Guide.

\n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/embed-url", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#GetDashboardEmbedUrlRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard, also added to the Identity and Access Management (IAM)\n policy.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IdentityType": { + "target": "com.amazonaws.quicksight#EmbeddingIdentityType", + "traits": { + "smithy.api#documentation": "

The authentication method that the user uses to sign in.

", + "smithy.api#httpQuery": "creds-type", + "smithy.api#required": {} + } + }, + "SessionLifetimeInMinutes": { + "target": "com.amazonaws.quicksight#SessionLifetimeInMinutes", + "traits": { + "smithy.api#documentation": "

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

", + "smithy.api#httpQuery": "session-lifetime" + } + }, + "UndoRedoDisabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables\n\t\t\tthe undo/redo button.

", + "smithy.api#httpQuery": "undo-redo-disabled" + } + }, + "ResetDisabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the\n\t\t\treset button.

", + "smithy.api#httpQuery": "reset-disabled" + } + }, + "StatePersistenceEnabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Adds persistence of state for the user session in an embedded dashboard. Persistence\n applies to the sheet and the parameter settings. These are control settings that the\n dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is\n set to TRUE, the settings are the same when the subscriber reopens the same\n dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is\n set to FALSE, the state of the user session is not persisted. The default is\n FALSE.

", + "smithy.api#httpQuery": "state-persistence-enabled" + } + }, + "UserArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.\n\t\t\tYou can use this for any Amazon QuickSight users in your account (readers, authors, or\n\t\t\tadmins) authenticated as one of the following:

\n \n

Omit this parameter for users in the third group – IAM users and IAM\n role-based sessions.

", + "smithy.api#httpQuery": "user-arn" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight namespace that contains the dashboard IDs in this request.\n \t If you're not using a custom namespace, set Namespace = default.

", + "smithy.api#httpQuery": "namespace" + } + }, + "AdditionalDashboardIds": { + "target": "com.amazonaws.quicksight#AdditionalDashboardIdList", + "traits": { + "smithy.api#documentation": "

A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set \"--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS\", the session can access all three dashboards.

", + "smithy.api#httpQuery": "additional-dashboard-ids" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#GetDashboardEmbedUrlResponse": { + "type": "structure", + "members": { + "EmbedUrl": { + "target": "com.amazonaws.quicksight#EmbeddingUrl", + "traits": { + "smithy.api#documentation": "

A single-use URL that you can put into your server-side webpage to embed your\n\t\t\tdashboard. This URL is valid for 5 minutes. The API operation provides the URL with an\n\t\t\tauth_code value that enables one (and only one) sign-on to a user session\n\t\t\tthat is valid for 10 hours.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Output returned from the GetDashboardEmbedUrl operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#GetSessionEmbedUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#GetSessionEmbedUrlRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#GetSessionEmbedUrlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#QuickSightUserNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#SessionLifetimeInMinutesInvalidException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Generates a session URL and authorization code that you can use to embed the Amazon\n Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where\n you want to provide an authoring portal that allows users to create data sources,\n datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console\n need belong to the author or admin security cohort. If you want to restrict permissions\n to some of these features, add a custom permissions profile to the user with the\n \n UpdateUser\n API operation. Use \n RegisterUser\n \n API operation to add a new user with a custom permission profile attached. For more\n information, see the following sections in the Amazon QuickSight User\n Guide:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/session-embed-url", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#GetSessionEmbedUrlRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "EntryPoint": { + "target": "com.amazonaws.quicksight#EntryPoint", + "traits": { + "smithy.api#documentation": "

The URL you use to access the embedded session. The entry point URL is constrained to\n the following paths:

\n ", + "smithy.api#httpQuery": "entry-point" + } + }, + "SessionLifetimeInMinutes": { + "target": "com.amazonaws.quicksight#SessionLifetimeInMinutes", + "traits": { + "smithy.api#documentation": "

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

", + "smithy.api#httpQuery": "session-lifetime" + } + }, + "UserArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.\n\t\t\tYou can use this for any type of Amazon QuickSight users in your account (readers, authors, or\n\t\t\tadmins). They need to be authenticated as one of the following:

\n
    \n
  1. \n

    Active Directory (AD) users or group members

    \n
    2. \n
  2. \n

    Invited nonfederated users

    \n
    3. \n
  3. \n

    IAM users and IAM role-based sessions authenticated\n through Federated Single Sign-On using SAML, OpenID Connect, or IAM\n federation

    \n
    4. \n
\n

Omit this parameter for users in the third group, IAM users and IAM role-based\n sessions.

", + "smithy.api#httpQuery": "user-arn" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#GetSessionEmbedUrlResponse": { + "type": "structure", + "members": { + "EmbedUrl": { + "target": "com.amazonaws.quicksight#EmbeddingUrl", + "traits": { + "smithy.api#documentation": "

A single-use URL that you can put into your server-side web page to embed your\n\t\t\tAmazon QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an\n\t\t\tauth_code value that enables one (and only one) sign-on to a user session\n\t\t\tthat is valid for 10 hours.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#GlobalTableBorderOptions": { + "type": "structure", + "members": { + "UniformBorder": { + "target": "com.amazonaws.quicksight#TableBorderOptions", + "traits": { + "smithy.api#documentation": "

Determines the options for uniform border.

" + } + }, + "SideSpecificBorder": { + "target": "com.amazonaws.quicksight#TableSideBorderOptions", + "traits": { + "smithy.api#documentation": "

Determines the options for side specific border.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the border options for a table visual.

" + } + }, + "com.amazonaws.quicksight#GradientColor": { + "type": "structure", + "members": { + "Stops": { + "target": "com.amazonaws.quicksight#GradientStopList", + "traits": { + "smithy.api#documentation": "

The list of gradient color stops.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the gradient color settings.

" + } + }, + "com.amazonaws.quicksight#GradientStop": { + "type": "structure", + "members": { + "GradientOffset": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Determines gradient offset value.

", + "smithy.api#required": {} + } + }, + "DataValue": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Determines the data value.

" + } + }, + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

Determines the color.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the gradient stop configuration.

" + } + }, + "com.amazonaws.quicksight#GradientStopList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#GradientStop" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#GridLayoutCanvasSizeOptions": { + "type": "structure", + "members": { + "ScreenCanvasSizeOptions": { + "target": "com.amazonaws.quicksight#GridLayoutScreenCanvasSizeOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the sizing of the canvas used in a grid layout.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration options for the canvas of a grid layout.

" + } + }, + "com.amazonaws.quicksight#GridLayoutConfiguration": { + "type": "structure", + "members": { + "Elements": { + "target": "com.amazonaws.quicksight#GridLayoutElementList", + "traits": { + "smithy.api#documentation": "

The elements that are included in a grid layout.

", + "smithy.api#required": {} + } + }, + "CanvasSizeOptions": { + "target": "com.amazonaws.quicksight#GridLayoutCanvasSizeOptions" + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a grid layout. Also called a tiled layout.

\n

Visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size.

" + } + }, + "com.amazonaws.quicksight#GridLayoutElement": { + "type": "structure", + "members": { + "ElementId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

A unique identifier for an element within a grid layout.

", + "smithy.api#required": {} + } + }, + "ElementType": { + "target": "com.amazonaws.quicksight#LayoutElementType", + "traits": { + "smithy.api#documentation": "

The type of element.

", + "smithy.api#required": {} + } + }, + "ColumnIndex": { + "target": "com.amazonaws.quicksight#GridLayoutElementColumnIndex", + "traits": { + "smithy.api#documentation": "

The column index for the upper left corner of an element.

" + } + }, + "ColumnSpan": { + "target": "com.amazonaws.quicksight#GridLayoutElementColumnSpan", + "traits": { + "smithy.api#documentation": "

The width of a grid element expressed as a number of grid columns.

", + "smithy.api#required": {} + } + }, + "RowIndex": { + "target": "com.amazonaws.quicksight#GridLayoutElementRowIndex", + "traits": { + "smithy.api#documentation": "

The row index for the upper left corner of an element.

" + } + }, + "RowSpan": { + "target": "com.amazonaws.quicksight#GridLayoutElementRowSpan", + "traits": { + "smithy.api#documentation": "

The height of a grid element expressed as a number of grid rows.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An element within a grid layout.

" + } + }, + "com.amazonaws.quicksight#GridLayoutElementColumnIndex": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 35 + } + } + }, + "com.amazonaws.quicksight#GridLayoutElementColumnSpan": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 36 + } + } + }, + "com.amazonaws.quicksight#GridLayoutElementList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#GridLayoutElement" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 430 + } + } + }, + "com.amazonaws.quicksight#GridLayoutElementRowIndex": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 9009 + } + } + }, + "com.amazonaws.quicksight#GridLayoutElementRowSpan": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 21 + } + } + }, + "com.amazonaws.quicksight#GridLayoutScreenCanvasSizeOptions": { + "type": "structure", + "members": { + "ResizeOption": { + "target": "com.amazonaws.quicksight#ResizeOption", + "traits": { + "smithy.api#documentation": "

This value determines the layout behavior when the viewport is resized.

\n ", + "smithy.api#required": {} + } + }, + "OptimizedViewPortWidth": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The width that the view port will be optimized for when the layout renders.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the sizing of the canvas used in a grid layout.

" + } + }, + "com.amazonaws.quicksight#Group": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the group.

" + } + }, + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group.

" + } + }, + "Description": { + "target": "com.amazonaws.quicksight#GroupDescription", + "traits": { + "smithy.api#documentation": "

The group description.

" + } + }, + "PrincipalId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The principal ID of the group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A group in Amazon QuickSight consists of a set of users. You can\n use groups to make it easier to manage access and security.

" + } + }, + "com.amazonaws.quicksight#GroupDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.quicksight#GroupFilterAttribute": { + "type": "enum", + "members": { + "GROUP_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GROUP_NAME" + } + } + } + }, + "com.amazonaws.quicksight#GroupFilterOperator": { + "type": "enum", + "members": { + "StartsWith": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartsWith" + } + } + } + }, + "com.amazonaws.quicksight#GroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Group" + } + }, + "com.amazonaws.quicksight#GroupMember": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the group member (user).

" + } + }, + "MemberName": { + "target": "com.amazonaws.quicksight#GroupMemberName", + "traits": { + "smithy.api#documentation": "

The name of the group member (user).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A member of an Amazon QuickSight group. Currently, group members must be users. Groups\n can't be members of another group. .

" + } + }, + "com.amazonaws.quicksight#GroupMemberList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#GroupMember" + } + }, + "com.amazonaws.quicksight#GroupMemberName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.quicksight#GroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.quicksight#GroupSearchFilter": { + "type": "structure", + "members": { + "Operator": { + "target": "com.amazonaws.quicksight#GroupFilterOperator", + "traits": { + "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\":\n \"StartsWith\". Currently, the only supported operator is\n StartsWith.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#GroupFilterAttribute", + "traits": { + "smithy.api#documentation": "

The name of the value that you want to use as a filter, for example \"Name\":\n \"GROUP_NAME\". Currently, the only supported name is\n GROUP_NAME.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The value of the named item, in this case GROUP_NAME, that you want to use as a filter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A GroupSearchFilter object that you want to apply to your search.

" + } + }, + "com.amazonaws.quicksight#GroupSearchFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#GroupSearchFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#GroupsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#String" + } + }, + "com.amazonaws.quicksight#GrowthRateComputation": { + "type": "structure", + "members": { + "ComputationId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for a computation.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of a computation.

" + } + }, + "Time": { + "target": "com.amazonaws.quicksight#DimensionField", + "traits": { + "smithy.api#documentation": "

The time field that is used in a computation.

" + } + }, + "Value": { + "target": "com.amazonaws.quicksight#MeasureField", + "traits": { + "smithy.api#documentation": "

The value field that is used in a computation.

" + } + }, + "PeriodSize": { + "target": "com.amazonaws.quicksight#GrowthRatePeriodSize", + "traits": { + "smithy.api#documentation": "

The period size setup of a growth rate computation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The growth rate computation configuration.

" + } + }, + "com.amazonaws.quicksight#GrowthRatePeriodSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 2, + "max": 52 + } + } + }, + "com.amazonaws.quicksight#GutterStyle": { + "type": "structure", + "members": { + "Show": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

This Boolean value controls whether to display a gutter space between sheet tiles.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options for gutter spacing between tiles on a sheet.

" + } + }, + "com.amazonaws.quicksight#HeaderFooterSectionConfiguration": { + "type": "structure", + "members": { + "SectionId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the header or footer section.

", + "smithy.api#required": {} + } + }, + "Layout": { + "target": "com.amazonaws.quicksight#SectionLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

The layout configuration of the header or footer section.

", + "smithy.api#required": {} + } + }, + "Style": { + "target": "com.amazonaws.quicksight#SectionStyle", + "traits": { + "smithy.api#documentation": "

The style options of a header or footer section.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a header or footer section.

" + } + }, + "com.amazonaws.quicksight#HeaderFooterSectionConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#HeaderFooterSectionConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#HeatMapAggregatedFieldWells": { + "type": "structure", + "members": { + "Rows": { + "target": "com.amazonaws.quicksight#HeatMapDimensionFieldList", + "traits": { + "smithy.api#documentation": "

The rows field well of a heat map.

" + } + }, + "Columns": { + "target": "com.amazonaws.quicksight#HeatMapDimensionFieldList", + "traits": { + "smithy.api#documentation": "

The columns field well of a heat map.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#HeatMapMeasureFieldList", + "traits": { + "smithy.api#documentation": "

The values field well of a heat map.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a heat map.

" + } + }, + "com.amazonaws.quicksight#HeatMapConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#HeatMapFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#HeatMapSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a heat map.

" + } + }, + "RowLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options of the row that is displayed in a heat map.

" + } + }, + "ColumnLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options of the column that is displayed in a heat map.

" + } + }, + "ColorScale": { + "target": "com.amazonaws.quicksight#ColorScale", + "traits": { + "smithy.api#documentation": "

The color options (gradient color, point of divergence) in a heat map.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "

The legend display setup of the visual.

" + } + }, + "DataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The tooltip display setup of the visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a heat map.

" + } + }, + "com.amazonaws.quicksight#HeatMapDimensionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#HeatMapFieldWells": { + "type": "structure", + "members": { + "HeatMapAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#HeatMapAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a heat map.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a heat map.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#HeatMapMeasureFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MeasureField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#HeatMapSortConfiguration": { + "type": "structure", + "members": { + "HeatMapRowSort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The field sort configuration of the rows fields.

" + } + }, + "HeatMapColumnSort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The column sort configuration for heat map for columns that aren't a part of a field well.

" + } + }, + "HeatMapRowItemsLimitConfiguration": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of rows that are displayed in a heat map.

" + } + }, + "HeatMapColumnItemsLimitConfiguration": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of columns that are displayed in a heat map.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a heat map.

" + } + }, + "com.amazonaws.quicksight#HeatMapVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#HeatMapConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of a heat map.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A heat map.

\n

For more information, see Using heat maps in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#HexColor": { + "type": "string", + "traits": { + "smithy.api#pattern": "^#[A-F0-9]{6}$" + } + }, + "com.amazonaws.quicksight#HexColorWithTransparency": { + "type": "string", + "traits": { + "smithy.api#pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$" + } + }, + "com.amazonaws.quicksight#HierarchyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.quicksight#HistogramAggregatedFieldWells": { + "type": "structure", + "members": { + "Values": { + "target": "com.amazonaws.quicksight#HistogramMeasureFieldList", + "traits": { + "smithy.api#documentation": "

The value field wells of a histogram. Values are aggregated by COUNT or DISTINCT_COUNT.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a histogram.

" + } + }, + "com.amazonaws.quicksight#HistogramBinOptions": { + "type": "structure", + "members": { + "SelectedBinType": { + "target": "com.amazonaws.quicksight#HistogramBinType", + "traits": { + "smithy.api#documentation": "

The options that determine the selected bin type.

" + } + }, + "BinCount": { + "target": "com.amazonaws.quicksight#BinCountOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the bin count of a histogram.

" + } + }, + "BinWidth": { + "target": "com.amazonaws.quicksight#BinWidthOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the bin width of a histogram.

" + } + }, + "StartValue": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The options that determine the bin start value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of histogram bins.

" + } + }, + "com.amazonaws.quicksight#HistogramBinType": { + "type": "enum", + "members": { + "BIN_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIN_COUNT" + } + }, + "BIN_WIDTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIN_WIDTH" + } + } + } + }, + "com.amazonaws.quicksight#HistogramConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#HistogramFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a histogram.

" + } + }, + "XAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the x-axis.

" + } + }, + "XAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the x-axis label.

" + } + }, + "YAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the y-axis.

" + } + }, + "BinOptions": { + "target": "com.amazonaws.quicksight#HistogramBinOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of histogram bins.

" + } + }, + "DataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The data label configuration of a histogram.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The tooltip configuration of a histogram.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "

The visual palette configuration of a histogram.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a HistogramVisual.

" + } + }, + "com.amazonaws.quicksight#HistogramFieldWells": { + "type": "structure", + "members": { + "HistogramAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#HistogramAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a histogram.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a histogram.

" + } + }, + "com.amazonaws.quicksight#HistogramMeasureFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MeasureField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#HistogramVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#HistogramConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for a HistogramVisual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A histogram.

\n

For more information, see Using histograms in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#HorizontalTextAlignment": { + "type": "enum", + "members": { + "LEFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEFT" + } + }, + "CENTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CENTER" + } + }, + "RIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RIGHT" + } + }, + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + } + } + }, + "com.amazonaws.quicksight#Host": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#IAMPolicyAssignment": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

" + } + }, + "AssignmentId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

Assignment ID.

" + } + }, + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "traits": { + "smithy.api#documentation": "

Assignment name.

" + } + }, + "PolicyArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM policy.

" + } + }, + "Identities": { + "target": "com.amazonaws.quicksight#IdentityMap", + "traits": { + "smithy.api#documentation": "

Identities.

" + } + }, + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", + "traits": { + "smithy.api#documentation": "

Assignment status.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Identity and Access Management (IAM) policy assignment.

" + } + }, + "com.amazonaws.quicksight#IAMPolicyAssignmentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^(?=^.{2,256}$)(?!.*\\s)[0-9a-zA-Z-_.:=+@]*$" + } + }, + "com.amazonaws.quicksight#IAMPolicyAssignmentSummary": { + "type": "structure", + "members": { + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "traits": { + "smithy.api#documentation": "

Assignment name.

" + } + }, + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", + "traits": { + "smithy.api#documentation": "

Assignment status.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

IAM policy assignment summary.

" + } + }, + "com.amazonaws.quicksight#IAMPolicyAssignmentSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentSummary" + } + }, + "com.amazonaws.quicksight#IPv4Address": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 7, + "max": 15 + } + } + }, + "com.amazonaws.quicksight#Icon": { + "type": "enum", + "members": { + "CARET_UP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CARET_UP" + } + }, + "CARET_DOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CARET_DOWN" + } + }, + "PLUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLUS" + } + }, + "MINUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MINUS" + } + }, + "ARROW_UP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARROW_UP" + } + }, + "ARROW_DOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARROW_DOWN" + } + }, + "ARROW_LEFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARROW_LEFT" + } + }, + "ARROW_UP_LEFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARROW_UP_LEFT" + } + }, + "ARROW_DOWN_LEFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARROW_DOWN_LEFT" + } + }, + "ARROW_RIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARROW_RIGHT" + } + }, + "ARROW_UP_RIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARROW_UP_RIGHT" + } + }, + "ARROW_DOWN_RIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARROW_DOWN_RIGHT" + } + }, + "FACE_UP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FACE_UP" + } + }, + "FACE_DOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FACE_DOWN" + } + }, + "FACE_FLAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FACE_FLAT" + } + }, + "ONE_BAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONE_BAR" + } + }, + "TWO_BAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TWO_BAR" + } + }, + "THREE_BAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THREE_BAR" + } + }, + "CIRCLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CIRCLE" + } + }, + "TRIANGLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRIANGLE" + } + }, + "SQUARE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQUARE" + } + }, + "FLAG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLAG" + } + }, + "THUMBS_UP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THUMBS_UP" + } + }, + "THUMBS_DOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THUMBS_DOWN" + } + }, + "CHECKMARK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHECKMARK" + } + }, + "X": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X" + } + } + } + }, + "com.amazonaws.quicksight#Identifier": { + "type": "structure", + "members": { + "Identity": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The identity of the identifier.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for the identifier.

" + } + }, + "com.amazonaws.quicksight#IdentityCenterConfiguration": { + "type": "structure", + "members": { + "EnableIdentityPropagation": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

A Boolean option that controls whether Trusted Identity Propagation should be used.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for an IAM Identity Center configuration.

" + } + }, + "com.amazonaws.quicksight#IdentityMap": { + "type": "map", + "key": { + "target": "com.amazonaws.quicksight#String" + }, + "value": { + "target": "com.amazonaws.quicksight#IdentityNameList" + } + }, + "com.amazonaws.quicksight#IdentityName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.quicksight#IdentityNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#IdentityName" + } + }, + "com.amazonaws.quicksight#IdentityStore": { + "type": "enum", + "members": { + "QUICKSIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT" + } + } + } + }, + "com.amazonaws.quicksight#IdentityType": { + "type": "enum", + "members": { + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM" + } + }, + "QUICKSIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT" + } + }, + "IAM_IDENTITY_CENTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_IDENTITY_CENTER" + } + } + } + }, + "com.amazonaws.quicksight#IdentityTypeNotSupportedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The identity type specified isn't supported. Supported identity types include\n\t\t\t\tIAM and QUICKSIGHT.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.quicksight#IncrementalRefresh": { + "type": "structure", + "members": { + "LookbackWindow": { + "target": "com.amazonaws.quicksight#LookbackWindow", + "traits": { + "smithy.api#documentation": "

The lookback window setup for an incremental refresh configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The incremental refresh configuration for a dataset.

" + } + }, + "com.amazonaws.quicksight#Ingestion": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#required": {} + } + }, + "IngestionId": { + "target": "com.amazonaws.quicksight#IngestionId", + "traits": { + "smithy.api#documentation": "

Ingestion ID.

" + } + }, + "IngestionStatus": { + "target": "com.amazonaws.quicksight#IngestionStatus", + "traits": { + "smithy.api#documentation": "

Ingestion status.

", + "smithy.api#required": {} + } + }, + "ErrorInfo": { + "target": "com.amazonaws.quicksight#ErrorInfo", + "traits": { + "smithy.api#documentation": "

Error information for this ingestion.

" + } + }, + "RowInfo": { + "target": "com.amazonaws.quicksight#RowInfo" + }, + "QueueInfo": { + "target": "com.amazonaws.quicksight#QueueInfo" + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that this ingestion started.

", + "smithy.api#required": {} + } + }, + "IngestionTimeInSeconds": { + "target": "com.amazonaws.quicksight#Long", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The time that this ingestion took, measured in seconds.

" + } + }, + "IngestionSizeInBytes": { + "target": "com.amazonaws.quicksight#Long", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The size of the data ingested, in bytes.

" + } + }, + "RequestSource": { + "target": "com.amazonaws.quicksight#IngestionRequestSource", + "traits": { + "smithy.api#documentation": "

Event source for this ingestion.

" + } + }, + "RequestType": { + "target": "com.amazonaws.quicksight#IngestionRequestType", + "traits": { + "smithy.api#documentation": "

Type of this ingestion.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the SPICE ingestion for a dataset.

" + } + }, + "com.amazonaws.quicksight#IngestionErrorType": { + "type": "enum", + "members": { + "FAILURE_TO_ASSUME_ROLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILURE_TO_ASSUME_ROLE" + } + }, + "INGESTION_SUPERSEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INGESTION_SUPERSEDED" + } + }, + "INGESTION_CANCELED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INGESTION_CANCELED" + } + }, + "DATA_SET_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SET_DELETED" + } + }, + "DATA_SET_NOT_SPICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SET_NOT_SPICE" + } + }, + "S3_UPLOADED_FILE_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_UPLOADED_FILE_DELETED" + } + }, + "S3_MANIFEST_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_MANIFEST_ERROR" + } + }, + "DATA_TOLERANCE_EXCEPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_TOLERANCE_EXCEPTION" + } + }, + "SPICE_TABLE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPICE_TABLE_NOT_FOUND" + } + }, + "DATA_SET_SIZE_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SET_SIZE_LIMIT_EXCEEDED" + } + }, + "ROW_SIZE_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROW_SIZE_LIMIT_EXCEEDED" + } + }, + "ACCOUNT_CAPACITY_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_CAPACITY_LIMIT_EXCEEDED" + } + }, + "CUSTOMER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER_ERROR" + } + }, + "DATA_SOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SOURCE_NOT_FOUND" + } + }, + "IAM_ROLE_NOT_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_ROLE_NOT_AVAILABLE" + } + }, + "CONNECTION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECTION_FAILURE" + } + }, + "SQL_TABLE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL_TABLE_NOT_FOUND" + } + }, + "PERMISSION_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERMISSION_DENIED" + } + }, + "SSL_CERTIFICATE_VALIDATION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSL_CERTIFICATE_VALIDATION_FAILURE" + } + }, + "OAUTH_TOKEN_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAUTH_TOKEN_FAILURE" + } + }, + "SOURCE_API_LIMIT_EXCEEDED_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOURCE_API_LIMIT_EXCEEDED_FAILURE" + } + }, + "PASSWORD_AUTHENTICATION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSWORD_AUTHENTICATION_FAILURE" + } + }, + "SQL_SCHEMA_MISMATCH_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL_SCHEMA_MISMATCH_ERROR" + } + }, + "INVALID_DATE_FORMAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_DATE_FORMAT" + } + }, + "INVALID_DATAPREP_SYNTAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_DATAPREP_SYNTAX" + } + }, + "SOURCE_RESOURCE_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOURCE_RESOURCE_LIMIT_EXCEEDED" + } + }, + "SQL_INVALID_PARAMETER_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL_INVALID_PARAMETER_VALUE" + } + }, + "QUERY_TIMEOUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUERY_TIMEOUT" + } + }, + "SQL_NUMERIC_OVERFLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL_NUMERIC_OVERFLOW" + } + }, + "UNRESOLVABLE_HOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNRESOLVABLE_HOST" + } + }, + "UNROUTABLE_HOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNROUTABLE_HOST" + } + }, + "SQL_EXCEPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL_EXCEPTION" + } + }, + "S3_FILE_INACCESSIBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_FILE_INACCESSIBLE" + } + }, + "IOT_FILE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IOT_FILE_NOT_FOUND" + } + }, + "IOT_DATA_SET_FILE_EMPTY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IOT_DATA_SET_FILE_EMPTY" + } + }, + "INVALID_DATA_SOURCE_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_DATA_SOURCE_CONFIG" + } + }, + "DATA_SOURCE_AUTH_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SOURCE_AUTH_FAILED" + } + }, + "DATA_SOURCE_CONNECTION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SOURCE_CONNECTION_FAILED" + } + }, + "FAILURE_TO_PROCESS_JSON_FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILURE_TO_PROCESS_JSON_FILE" + } + }, + "INTERNAL_SERVICE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVICE_ERROR" + } + }, + "REFRESH_SUPPRESSED_BY_EDIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REFRESH_SUPPRESSED_BY_EDIT" + } + }, + "PERMISSION_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERMISSION_NOT_FOUND" + } + }, + "ELASTICSEARCH_CURSOR_NOT_ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ELASTICSEARCH_CURSOR_NOT_ENABLED" + } + }, + "CURSOR_NOT_ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CURSOR_NOT_ENABLED" + } + }, + "DUPLICATE_COLUMN_NAMES_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DUPLICATE_COLUMN_NAMES_FOUND" + } + } + } + }, + "com.amazonaws.quicksight#IngestionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_]+$" + } + }, + "com.amazonaws.quicksight#IngestionMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#IngestionRequestSource": { + "type": "enum", + "members": { + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + }, + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCHEDULED" + } + } + } + }, + "com.amazonaws.quicksight#IngestionRequestType": { + "type": "enum", + "members": { + "INITIAL_INGESTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIAL_INGESTION" + } + }, + "EDIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EDIT" + } + }, + "INCREMENTAL_REFRESH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCREMENTAL_REFRESH" + } + }, + "FULL_REFRESH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_REFRESH" + } + } + }, + "traits": { + "smithy.api#documentation": "This defines the type of ingestion request. This is returned as part of create ingestion response." + } + }, + "com.amazonaws.quicksight#IngestionStatus": { + "type": "enum", + "members": { + "INITIALIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIALIZED" + } + }, + "QUEUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUED" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + } + } + }, + "com.amazonaws.quicksight#IngestionType": { + "type": "enum", + "members": { + "INCREMENTAL_REFRESH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCREMENTAL_REFRESH" + } + }, + "FULL_REFRESH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_REFRESH" + } + } + }, + "traits": { + "smithy.api#documentation": "This defines the type of ingestion user wants to trigger. This is part of create ingestion request." + } + }, + "com.amazonaws.quicksight#Ingestions": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Ingestion" + } + }, + "com.amazonaws.quicksight#InnerFilter": { + "type": "structure", + "members": { + "CategoryInnerFilter": { + "target": "com.amazonaws.quicksight#CategoryInnerFilter", + "traits": { + "smithy.api#documentation": "

A CategoryInnerFilter filters text values for the NestedFilter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The InnerFilter defines the subset of data to be used with the NestedFilter.

" + } + }, + "com.amazonaws.quicksight#InputColumn": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#ColumnName", + "traits": { + "smithy.api#documentation": "

The name of this column in the underlying data source.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.quicksight#InputColumnDataType", + "traits": { + "smithy.api#documentation": "

The data type of the column.

", + "smithy.api#required": {} + } + }, + "SubType": { + "target": "com.amazonaws.quicksight#ColumnDataSubType", + "traits": { + "smithy.api#documentation": "

The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata for a column that is used as the input of a transform operation.

" + } + }, + "com.amazonaws.quicksight#InputColumnDataType": { + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + }, + "INTEGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTEGER" + } + }, + "DECIMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DECIMAL" + } + }, + "DATETIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATETIME" + } + }, + "BIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIT" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOOLEAN" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + } + } + }, + "com.amazonaws.quicksight#InputColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#InputColumn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#InsightConfiguration": { + "type": "structure", + "members": { + "Computations": { + "target": "com.amazonaws.quicksight#ComputationList", + "traits": { + "smithy.api#documentation": "

The computations configurations of the insight visual

" + } + }, + "CustomNarrative": { + "target": "com.amazonaws.quicksight#CustomNarrativeOptions", + "traits": { + "smithy.api#documentation": "

The custom narrative of the insight visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of an insight visual.

" + } + }, + "com.amazonaws.quicksight#InsightVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "InsightConfiguration": { + "target": "com.amazonaws.quicksight#InsightConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of an insight visual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "DataSetIdentifier": { + "target": "com.amazonaws.quicksight#DataSetIdentifier", + "traits": { + "smithy.api#documentation": "

The dataset that is used in the insight visual.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An insight visual.

\n

For more information, see Working with insights in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#InstanceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.quicksight#IntegerDatasetParameter": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.quicksight#DatasetParameterId", + "traits": { + "smithy.api#documentation": "

An identifier for the integer parameter created in the dataset.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DatasetParameterName", + "traits": { + "smithy.api#documentation": "

The name of the integer parameter that is created in the dataset.

", + "smithy.api#required": {} + } + }, + "ValueType": { + "target": "com.amazonaws.quicksight#DatasetParameterValueType", + "traits": { + "smithy.api#documentation": "

The value type of the dataset parameter. Valid values are single value or multi value.

", + "smithy.api#required": {} + } + }, + "DefaultValues": { + "target": "com.amazonaws.quicksight#IntegerDatasetParameterDefaultValues", + "traits": { + "smithy.api#documentation": "

A list of default values for a given integer parameter. This structure only accepts static values.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An integer parameter for a dataset.

" + } + }, + "com.amazonaws.quicksight#IntegerDatasetParameterDefaultValue": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The default value for the integer parameter.

" + } + }, + "com.amazonaws.quicksight#IntegerDatasetParameterDefaultValues": { + "type": "structure", + "members": { + "StaticValues": { + "target": "com.amazonaws.quicksight#IntegerDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "

A list of static default values for a given integer parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default values of an integer parameter.

" + } + }, + "com.amazonaws.quicksight#IntegerDatasetParameterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#IntegerDatasetParameterDefaultValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.quicksight#IntegerDefaultValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SensitiveLongObject" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50000 + } + } + }, + "com.amazonaws.quicksight#IntegerDefaultValues": { + "type": "structure", + "members": { + "DynamicValue": { + "target": "com.amazonaws.quicksight#DynamicDefaultValue", + "traits": { + "smithy.api#documentation": "

The dynamic value of the IntegerDefaultValues. Different defaults are displayed according to users, groups, and values mapping.

" + } + }, + "StaticValues": { + "target": "com.amazonaws.quicksight#IntegerDefaultValueList", + "traits": { + "smithy.api#documentation": "

The static values of the IntegerDefaultValues.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default values of the IntegerParameterDeclaration.

" + } + }, + "com.amazonaws.quicksight#IntegerParameter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the integer parameter.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.quicksight#SensitiveLongList", + "traits": { + "smithy.api#documentation": "

The values for the integer parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An integer parameter.

" + } + }, + "com.amazonaws.quicksight#IntegerParameterDeclaration": { + "type": "structure", + "members": { + "ParameterValueType": { + "target": "com.amazonaws.quicksight#ParameterValueType", + "traits": { + "smithy.api#documentation": "

The value type determines whether the parameter is a single-value or multi-value parameter.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The name of the parameter that is being declared.

", + "smithy.api#required": {} + } + }, + "DefaultValues": { + "target": "com.amazonaws.quicksight#IntegerDefaultValues", + "traits": { + "smithy.api#documentation": "

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

" + } + }, + "ValueWhenUnset": { + "target": "com.amazonaws.quicksight#IntegerValueWhenUnsetConfiguration", + "traits": { + "smithy.api#documentation": "

A parameter declaration for the Integer data type.

" + } + }, + "MappedDataSetParameters": { + "target": "com.amazonaws.quicksight#MappedDataSetParameters" + } + }, + "traits": { + "smithy.api#documentation": "

A parameter declaration for the Integer data type.

" + } + }, + "com.amazonaws.quicksight#IntegerParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#IntegerParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#IntegerValueWhenUnsetConfiguration": { + "type": "structure", + "members": { + "ValueWhenUnsetOption": { + "target": "com.amazonaws.quicksight#ValueWhenUnsetOption", + "traits": { + "smithy.api#documentation": "

The built-in options for default values. The value can be one of the following:

\n " + } + }, + "CustomValue": { + "target": "com.amazonaws.quicksight#SensitiveLong", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

A custom value that's used when the value of a parameter isn't set.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A parameter declaration for the Integer data type.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#InternalFailureException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An internal failure occurred.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.quicksight#InvalidNextTokenException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The NextToken value isn't valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.quicksight#InvalidParameterValueException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

One or more parameters has a value that isn't valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.quicksight#InvalidRequestException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.quicksight#InvalidTopicReviewedAnswer": { + "type": "structure", + "members": { + "AnswerId": { + "target": "com.amazonaws.quicksight#AnswerId", + "traits": { + "smithy.api#documentation": "

The answer ID for the InvalidTopicReviewedAnswer.

" + } + }, + "Error": { + "target": "com.amazonaws.quicksight#ReviewedAnswerErrorCode", + "traits": { + "smithy.api#documentation": "

The error that is returned for the InvalidTopicReviewedAnswer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a InvalidTopicReviewedAnswer.

" + } + }, + "com.amazonaws.quicksight#InvalidTopicReviewedAnswers": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#InvalidTopicReviewedAnswer" + } + }, + "com.amazonaws.quicksight#IpRestrictionRuleDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 150 + } + } + }, + "com.amazonaws.quicksight#IpRestrictionRuleMap": { + "type": "map", + "key": { + "target": "com.amazonaws.quicksight#CIDR" + }, + "value": { + "target": "com.amazonaws.quicksight#IpRestrictionRuleDescription" + } + }, + "com.amazonaws.quicksight#ItemsLimitConfiguration": { + "type": "structure", + "members": { + "ItemsLimit": { + "target": "com.amazonaws.quicksight#Long", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The limit on how many items of a field are showed in the chart. For\n example, the number of slices that are displayed in a pie chart.

" + } + }, + "OtherCategories": { + "target": "com.amazonaws.quicksight#OtherCategories", + "traits": { + "smithy.api#documentation": "

The Show\n other of an axis in the chart. Choose one of the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The limit configuration of the visual display for an axis.

" + } + }, + "com.amazonaws.quicksight#JiraParameters": { + "type": "structure", + "members": { + "SiteBaseUrl": { + "target": "com.amazonaws.quicksight#SiteBaseUrl", + "traits": { + "smithy.api#documentation": "

The base URL of the Jira site.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for Jira.

" + } + }, + "com.amazonaws.quicksight#JoinInstruction": { + "type": "structure", + "members": { + "LeftOperand": { + "target": "com.amazonaws.quicksight#LogicalTableId", + "traits": { + "smithy.api#documentation": "

The operand on the left side of a join.

", + "smithy.api#required": {} + } + }, + "RightOperand": { + "target": "com.amazonaws.quicksight#LogicalTableId", + "traits": { + "smithy.api#documentation": "

The operand on the right side of a join.

", + "smithy.api#required": {} + } + }, + "LeftJoinKeyProperties": { + "target": "com.amazonaws.quicksight#JoinKeyProperties", + "traits": { + "smithy.api#documentation": "

Join key properties of the left operand.

" + } + }, + "RightJoinKeyProperties": { + "target": "com.amazonaws.quicksight#JoinKeyProperties", + "traits": { + "smithy.api#documentation": "

Join key properties of the right operand.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#JoinType", + "traits": { + "smithy.api#documentation": "

The type of join that it is.

", + "smithy.api#required": {} + } + }, + "OnClause": { + "target": "com.amazonaws.quicksight#OnClause", + "traits": { + "smithy.api#documentation": "

The join instructions provided in the ON clause of a join.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The instructions associated with a join.

" + } + }, + "com.amazonaws.quicksight#JoinKeyProperties": { + "type": "structure", + "members": { + "UniqueKey": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

A value that indicates that a row in a table is uniquely identified by the columns in\n a join key. This is used by Amazon QuickSight to optimize query performance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Properties associated with the columns participating in a join.

" + } + }, + "com.amazonaws.quicksight#JoinType": { + "type": "enum", + "members": { + "INNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INNER" + } + }, + "OUTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUTER" + } + }, + "LEFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEFT" + } + }, + "RIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RIGHT" + } + } + } + }, + "com.amazonaws.quicksight#KPIActualValueConditionalFormatting": { + "type": "structure", + "members": { + "TextColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the actual value's text color.

" + } + }, + "Icon": { + "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the actual value's icon.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting for the actual value of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPIComparisonValueConditionalFormatting": { + "type": "structure", + "members": { + "TextColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the comparison value's text color.

" + } + }, + "Icon": { + "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the comparison value's icon.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting for the comparison value of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPIConditionalFormatting": { + "type": "structure", + "members": { + "ConditionalFormattingOptions": { + "target": "com.amazonaws.quicksight#KPIConditionalFormattingOptionList", + "traits": { + "smithy.api#documentation": "

The conditional formatting options of a KPI visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPIConditionalFormattingOption": { + "type": "structure", + "members": { + "PrimaryValue": { + "target": "com.amazonaws.quicksight#KPIPrimaryValueConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting for the primary value of a KPI visual.

" + } + }, + "ProgressBar": { + "target": "com.amazonaws.quicksight#KPIProgressBarConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting for the progress bar of a KPI visual.

" + } + }, + "ActualValue": { + "target": "com.amazonaws.quicksight#KPIActualValueConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting for the actual value of a KPI visual.

" + } + }, + "ComparisonValue": { + "target": "com.amazonaws.quicksight#KPIComparisonValueConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting for the comparison value of a KPI visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting options of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPIConditionalFormattingOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#KPIConditionalFormattingOption" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#KPIConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#KPIFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a KPI visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#KPISortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a KPI visual.

" + } + }, + "KPIOptions": { + "target": "com.amazonaws.quicksight#KPIOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of a KPI visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPIFieldWells": { + "type": "structure", + "members": { + "Values": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The value field wells of a KPI visual.

" + } + }, + "TargetValues": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The target value field wells of a KPI visual.

" + } + }, + "TrendGroups": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The trend group field wells of a KPI visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPIOptions": { + "type": "structure", + "members": { + "ProgressBar": { + "target": "com.amazonaws.quicksight#ProgressBarOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the progress bar of a KPI visual.

" + } + }, + "TrendArrows": { + "target": "com.amazonaws.quicksight#TrendArrowOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of trend arrows in a KPI visual.

" + } + }, + "SecondaryValue": { + "target": "com.amazonaws.quicksight#SecondaryValueOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the secondary value of a KPI visual.

" + } + }, + "Comparison": { + "target": "com.amazonaws.quicksight#ComparisonConfiguration", + "traits": { + "smithy.api#documentation": "

The comparison configuration of a KPI visual.

" + } + }, + "PrimaryValueDisplayType": { + "target": "com.amazonaws.quicksight#PrimaryValueDisplayType", + "traits": { + "smithy.api#documentation": "

The options that determine the primary value display type.

" + } + }, + "PrimaryValueFontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the primary value font configuration.

" + } + }, + "SecondaryValueFontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the secondary value font configuration.

" + } + }, + "Sparkline": { + "target": "com.amazonaws.quicksight#KPISparklineOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

" + } + }, + "VisualLayoutOptions": { + "target": "com.amazonaws.quicksight#KPIVisualLayoutOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the layout a KPI visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPIPrimaryValueConditionalFormatting": { + "type": "structure", + "members": { + "TextColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the primary value's text color.

" + } + }, + "Icon": { + "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the primary value's icon.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting for the primary value of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPIProgressBarConditionalFormatting": { + "type": "structure", + "members": { + "ForegroundColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the progress bar's foreground color.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting for the progress bar of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPISortConfiguration": { + "type": "structure", + "members": { + "TrendGroupSort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the trend group fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPISparklineOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the sparkline.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#KPISparklineType", + "traits": { + "smithy.api#documentation": "

The type of the sparkline.

", + "smithy.api#required": {} + } + }, + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color of the sparkline.

" + } + }, + "TooltipVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The tooltip visibility of the sparkline.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPISparklineType": { + "type": "enum", + "members": { + "LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINE" + } + }, + "AREA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AREA" + } + } + } + }, + "com.amazonaws.quicksight#KPIVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#KPIConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of a KPI visual.

" + } + }, + "ConditionalFormatting": { + "target": "com.amazonaws.quicksight#KPIConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting of a KPI visual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A key performance indicator (KPI).

\n

For more information, see Using KPIs in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#KPIVisualLayoutOptions": { + "type": "structure", + "members": { + "StandardLayout": { + "target": "com.amazonaws.quicksight#KPIVisualStandardLayout", + "traits": { + "smithy.api#documentation": "

The standard layout of the KPI visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the layout a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPIVisualStandardLayout": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#KPIVisualStandardLayoutType", + "traits": { + "smithy.api#documentation": "

The standard layout type.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The standard layout of the KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPIVisualStandardLayoutType": { + "type": "enum", + "members": { + "CLASSIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLASSIC" + } + }, + "VERTICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERTICAL" + } + } + } + }, + "com.amazonaws.quicksight#KeyRegistration": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#RegisteredCustomerManagedKey" + } + }, + "com.amazonaws.quicksight#LabelOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines whether or not the label is visible.

" + } + }, + "FontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration", + "traits": { + "smithy.api#documentation": "

The font configuration of the label.

" + } + }, + "CustomLabel": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The text for the label.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The share label options for the labels.

" + } + }, + "com.amazonaws.quicksight#Latitude": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": -90, + "max": 90 + } + } + }, + "com.amazonaws.quicksight#Layout": { + "type": "structure", + "members": { + "Configuration": { + "target": "com.amazonaws.quicksight#LayoutConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that determines what the type of layout for a sheet.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A Layout defines the placement of elements within a sheet.

\n

For more information, see Types of layout in the Amazon QuickSight User Guide.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#LayoutConfiguration": { + "type": "structure", + "members": { + "GridLayout": { + "target": "com.amazonaws.quicksight#GridLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

A type of layout that can be used on a sheet. In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: FIXED or RESPONSIVE.

" + } + }, + "FreeFormLayout": { + "target": "com.amazonaws.quicksight#FreeFormLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.

" + } + }, + "SectionBasedLayout": { + "target": "com.amazonaws.quicksight#SectionBasedLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

A section based layout organizes visuals into multiple sections and has customized header, footer and page break.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration that determines what the type of layout will be used on a sheet.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#LayoutElementType": { + "type": "enum", + "members": { + "VISUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VISUAL" + } + }, + "FILTER_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILTER_CONTROL" + } + }, + "PARAMETER_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARAMETER_CONTROL" + } + }, + "TEXT_BOX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT_BOX" + } + } + } + }, + "com.amazonaws.quicksight#LayoutList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Layout" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#LegendOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines whether or not the legend is visible.

" + } + }, + "Title": { + "target": "com.amazonaws.quicksight#LabelOptions", + "traits": { + "smithy.api#documentation": "

The custom title for the legend.

" + } + }, + "Position": { + "target": "com.amazonaws.quicksight#LegendPosition", + "traits": { + "smithy.api#documentation": "

The positions for the legend. Choose one of the following\n options:

\n " + } + }, + "Width": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The width of the legend. If this value is omitted, a default width is used when rendering.

" + } + }, + "Height": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The height of the legend. If this value is omitted, a default height is used when\n rendering.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for the legend setup of a visual.

" + } + }, + "com.amazonaws.quicksight#LegendPosition": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "RIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RIGHT" + } + }, + "BOTTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTTOM" + } + }, + "TOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOP" + } + } + } + }, + "com.amazonaws.quicksight#Length": { + "type": "string", + "traits": { + "smithy.api#documentation": "String based length that is composed of value and unit" + } + }, + "com.amazonaws.quicksight#LimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "ResourceType": { + "target": "com.amazonaws.quicksight#ExceptionResourceType", + "traits": { + "smithy.api#documentation": "

Limit exceeded.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A limit is exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.quicksight#LimitedString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#LineChartAggregatedFieldWells": { + "type": "structure", + "members": { + "Category": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The category field wells of a line chart. Values are grouped by category fields.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The value field wells of a line chart. Values are aggregated based on categories.

" + } + }, + "Colors": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The color field wells of a line chart. Values are grouped by category fields.

" + } + }, + "SmallMultiples": { + "target": "com.amazonaws.quicksight#SmallMultiplesDimensionFieldList", + "traits": { + "smithy.api#documentation": "

The small multiples field well of a line chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a line chart.

" + } + }, + "com.amazonaws.quicksight#LineChartConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#LineChartFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a line chart.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#LineChartSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a line chart.

" + } + }, + "ForecastConfigurations": { + "target": "com.amazonaws.quicksight#ForecastConfigurationList", + "traits": { + "smithy.api#documentation": "

The forecast configuration of a line chart.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#LineChartType", + "traits": { + "smithy.api#documentation": "

Determines the type of the line chart.

" + } + }, + "SmallMultiplesOptions": { + "target": "com.amazonaws.quicksight#SmallMultiplesOptions", + "traits": { + "smithy.api#documentation": "

The small multiples setup for the visual.

" + } + }, + "XAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the x-axis.

" + } + }, + "XAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the x-axis label.

" + } + }, + "PrimaryYAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#LineSeriesAxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The series axis configuration of a line chart.

" + } + }, + "PrimaryYAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the y-axis label.

" + } + }, + "SecondaryYAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#LineSeriesAxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The series axis configuration of a line chart.

" + } + }, + "SecondaryYAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the secondary y-axis label.

" + } + }, + "SingleAxisOptions": { + "target": "com.amazonaws.quicksight#SingleAxisOptions" + }, + "DefaultSeriesSettings": { + "target": "com.amazonaws.quicksight#LineChartDefaultSeriesSettings", + "traits": { + "smithy.api#documentation": "

The options that determine the default presentation of all line series in LineChartVisual.

" + } + }, + "Series": { + "target": "com.amazonaws.quicksight#SeriesItemList", + "traits": { + "smithy.api#documentation": "

The series item configuration of a line chart.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "

The legend configuration of a line chart.

" + } + }, + "DataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The data label configuration of a line chart.

" + } + }, + "ReferenceLines": { + "target": "com.amazonaws.quicksight#ReferenceLineList", + "traits": { + "smithy.api#documentation": "

The reference lines configuration of a line chart.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The tooltip configuration of a line chart.

" + } + }, + "ContributionAnalysisDefaults": { + "target": "com.amazonaws.quicksight#ContributionAnalysisDefaultList", + "traits": { + "smithy.api#documentation": "

The default configuration of a line chart's contribution analysis.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "

The visual palette configuration of a line chart.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a line chart.

" + } + }, + "com.amazonaws.quicksight#LineChartDefaultSeriesSettings": { + "type": "structure", + "members": { + "AxisBinding": { + "target": "com.amazonaws.quicksight#AxisBinding", + "traits": { + "smithy.api#documentation": "

The axis to which you are binding all line series to.

" + } + }, + "LineStyleSettings": { + "target": "com.amazonaws.quicksight#LineChartLineStyleSettings", + "traits": { + "smithy.api#documentation": "

Line styles options for all line series in the visual.

" + } + }, + "MarkerStyleSettings": { + "target": "com.amazonaws.quicksight#LineChartMarkerStyleSettings", + "traits": { + "smithy.api#documentation": "

Marker styles options for all line series in the visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the default presentation of all line series in LineChartVisual.

" + } + }, + "com.amazonaws.quicksight#LineChartFieldWells": { + "type": "structure", + "members": { + "LineChartAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#LineChartAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a line chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a line chart.

" + } + }, + "com.amazonaws.quicksight#LineChartLineStyle": { + "type": "enum", + "members": { + "SOLID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOLID" + } + }, + "DOTTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOTTED" + } + }, + "DASHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DASHED" + } + } + } + }, + "com.amazonaws.quicksight#LineChartLineStyleSettings": { + "type": "structure", + "members": { + "LineVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Configuration option that determines whether to show the line for the series.

" + } + }, + "LineInterpolation": { + "target": "com.amazonaws.quicksight#LineInterpolation", + "traits": { + "smithy.api#documentation": "

Interpolation style for line series.

\n " + } + }, + "LineStyle": { + "target": "com.amazonaws.quicksight#LineChartLineStyle", + "traits": { + "smithy.api#documentation": "

Line style for line series.

\n " + } + }, + "LineWidth": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

Width that determines the line thickness.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Line styles options for a line series in LineChartVisual.

" + } + }, + "com.amazonaws.quicksight#LineChartMarkerShape": { + "type": "enum", + "members": { + "CIRCLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CIRCLE" + } + }, + "TRIANGLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRIANGLE" + } + }, + "SQUARE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQUARE" + } + }, + "DIAMOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIAMOND" + } + }, + "ROUNDED_SQUARE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROUNDED_SQUARE" + } + } + } + }, + "com.amazonaws.quicksight#LineChartMarkerStyleSettings": { + "type": "structure", + "members": { + "MarkerVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Configuration option that determines whether to show the markers in the series.

" + } + }, + "MarkerShape": { + "target": "com.amazonaws.quicksight#LineChartMarkerShape", + "traits": { + "smithy.api#documentation": "

Shape option for markers in the series.

\n " + } + }, + "MarkerSize": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

Size of marker in the series.

" + } + }, + "MarkerColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

Color of marker in the series.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Marker styles options for a line series in LineChartVisual.

" + } + }, + "com.amazonaws.quicksight#LineChartSeriesSettings": { + "type": "structure", + "members": { + "LineStyleSettings": { + "target": "com.amazonaws.quicksight#LineChartLineStyleSettings", + "traits": { + "smithy.api#documentation": "

Line styles options for a line series in LineChartVisual.

" + } + }, + "MarkerStyleSettings": { + "target": "com.amazonaws.quicksight#LineChartMarkerStyleSettings", + "traits": { + "smithy.api#documentation": "

Marker styles options for a line series in LineChartVisual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of a line series in the visual

" + } + }, + "com.amazonaws.quicksight#LineChartSortConfiguration": { + "type": "structure", + "members": { + "CategorySort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the category fields.

" + } + }, + "CategoryItemsLimitConfiguration": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of categories that are displayed in a line chart.

" + } + }, + "ColorItemsLimitConfiguration": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of lines that are displayed in a line chart.

" + } + }, + "SmallMultiplesSort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the small multiples field.

" + } + }, + "SmallMultiplesLimitConfiguration": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of small multiples panels that are displayed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a line chart.

" + } + }, + "com.amazonaws.quicksight#LineChartType": { + "type": "enum", + "members": { + "LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINE" + } + }, + "AREA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AREA" + } + }, + "STACKED_AREA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STACKED_AREA" + } + } + } + }, + "com.amazonaws.quicksight#LineChartVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#LineChartConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of a line chart.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A line chart.

\n

For more information, see Using line charts in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#LineInterpolation": { + "type": "enum", + "members": { + "LINEAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINEAR" + } + }, + "SMOOTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMOOTH" + } + }, + "STEPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STEPPED" + } + } + } + }, + "com.amazonaws.quicksight#LineSeriesAxisDisplayOptions": { + "type": "structure", + "members": { + "AxisOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the line series axis.

" + } + }, + "MissingDataConfigurations": { + "target": "com.amazonaws.quicksight#MissingDataConfigurationList", + "traits": { + "smithy.api#documentation": "

The configuration options that determine how missing data is treated during the rendering of a line chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The series axis configuration of a line chart.

" + } + }, + "com.amazonaws.quicksight#LinkEntityArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws[\\w\\-]*:quicksight:[\\w\\-]+:\\d+:analysis/[\\w\\-]{1,512}$" + } + }, + "com.amazonaws.quicksight#LinkEntityArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#LinkEntityArn" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.quicksight#LinkSharingConfiguration": { + "type": "structure", + "members": { + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A structure that contains the permissions of a shareable link.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the configuration of a shareable link to the dashboard.

" + } + }, + "com.amazonaws.quicksight#ListAnalyses": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListAnalysesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListAnalysesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/analyses", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AnalysisSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListAnalysesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analyses.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListAnalysesResponse": { + "type": "structure", + "members": { + "AnalysisSummaryList": { + "target": "com.amazonaws.quicksight#AnalysisSummaryList", + "traits": { + "smithy.api#documentation": "

Metadata describing each of the analyses that are listed.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListAssetBundleExportJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListAssetBundleExportJobsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListAssetBundleExportJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/asset-bundle-export-jobs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AssetBundleExportJobSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListAssetBundleExportJobsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that the export jobs were executed in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListAssetBundleExportJobsResponse": { + "type": "structure", + "members": { + "AssetBundleExportJobSummaryList": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobSummaryList", + "traits": { + "smithy.api#documentation": "

A list of export job summaries.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListAssetBundleImportJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListAssetBundleImportJobsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListAssetBundleImportJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/asset-bundle-import-jobs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AssetBundleImportJobSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListAssetBundleImportJobsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that the import jobs were executed in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListAssetBundleImportJobsResponse": { + "type": "structure", + "members": { + "AssetBundleImportJobSummaryList": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobSummaryList", + "traits": { + "smithy.api#documentation": "

A list of import job summaries.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the response.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListControlDisplayOptions": { + "type": "structure", + "members": { + "SearchOptions": { + "target": "com.amazonaws.quicksight#ListControlSearchOptions", + "traits": { + "smithy.api#documentation": "

The configuration of the search options in a list control.

" + } + }, + "SelectAllOptions": { + "target": "com.amazonaws.quicksight#ListControlSelectAllOptions", + "traits": { + "smithy.api#documentation": "

The configuration of the Select all options in a list control.

" + } + }, + "TitleOptions": { + "target": "com.amazonaws.quicksight#LabelOptions", + "traits": { + "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" + } + }, + "InfoIconLabelOptions": { + "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", + "traits": { + "smithy.api#documentation": "

The configuration of info icon label options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "com.amazonaws.quicksight#ListControlSearchOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility configuration of the search options in a list control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of the search options in a list control.

" + } + }, + "com.amazonaws.quicksight#ListControlSelectAllOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility configuration of the Select all options in a list control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of the Select all options in a list control.

" + } + }, + "com.amazonaws.quicksight#ListDashboardVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListDashboardVersionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListDashboardVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the versions of the dashboards in the Amazon QuickSight subscription.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/versions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DashboardVersionSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListDashboardVersionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're listing versions\n for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListDashboardVersionsResponse": { + "type": "structure", + "members": { + "DashboardVersionSummaryList": { + "target": "com.amazonaws.quicksight#DashboardVersionSummaryList", + "traits": { + "smithy.api#documentation": "

A structure that contains information about each version of the dashboard.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListDashboards": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListDashboardsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListDashboardsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists dashboards in an Amazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/dashboards", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DashboardSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListDashboardsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboards that you're\n listing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListDashboardsResponse": { + "type": "structure", + "members": { + "DashboardSummaryList": { + "target": "com.amazonaws.quicksight#DashboardSummaryList", + "traits": { + "smithy.api#documentation": "

A structure that contains all of the dashboards in your Amazon Web Services account. This structure\n provides basic information about the dashboards.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListDataSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListDataSetsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListDataSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.

\n

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DataSetSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListDataSetsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListDataSetsResponse": { + "type": "structure", + "members": { + "DataSetSummaries": { + "target": "com.amazonaws.quicksight#DataSetSummaryList", + "traits": { + "smithy.api#documentation": "

The list of dataset summaries.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListDataSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListDataSourcesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListDataSourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DataSources", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListDataSourcesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListDataSourcesResponse": { + "type": "structure", + "members": { + "DataSources": { + "target": "com.amazonaws.quicksight#DataSourceList", + "traits": { + "smithy.api#documentation": "

A list of data sources.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListFolderMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListFolderMembersRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListFolderMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/members", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FolderMemberList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListFolderMembersRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListFolderMembersResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "FolderMemberList": { + "target": "com.amazonaws.quicksight#FolderMemberList", + "traits": { + "smithy.api#documentation": "

A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListFolders": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListFoldersRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListFoldersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all folders in an account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/folders", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FolderSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListFoldersRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListFoldersResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "FolderSummaryList": { + "target": "com.amazonaws.quicksight#FolderSummaryList", + "traits": { + "smithy.api#documentation": "

A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListGroupMemberships": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListGroupMembershipsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListGroupMembershipsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists member users in a group.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "GroupMemberList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListGroupMembershipsRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group that you want to see a membership list of.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return from this request.

", + "smithy.api#httpQuery": "max-results" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the group that you want a list of users from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListGroupMembershipsResponse": { + "type": "structure", + "members": { + "GroupMemberList": { + "target": "com.amazonaws.quicksight#GroupMemberList", + "traits": { + "smithy.api#documentation": "

The list of the members of the group.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListGroupsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all user groups in Amazon QuickSight.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "GroupList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListGroupsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "max-results" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that you want a list of groups from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListGroupsResponse": { + "type": "structure", + "members": { + "GroupList": { + "target": "com.amazonaws.quicksight#GroupList", + "traits": { + "smithy.api#documentation": "

The list of the groups.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListIAMPolicyAssignments": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListIAMPolicyAssignmentsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListIAMPolicyAssignmentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the\n\t\t\tIAM policy assignments in the current Amazon QuickSight\n\t\t\taccount.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/v2/iam-policy-assignments", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IAMPolicyAssignments", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUserRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConcurrentUpdatingException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all of\n\t\t\tthe IAM policy assignments, including the Amazon\n\t\t\tResource Names\n\t\t\t(ARNs),\n\t\t\tfor the IAM policies assigned to the specified user and\n\t\t\tgroup,\n\t\t\tor groups that the user belongs to.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/iam-policy-assignments", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ActiveAssignments", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUserRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the assignments.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "UserName": { + "target": "com.amazonaws.quicksight#UserName", + "traits": { + "smithy.api#documentation": "

The name of the user.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the assignment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUserResponse": { + "type": "structure", + "members": { + "ActiveAssignments": { + "target": "com.amazonaws.quicksight#ActiveIAMPolicyAssignmentList", + "traits": { + "smithy.api#documentation": "

The active assignments for this user.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListIAMPolicyAssignmentsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains these IAM policy\n\t\t\tassignments.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", + "traits": { + "smithy.api#documentation": "

The status of the assignments.

", + "smithy.api#httpQuery": "assignment-status" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace for the assignments.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListIAMPolicyAssignmentsResponse": { + "type": "structure", + "members": { + "IAMPolicyAssignments": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentSummaryList", + "traits": { + "smithy.api#documentation": "

Information describing the IAM policy assignments.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListIdentityPropagationConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListIdentityPropagationConfigsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListIdentityPropagationConfigsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.

\n

This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/identity-propagation-config", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#ListIdentityPropagationConfigsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contain the identity propagation configurations of.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#ListIdentityPropagationMaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to be returned.

", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListIdentityPropagationConfigsResponse": { + "type": "structure", + "members": { + "Services": { + "target": "com.amazonaws.quicksight#AuthorizedTargetsByServices", + "traits": { + "smithy.api#documentation": "

A list of services and their authorized targets that the Amazon QuickSight IAM Identity Center application can access.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListIdentityPropagationMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#ListIngestions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListIngestionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListIngestionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the history of SPICE ingestions for a dataset.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Ingestions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListIngestionsRequest": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the dataset used in the ingestion.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#IngestionMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListIngestionsResponse": { + "type": "structure", + "members": { + "Ingestions": { + "target": "com.amazonaws.quicksight#Ingestions", + "traits": { + "smithy.api#documentation": "

A list of the ingestions.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListNamespaces": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListNamespacesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListNamespacesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Namespaces", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListNamespacesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous ListNameSpaces API call if there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListNamespacesResponse": { + "type": "structure", + "members": { + "Namespaces": { + "target": "com.amazonaws.quicksight#Namespaces", + "traits": { + "smithy.api#documentation": "

The information about the namespaces in this Amazon Web Services account. The response includes \n the namespace ARN, name, Amazon Web Services Region, notification email address, creation status, and \n identity store.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A unique pagination token that can be used in a subsequent request. Receiving NextToken in your response inticates that there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListRefreshSchedules": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListRefreshSchedulesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListRefreshSchedulesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#ListRefreshSchedulesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListRefreshSchedulesResponse": { + "type": "structure", + "members": { + "RefreshSchedules": { + "target": "com.amazonaws.quicksight#RefreshSchedules", + "traits": { + "smithy.api#documentation": "

The list of refresh schedules for the dataset.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListRoleMemberships": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListRoleMembershipsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListRoleMembershipsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all groups that are associated with a role.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MembersList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListRoleMembershipsRequest": { + "type": "structure", + "members": { + "Role": { + "target": "com.amazonaws.quicksight#Role", + "traits": { + "smithy.api#documentation": "

The name of the role.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "max-results" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that includes the role.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListRoleMembershipsResponse": { + "type": "structure", + "members": { + "MembersList": { + "target": "com.amazonaws.quicksight#GroupsList", + "traits": { + "smithy.api#documentation": "

The list of groups associated with a role

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags assigned to a resource.

", + "smithy.api#http": { + "method": "GET", + "uri": "/resources/{ResourceArn}/tags", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want a list of tags for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the\n\t\t\tresource.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListTemplateAliases": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListTemplateAliasesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListTemplateAliasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the aliases of a template.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/aliases", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TemplateAliasList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListTemplateAliasesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template aliases that you're listing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-result" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListTemplateAliasesResponse": { + "type": "structure", + "members": { + "TemplateAliasList": { + "target": "com.amazonaws.quicksight#TemplateAliasList", + "traits": { + "smithy.api#documentation": "

A structure containing the list of the template's aliases.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListTemplateVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListTemplateVersionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListTemplateVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the versions of the templates in the current Amazon QuickSight account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/versions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TemplateVersionSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListTemplateVersionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the templates that you're listing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListTemplateVersionsResponse": { + "type": "structure", + "members": { + "TemplateVersionSummaryList": { + "target": "com.amazonaws.quicksight#TemplateVersionSummaryList", + "traits": { + "smithy.api#documentation": "

A structure containing a list of all the versions of the specified template.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListTemplatesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListTemplatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the templates in the current Amazon QuickSight account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/templates", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TemplateSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListTemplatesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the templates that you're listing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-result" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListTemplatesResponse": { + "type": "structure", + "members": { + "TemplateSummaryList": { + "target": "com.amazonaws.quicksight#TemplateSummaryList", + "traits": { + "smithy.api#documentation": "

A structure containing information about the templates in the list.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListThemeAliases": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListThemeAliasesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListThemeAliasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the aliases of a theme.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/aliases", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#ListThemeAliasesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme aliases that you're listing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-result" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListThemeAliasesResponse": { + "type": "structure", + "members": { + "ThemeAliasList": { + "target": "com.amazonaws.quicksight#ThemeAliasList", + "traits": { + "smithy.api#documentation": "

A structure containing the list of the theme's aliases.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListThemeVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListThemeVersionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListThemeVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the versions of the themes in the current Amazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/versions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ThemeVersionSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListThemeVersionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the themes that you're listing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListThemeVersionsResponse": { + "type": "structure", + "members": { + "ThemeVersionSummaryList": { + "target": "com.amazonaws.quicksight#ThemeVersionSummaryList", + "traits": { + "smithy.api#documentation": "

A structure containing a list of all the versions of the specified theme.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListThemes": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListThemesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListThemesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the themes in the current Amazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/themes", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ThemeSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListThemesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the themes that you're listing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#ThemeType", + "traits": { + "smithy.api#documentation": "

The type of themes that you want to list. Valid options include the following:

\n ", + "smithy.api#httpQuery": "type" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListThemesResponse": { + "type": "structure", + "members": { + "ThemeSummaryList": { + "target": "com.amazonaws.quicksight#ThemeSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the themes in the list.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListTopicRefreshSchedules": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListTopicRefreshSchedulesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListTopicRefreshSchedulesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all of the refresh schedules for a topic.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#ListTopicRefreshSchedulesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic whose refresh schedule\n you want described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListTopicRefreshSchedulesResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "RefreshSchedules": { + "target": "com.amazonaws.quicksight#TopicRefreshScheduleSummaries", + "traits": { + "smithy.api#documentation": "

The list of topic refresh schedules.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListTopicReviewedAnswers": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListTopicReviewedAnswersRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListTopicReviewedAnswersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all reviewed answers for a Q Topic.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/reviewed-answers", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#ListTopicReviewedAnswersRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that containd the reviewed answers that you want listed.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListTopicReviewedAnswersResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "Answers": { + "target": "com.amazonaws.quicksight#TopicReviewedAnswers", + "traits": { + "smithy.api#documentation": "

The definition of all Answers in the topic.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListTopics": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListTopicsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListTopicsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all of the topics within an account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/topics", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListTopicsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topics that you want to\n list.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListTopicsResponse": { + "type": "structure", + "members": { + "TopicsSummaries": { + "target": "com.amazonaws.quicksight#TopicSummaries", + "traits": { + "smithy.api#documentation": "

A list of topic summaries.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListUserGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListUserGroupsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListUserGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/groups", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "GroupList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListUserGroupsRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.quicksight#UserName", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight user name that you want to list group memberships for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account\n\t\t\tthat contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return from this request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListUserGroupsResponse": { + "type": "structure", + "members": { + "GroupList": { + "target": "com.amazonaws.quicksight#GroupList", + "traits": { + "smithy.api#documentation": "

The list of groups the user is a member of.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListUsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListUsersRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListUsersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all of the Amazon QuickSight users belonging to this account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "UserList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListUsersRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return from this request.

", + "smithy.api#httpQuery": "max-results" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListUsersResponse": { + "type": "structure", + "members": { + "UserList": { + "target": "com.amazonaws.quicksight#UserList", + "traits": { + "smithy.api#documentation": "

The list of users.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListVPCConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListVPCConnectionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListVPCConnectionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all of the VPC connections in the current set Amazon Web Services Region of an\n\t\t\t\tAmazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/vpc-connections", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListVPCConnectionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the account that contains the VPC connections\n\t\t\tthat you want to list.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListVPCConnectionsResponse": { + "type": "structure", + "members": { + "VPCConnectionSummaries": { + "target": "com.amazonaws.quicksight#VPCConnectionSummaryList", + "traits": { + "smithy.api#documentation": "

A VPCConnectionSummaries object that returns a summary of VPC connection\n\t\t\tobjects.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more\n\t\t\tresults.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#LoadingAnimation": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility configuration of LoadingAnimation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of loading animation in free-form layout.

" + } + }, + "com.amazonaws.quicksight#LocalNavigationConfiguration": { + "type": "structure", + "members": { + "TargetSheetId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The sheet that is targeted for navigation in the same analysis.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The navigation configuration for CustomActionNavigationOperation.

" + } + }, + "com.amazonaws.quicksight#LogicalTable": { + "type": "structure", + "members": { + "Alias": { + "target": "com.amazonaws.quicksight#LogicalTableAlias", + "traits": { + "smithy.api#documentation": "

A display name for the logical table.

", + "smithy.api#required": {} + } + }, + "DataTransforms": { + "target": "com.amazonaws.quicksight#TransformOperationList", + "traits": { + "smithy.api#documentation": "

Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.

" + } + }, + "Source": { + "target": "com.amazonaws.quicksight#LogicalTableSource", + "traits": { + "smithy.api#documentation": "

Source of this logical table.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A logical table is a unit that joins and that data\n transformations operate on. A logical table has a source, which can be either a physical\n table or result of a join. When a logical table points to a physical table, the logical\n table acts as a mutable copy of that physical table through transform operations.

" + } + }, + "com.amazonaws.quicksight#LogicalTableAlias": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#LogicalTableId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

An identifier for the logical table that is defined in the dataset

", + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-]*$" + } + }, + "com.amazonaws.quicksight#LogicalTableMap": { + "type": "map", + "key": { + "target": "com.amazonaws.quicksight#LogicalTableId" + }, + "value": { + "target": "com.amazonaws.quicksight#LogicalTable" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#LogicalTableSource": { + "type": "structure", + "members": { + "JoinInstruction": { + "target": "com.amazonaws.quicksight#JoinInstruction", + "traits": { + "smithy.api#documentation": "

Specifies the result of a join of two logical tables.

" + } + }, + "PhysicalTableId": { + "target": "com.amazonaws.quicksight#PhysicalTableId", + "traits": { + "smithy.api#documentation": "

Physical table ID.

" + } + }, + "DataSetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the parent dataset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the source of a logical table. This is a variant type structure. For\n this structure to be valid, only one of the attributes can be non-null.

" + } + }, + "com.amazonaws.quicksight#Long": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.quicksight#LongFormatText": { + "type": "structure", + "members": { + "PlainText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

Plain text format.

" + } + }, + "RichText": { + "target": "com.amazonaws.quicksight#LongRichText", + "traits": { + "smithy.api#documentation": "

Rich text. Examples of rich text include bold, underline, and italics.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The text format for a subtitle.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#LongPlainText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.quicksight#LongRichText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#Longitude": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": -1800, + "max": 1800 + } + } + }, + "com.amazonaws.quicksight#LookbackWindow": { + "type": "structure", + "members": { + "ColumnName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of the lookback window column.

", + "smithy.api#required": {} + } + }, + "Size": { + "target": "com.amazonaws.quicksight#PositiveLong", + "traits": { + "smithy.api#documentation": "

The lookback window column size.

", + "smithy.api#required": {} + } + }, + "SizeUnit": { + "target": "com.amazonaws.quicksight#LookbackWindowSizeUnit", + "traits": { + "smithy.api#documentation": "

The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The lookback window setup of an incremental refresh configuration.

" + } + }, + "com.amazonaws.quicksight#LookbackWindowSizeUnit": { + "type": "enum", + "members": { + "HOUR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOUR" + } + }, + "DAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAY" + } + }, + "WEEK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEEK" + } + } + } + }, + "com.amazonaws.quicksight#ManifestFileLocation": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.quicksight#S3Bucket", + "traits": { + "smithy.api#documentation": "

Amazon S3 bucket.

", + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.quicksight#S3Key", + "traits": { + "smithy.api#documentation": "

Amazon S3 key that identifies an object.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Amazon S3 manifest file location.

" + } + }, + "com.amazonaws.quicksight#MapZoomMode": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + } + } + }, + "com.amazonaws.quicksight#MappedDataSetParameter": { + "type": "structure", + "members": { + "DataSetIdentifier": { + "target": "com.amazonaws.quicksight#DataSetIdentifier", + "traits": { + "smithy.api#documentation": "

A unique name that identifies a dataset within the analysis or dashboard.

", + "smithy.api#required": {} + } + }, + "DataSetParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The name of the dataset parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A dataset parameter that is mapped to an analysis parameter.

" + } + }, + "com.amazonaws.quicksight#MappedDataSetParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MappedDataSetParameter" + }, + "traits": { + "smithy.api#documentation": "

A list of dataset parameters that are mapped to an analysis parameter.

", + "smithy.api#length": { + "min": 0, + "max": 150 + } + } + }, + "com.amazonaws.quicksight#MarginStyle": { + "type": "structure", + "members": { + "Show": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

This Boolean value controls whether to display sheet margins.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options for margins around the outside edge of sheets.

" + } + }, + "com.amazonaws.quicksight#MariaDbParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

Host.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

Port.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

Database.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for MariaDB.

" + } + }, + "com.amazonaws.quicksight#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#MaximumLabelType": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the maximum label.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The maximum label of a data path label.

" + } + }, + "com.amazonaws.quicksight#MaximumMinimumComputation": { + "type": "structure", + "members": { + "ComputationId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for a computation.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of a computation.

" + } + }, + "Time": { + "target": "com.amazonaws.quicksight#DimensionField", + "traits": { + "smithy.api#documentation": "

The time field that is used in a computation.

" + } + }, + "Value": { + "target": "com.amazonaws.quicksight#MeasureField", + "traits": { + "smithy.api#documentation": "

The value field that is used in a computation.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#MaximumMinimumComputationType", + "traits": { + "smithy.api#documentation": "

The type of computation. Choose one of the following options:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The maximum and minimum computation configuration.

" + } + }, + "com.amazonaws.quicksight#MaximumMinimumComputationType": { + "type": "enum", + "members": { + "MAXIMUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAXIMUM" + } + }, + "MINIMUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MINIMUM" + } + } + } + }, + "com.amazonaws.quicksight#MeasureField": { + "type": "structure", + "members": { + "NumericalMeasureField": { + "target": "com.amazonaws.quicksight#NumericalMeasureField", + "traits": { + "smithy.api#documentation": "

The measure type field with numerical type columns.

" + } + }, + "CategoricalMeasureField": { + "target": "com.amazonaws.quicksight#CategoricalMeasureField", + "traits": { + "smithy.api#documentation": "

The measure type field with categorical type columns.

" + } + }, + "DateMeasureField": { + "target": "com.amazonaws.quicksight#DateMeasureField", + "traits": { + "smithy.api#documentation": "

The measure type field with date type columns.

" + } + }, + "CalculatedMeasureField": { + "target": "com.amazonaws.quicksight#CalculatedMeasureField", + "traits": { + "smithy.api#documentation": "

The calculated measure field only used in pivot tables.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The measure (metric) type field.

" + } + }, + "com.amazonaws.quicksight#MeasureFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MeasureField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#MemberIdArnPair": { + "type": "structure", + "members": { + "MemberId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the member.

" + } + }, + "MemberArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the member.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that consists of a member Amazon Resource Name (ARN) and a member ID.

" + } + }, + "com.amazonaws.quicksight#MemberType": { + "type": "enum", + "members": { + "DASHBOARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DASHBOARD" + } + }, + "ANALYSIS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANALYSIS" + } + }, + "DATASET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATASET" + } + }, + "DATASOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATASOURCE" + } + }, + "TOPIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOPIC" + } + } + } + }, + "com.amazonaws.quicksight#MetricComparisonComputation": { + "type": "structure", + "members": { + "ComputationId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for a computation.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of a computation.

" + } + }, + "Time": { + "target": "com.amazonaws.quicksight#DimensionField", + "traits": { + "smithy.api#documentation": "

The time field that is used in a computation.

" + } + }, + "FromValue": { + "target": "com.amazonaws.quicksight#MeasureField", + "traits": { + "smithy.api#documentation": "

The field that is used in a metric comparison from value setup.

" + } + }, + "TargetValue": { + "target": "com.amazonaws.quicksight#MeasureField", + "traits": { + "smithy.api#documentation": "

The field that is used in a metric comparison to value setup.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metric comparison computation configuration.

" + } + }, + "com.amazonaws.quicksight#MinimumLabelType": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the minimum label.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum label of a data path label.

" + } + }, + "com.amazonaws.quicksight#MissingDataConfiguration": { + "type": "structure", + "members": { + "TreatmentOption": { + "target": "com.amazonaws.quicksight#MissingDataTreatmentOption", + "traits": { + "smithy.api#documentation": "

The treatment option that determines how missing data should be rendered. Choose\n from the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration options that determine how missing data is treated during the rendering of a line chart.

" + } + }, + "com.amazonaws.quicksight#MissingDataConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MissingDataConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#MissingDataTreatmentOption": { + "type": "enum", + "members": { + "INTERPOLATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERPOLATE" + } + }, + "SHOW_AS_ZERO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHOW_AS_ZERO" + } + }, + "SHOW_AS_BLANK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHOW_AS_BLANK" + } + } + } + }, + "com.amazonaws.quicksight#MySqlParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

Host.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

Port.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

Database.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for MySQL.

" + } + }, + "com.amazonaws.quicksight#NamedEntityAggType": { + "type": "enum", + "members": { + "SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM" + } + }, + "MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIN" + } + }, + "MAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX" + } + }, + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVERAGE" + } + }, + "DISTINCT_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTINCT_COUNT" + } + }, + "STDEV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEV" + } + }, + "STDEVP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEVP" + } + }, + "VAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VAR" + } + }, + "VARP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARP" + } + }, + "PERCENTILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENTILE" + } + }, + "MEDIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIAN" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } + } + }, + "com.amazonaws.quicksight#NamedEntityDefinition": { + "type": "structure", + "members": { + "FieldName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The name of the entity.

" + } + }, + "PropertyName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The property name to be used for the named entity.

" + } + }, + "PropertyRole": { + "target": "com.amazonaws.quicksight#PropertyRole", + "traits": { + "smithy.api#documentation": "

The property role. Valid values for this structure are PRIMARY and ID.

" + } + }, + "PropertyUsage": { + "target": "com.amazonaws.quicksight#PropertyUsage", + "traits": { + "smithy.api#documentation": "

The property usage. Valid values for this structure are INHERIT,\n DIMENSION,\n and MEASURE.

" + } + }, + "Metric": { + "target": "com.amazonaws.quicksight#NamedEntityDefinitionMetric", + "traits": { + "smithy.api#documentation": "

The definition of a metric.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a named entity.

" + } + }, + "com.amazonaws.quicksight#NamedEntityDefinitionMetric": { + "type": "structure", + "members": { + "Aggregation": { + "target": "com.amazonaws.quicksight#NamedEntityAggType", + "traits": { + "smithy.api#documentation": "

The aggregation of a named entity. Valid values for this structure are SUM,\n MIN, MAX, COUNT, AVERAGE,\n DISTINCT_COUNT, STDEV, STDEVP, VAR,\n VARP, PERCENTILE,\n MEDIAN,\n and CUSTOM.

" + } + }, + "AggregationFunctionParameters": { + "target": "com.amazonaws.quicksight#AggregationFunctionParameters", + "traits": { + "smithy.api#documentation": "

The additional parameters for an aggregation function.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a metric.

" + } + }, + "com.amazonaws.quicksight#NamedEntityDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#NamedEntityDefinition" + } + }, + "com.amazonaws.quicksight#NamedEntityRef": { + "type": "structure", + "members": { + "NamedEntityName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The NamedEntityName for the NamedEntityRef.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a NamedEntityRef.

" + } + }, + "com.amazonaws.quicksight#NamedFilterAggType": { + "type": "enum", + "members": { + "NO_AGGREGATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_AGGREGATION" + } + }, + "SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM" + } + }, + "AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVERAGE" + } + }, + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "DISTINCT_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTINCT_COUNT" + } + }, + "MAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX" + } + }, + "MEDIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIAN" + } + }, + "MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIN" + } + }, + "STDEV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEV" + } + }, + "STDEVP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEVP" + } + }, + "VAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VAR" + } + }, + "VARP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARP" + } + } + } + }, + "com.amazonaws.quicksight#NamedFilterType": { + "type": "enum", + "members": { + "CATEGORY_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CATEGORY_FILTER" + } + }, + "NUMERIC_EQUALITY_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMERIC_EQUALITY_FILTER" + } + }, + "NUMERIC_RANGE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMERIC_RANGE_FILTER" + } + }, + "DATE_RANGE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE_RANGE_FILTER" + } + }, + "RELATIVE_DATE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RELATIVE_DATE_FILTER" + } + } + } + }, + "com.amazonaws.quicksight#Namespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._-]*$" + } + }, + "com.amazonaws.quicksight#NamespaceError": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#NamespaceErrorType", + "traits": { + "smithy.api#documentation": "

The error type.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The message for the error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Errors that occur during namespace creation.

" + } + }, + "com.amazonaws.quicksight#NamespaceErrorType": { + "type": "enum", + "members": { + "PERMISSION_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERMISSION_DENIED" + } + }, + "INTERNAL_SERVICE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVICE_ERROR" + } + } + } + }, + "com.amazonaws.quicksight#NamespaceInfoV2": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The name of the error.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The namespace ARN.

" + } + }, + "CapacityRegion": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The namespace Amazon Web Services Region.

" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#NamespaceStatus", + "traits": { + "smithy.api#documentation": "

The creation status of a namespace that is not yet completely created.

" + } + }, + "IdentityStore": { + "target": "com.amazonaws.quicksight#IdentityStore", + "traits": { + "smithy.api#documentation": "

The identity store used for the namespace.

" + } + }, + "NamespaceError": { + "target": "com.amazonaws.quicksight#NamespaceError", + "traits": { + "smithy.api#documentation": "

An error that occurred when the namespace was created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The error type.

" + } + }, + "com.amazonaws.quicksight#NamespaceStatus": { + "type": "enum", + "members": { + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "RETRYABLE_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRYABLE_FAILURE" + } + }, + "NON_RETRYABLE_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NON_RETRYABLE_FAILURE" + } + } + } + }, + "com.amazonaws.quicksight#Namespaces": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#NamespaceInfoV2" + } + }, + "com.amazonaws.quicksight#NarrativeString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 150000 + } + } + }, + "com.amazonaws.quicksight#NegativeFormat": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The prefix for a negative format.

" + } + }, + "Suffix": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The suffix for a negative format.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a negative format.

" + } + }, + "com.amazonaws.quicksight#NegativeValueConfiguration": { + "type": "structure", + "members": { + "DisplayMode": { + "target": "com.amazonaws.quicksight#NegativeValueDisplayMode", + "traits": { + "smithy.api#documentation": "

Determines the display mode of the negative value configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the negative value configuration.

" + } + }, + "com.amazonaws.quicksight#NegativeValueDisplayMode": { + "type": "enum", + "members": { + "POSITIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSITIVE" + } + }, + "NEGATIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEGATIVE" + } + } + } + }, + "com.amazonaws.quicksight#NestedFilter": { + "type": "structure", + "members": { + "FilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "IncludeInnerSet": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A boolean condition to include or exclude the subset that is defined by the values of the nested inner filter.

", + "smithy.api#required": {} + } + }, + "InnerFilter": { + "target": "com.amazonaws.quicksight#InnerFilter", + "traits": { + "smithy.api#documentation": "

The InnerFilter defines the subset of data to be used with the NestedFilter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A NestedFilter filters data with a subset of data that is defined by the nested inner filter.

" + } + }, + "com.amazonaws.quicksight#NetworkInterface": { + "type": "structure", + "members": { + "SubnetId": { + "target": "com.amazonaws.quicksight#SubnetId", + "traits": { + "smithy.api#documentation": "

The subnet ID associated with the network interface.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The availability zone that the network interface resides in.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

An error message.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#NetworkInterfaceStatus", + "traits": { + "smithy.api#documentation": "

The status of the network interface.

" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.quicksight#NetworkInterfaceId", + "traits": { + "smithy.api#documentation": "

The network interface ID.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The structure that contains information about a network interface.

" + } + }, + "com.amazonaws.quicksight#NetworkInterfaceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^eni-[0-9a-z]*$" + } + }, + "com.amazonaws.quicksight#NetworkInterfaceList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#NetworkInterface" + } + }, + "com.amazonaws.quicksight#NetworkInterfaceStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "CREATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "DELETION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETION_FAILED" + } + }, + "DELETION_SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETION_SCHEDULED" + } + }, + "ATTACHMENT_FAILED_ROLLBACK_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTACHMENT_FAILED_ROLLBACK_FAILED" + } + } + } + }, + "com.amazonaws.quicksight#NewDefaultValues": { + "type": "structure", + "members": { + "StringStaticValues": { + "target": "com.amazonaws.quicksight#StringDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "

A list of static default values for a given string parameter.

" + } + }, + "DecimalStaticValues": { + "target": "com.amazonaws.quicksight#DecimalDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "

A list of static default values for a given decimal parameter.

" + } + }, + "DateTimeStaticValues": { + "target": "com.amazonaws.quicksight#DateTimeDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "

A list of static default values for a given date time parameter.

" + } + }, + "IntegerStaticValues": { + "target": "com.amazonaws.quicksight#IntegerDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "

A list of static default values for a given integer parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.

" + } + }, + "com.amazonaws.quicksight#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.quicksight#NonRepeatingVisualsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#NullFilterOption": { + "type": "enum", + "members": { + "ALL_VALUES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_VALUES" + } + }, + "NON_NULLS_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NON_NULLS_ONLY" + } + }, + "NULLS_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NULLS_ONLY" + } + } + } + }, + "com.amazonaws.quicksight#NullString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#NullValueFormatConfiguration": { + "type": "structure", + "members": { + "NullString": { + "target": "com.amazonaws.quicksight#NullString", + "traits": { + "smithy.api#documentation": "

Determines the null string of null values.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the null value format configuration.

" + } + }, + "com.amazonaws.quicksight#NullableBoolean": { + "type": "boolean" + }, + "com.amazonaws.quicksight#NumberDisplayFormatConfiguration": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.quicksight#Prefix", + "traits": { + "smithy.api#documentation": "

Determines the prefix value of the number format.

" + } + }, + "Suffix": { + "target": "com.amazonaws.quicksight#Suffix", + "traits": { + "smithy.api#documentation": "

Determines the suffix value of the number format.

" + } + }, + "SeparatorConfiguration": { + "target": "com.amazonaws.quicksight#NumericSeparatorConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the numeric separator configuration.

" + } + }, + "DecimalPlacesConfiguration": { + "target": "com.amazonaws.quicksight#DecimalPlacesConfiguration", + "traits": { + "smithy.api#documentation": "

The option that determines the decimal places configuration.

" + } + }, + "NumberScale": { + "target": "com.amazonaws.quicksight#NumberScale", + "traits": { + "smithy.api#documentation": "

Determines the number scale value of the number format.

" + } + }, + "NegativeValueConfiguration": { + "target": "com.amazonaws.quicksight#NegativeValueConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the negative value configuration.

" + } + }, + "NullValueFormatConfiguration": { + "target": "com.amazonaws.quicksight#NullValueFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the null value format configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the number display format configuration.

" + } + }, + "com.amazonaws.quicksight#NumberFormatConfiguration": { + "type": "structure", + "members": { + "FormatConfiguration": { + "target": "com.amazonaws.quicksight#NumericFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the numeric format configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Formatting configuration for number fields.

" + } + }, + "com.amazonaws.quicksight#NumberScale": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "THOUSANDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THOUSANDS" + } + }, + "MILLIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MILLIONS" + } + }, + "BILLIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BILLIONS" + } + }, + "TRILLIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRILLIONS" + } + } + } + }, + "com.amazonaws.quicksight#NumericAxisOptions": { + "type": "structure", + "members": { + "Scale": { + "target": "com.amazonaws.quicksight#AxisScale", + "traits": { + "smithy.api#documentation": "

The scale setup of a numeric axis.

" + } + }, + "Range": { + "target": "com.amazonaws.quicksight#AxisDisplayRange", + "traits": { + "smithy.api#documentation": "

The range setup of a numeric axis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for an axis with a numeric field.

" + } + }, + "com.amazonaws.quicksight#NumericEqualityDrillDownFilter": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The value of the double input numeric drill down filter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The numeric equality type drill down filter.

" + } + }, + "com.amazonaws.quicksight#NumericEqualityFilter": { + "type": "structure", + "members": { + "FilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The input value.

" + } + }, + "SelectAllOptions": { + "target": "com.amazonaws.quicksight#NumericFilterSelectAllOptions", + "traits": { + "smithy.api#documentation": "

Select all of the values. Null is not the assigned value of select all.

\n " + } + }, + "MatchOperator": { + "target": "com.amazonaws.quicksight#NumericEqualityMatchOperator", + "traits": { + "smithy.api#documentation": "

The match operator that is used to determine if a filter should be applied.

", + "smithy.api#required": {} + } + }, + "AggregationFunction": { + "target": "com.amazonaws.quicksight#AggregationFunction", + "traits": { + "smithy.api#documentation": "

The aggregation function of the filter.

" + } + }, + "ParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The parameter whose value should be used for the filter value.

" + } + }, + "NullOption": { + "target": "com.amazonaws.quicksight#FilterNullOption", + "traits": { + "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", + "smithy.api#required": {} + } + }, + "DefaultFilterControlConfiguration": { + "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", + "traits": { + "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A NumericEqualityFilter filters values that are equal to the specified value.

" + } + }, + "com.amazonaws.quicksight#NumericEqualityMatchOperator": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + }, + "DOES_NOT_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOES_NOT_EQUAL" + } + } + } + }, + "com.amazonaws.quicksight#NumericFilterSelectAllOptions": { + "type": "enum", + "members": { + "FILTER_ALL_VALUES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILTER_ALL_VALUES" + } + } + } + }, + "com.amazonaws.quicksight#NumericFormatConfiguration": { + "type": "structure", + "members": { + "NumberDisplayFormatConfiguration": { + "target": "com.amazonaws.quicksight#NumberDisplayFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the number display format configuration.

" + } + }, + "CurrencyDisplayFormatConfiguration": { + "target": "com.amazonaws.quicksight#CurrencyDisplayFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the currency display format configuration.

" + } + }, + "PercentageDisplayFormatConfiguration": { + "target": "com.amazonaws.quicksight#PercentageDisplayFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the percentage display format configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the numeric format configuration.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#NumericRangeFilter": { + "type": "structure", + "members": { + "FilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "IncludeMinimum": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Determines whether the minimum value in the filter value range should be included in the filtered results.

" + } + }, + "IncludeMaximum": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Determines whether the maximum value in the filter value range should be included in the filtered results.

" + } + }, + "RangeMinimum": { + "target": "com.amazonaws.quicksight#NumericRangeFilterValue", + "traits": { + "smithy.api#documentation": "

The minimum value for the filter value range.

" + } + }, + "RangeMaximum": { + "target": "com.amazonaws.quicksight#NumericRangeFilterValue", + "traits": { + "smithy.api#documentation": "

The maximum value for the filter value range.

" + } + }, + "SelectAllOptions": { + "target": "com.amazonaws.quicksight#NumericFilterSelectAllOptions", + "traits": { + "smithy.api#documentation": "

Select all of the values. Null is not the assigned value of select all.

\n " + } + }, + "AggregationFunction": { + "target": "com.amazonaws.quicksight#AggregationFunction", + "traits": { + "smithy.api#documentation": "

The aggregation function of the filter.

" + } + }, + "NullOption": { + "target": "com.amazonaws.quicksight#FilterNullOption", + "traits": { + "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", + "smithy.api#required": {} + } + }, + "DefaultFilterControlConfiguration": { + "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", + "traits": { + "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A NumericRangeFilter filters values that are within the value range.

" + } + }, + "com.amazonaws.quicksight#NumericRangeFilterValue": { + "type": "structure", + "members": { + "StaticValue": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The static value of the numeric range filter.

" + } + }, + "Parameter": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The parameter that is used in the numeric range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The value input pf the numeric range filter.

" + } + }, + "com.amazonaws.quicksight#NumericSeparatorConfiguration": { + "type": "structure", + "members": { + "DecimalSeparator": { + "target": "com.amazonaws.quicksight#NumericSeparatorSymbol", + "traits": { + "smithy.api#documentation": "

Determines the decimal separator.

" + } + }, + "ThousandsSeparator": { + "target": "com.amazonaws.quicksight#ThousandSeparatorOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the thousands separator configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the numeric separator configuration.

" + } + }, + "com.amazonaws.quicksight#NumericSeparatorSymbol": { + "type": "enum", + "members": { + "COMMA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMMA" + } + }, + "DOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOT" + } + }, + "SPACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPACE" + } + } + } + }, + "com.amazonaws.quicksight#NumericalAggregationFunction": { + "type": "structure", + "members": { + "SimpleNumericalAggregation": { + "target": "com.amazonaws.quicksight#SimpleNumericalAggregationFunction", + "traits": { + "smithy.api#documentation": "

Built-in aggregation functions for numerical values.

\n " + } + }, + "PercentileAggregation": { + "target": "com.amazonaws.quicksight#PercentileAggregation", + "traits": { + "smithy.api#documentation": "

An aggregation based on the percentile of values in a dimension or measure.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Aggregation for numerical values.

" + } + }, + "com.amazonaws.quicksight#NumericalDimensionField": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The custom field ID.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that is used in the NumericalDimensionField.

", + "smithy.api#required": {} + } + }, + "HierarchyId": { + "target": "com.amazonaws.quicksight#HierarchyId", + "traits": { + "smithy.api#documentation": "

The custom hierarchy ID.

" + } + }, + "FormatConfiguration": { + "target": "com.amazonaws.quicksight#NumberFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The format configuration of the field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The dimension type field with numerical type columns.

" + } + }, + "com.amazonaws.quicksight#NumericalMeasureField": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The custom field ID.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that is used in the NumericalMeasureField.

", + "smithy.api#required": {} + } + }, + "AggregationFunction": { + "target": "com.amazonaws.quicksight#NumericalAggregationFunction", + "traits": { + "smithy.api#documentation": "

The aggregation function of the measure field.

" + } + }, + "FormatConfiguration": { + "target": "com.amazonaws.quicksight#NumberFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The format configuration of the field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The measure type field with numerical type columns.

" + } + }, + "com.amazonaws.quicksight#OnClause": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.quicksight#OperandList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Identifier" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.quicksight#OptionalPort": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 65535 + } + } + }, + "com.amazonaws.quicksight#OracleParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

An Oracle host.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

The port.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

The database.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for Oracle.

" + } + }, + "com.amazonaws.quicksight#OtherCategories": { + "type": "enum", + "members": { + "INCLUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCLUDE" + } + }, + "EXCLUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXCLUDE" + } + } + } + }, + "com.amazonaws.quicksight#OutputColumn": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#ColumnName", + "traits": { + "smithy.api#documentation": "

The display name of the column..

" + } + }, + "Description": { + "target": "com.amazonaws.quicksight#ColumnDescriptiveText", + "traits": { + "smithy.api#documentation": "

A description for a column.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#ColumnDataType", + "traits": { + "smithy.api#documentation": "

The data type of the column.

" + } + }, + "SubType": { + "target": "com.amazonaws.quicksight#ColumnDataSubType", + "traits": { + "smithy.api#documentation": "

The sub data type of the column.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Output column.

" + } + }, + "com.amazonaws.quicksight#OutputColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#OutputColumn" + } + }, + "com.amazonaws.quicksight#OverrideDatasetParameterOperation": { + "type": "structure", + "members": { + "ParameterName": { + "target": "com.amazonaws.quicksight#DatasetParameterName", + "traits": { + "smithy.api#documentation": "

The name of the parameter to be overridden with different values.

", + "smithy.api#required": {} + } + }, + "NewParameterName": { + "target": "com.amazonaws.quicksight#DatasetParameterName", + "traits": { + "smithy.api#documentation": "

The new name for the parameter.

" + } + }, + "NewDefaultValues": { + "target": "com.amazonaws.quicksight#NewDefaultValues", + "traits": { + "smithy.api#documentation": "

The new default values for the parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A transform operation that overrides the dataset parameter values that are defined in another dataset.

" + } + }, + "com.amazonaws.quicksight#PageNumber": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.quicksight#PaginationConfiguration": { + "type": "structure", + "members": { + "PageSize": { + "target": "com.amazonaws.quicksight#Long", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Indicates how many items render in one page.

", + "smithy.api#required": {} + } + }, + "PageNumber": { + "target": "com.amazonaws.quicksight#PageNumber", + "traits": { + "smithy.api#documentation": "

Indicates the page number.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The pagination configuration for a table visual or boxplot.

" + } + }, + "com.amazonaws.quicksight#PanelBorderStyle": { + "type": "enum", + "members": { + "SOLID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOLID" + } + }, + "DASHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DASHED" + } + }, + "DOTTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOTTED" + } + } + } + }, + "com.amazonaws.quicksight#PanelConfiguration": { + "type": "structure", + "members": { + "Title": { + "target": "com.amazonaws.quicksight#PanelTitleOptions", + "traits": { + "smithy.api#documentation": "

Configures the title display within each small multiples panel.

" + } + }, + "BorderVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines whether or not each panel displays a border.

" + } + }, + "BorderThickness": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

Sets the line thickness of panel borders.

" + } + }, + "BorderStyle": { + "target": "com.amazonaws.quicksight#PanelBorderStyle", + "traits": { + "smithy.api#documentation": "

Sets the line style of panel borders.

" + } + }, + "BorderColor": { + "target": "com.amazonaws.quicksight#HexColorWithTransparency", + "traits": { + "smithy.api#documentation": "

Sets the line color of panel borders.

" + } + }, + "GutterVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines whether or not negative space between sibling panels is rendered.

" + } + }, + "GutterSpacing": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

Sets the total amount of negative space to display between sibling panels.

" + } + }, + "BackgroundVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines whether or not a background for each small multiples panel is rendered.

" + } + }, + "BackgroundColor": { + "target": "com.amazonaws.quicksight#HexColorWithTransparency", + "traits": { + "smithy.api#documentation": "

Sets the background color for each panel.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of options that configure how each panel displays in a small multiples chart.

" + } + }, + "com.amazonaws.quicksight#PanelTitleOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines whether or not panel titles are displayed.

" + } + }, + "FontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration" + }, + "HorizontalTextAlignment": { + "target": "com.amazonaws.quicksight#HorizontalTextAlignment", + "traits": { + "smithy.api#documentation": "

Sets the horizontal text alignment of the title within each panel.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the title styles for each small multiples\n panel.

" + } + }, + "com.amazonaws.quicksight#PaperOrientation": { + "type": "enum", + "members": { + "PORTRAIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PORTRAIT" + } + }, + "LANDSCAPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LANDSCAPE" + } + } + } + }, + "com.amazonaws.quicksight#PaperSize": { + "type": "enum", + "members": { + "US_LETTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_LETTER" + } + }, + "US_LEGAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_LEGAL" + } + }, + "US_TABLOID_LEDGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_TABLOID_LEDGER" + } + }, + "A0": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A0" + } + }, + "A1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A1" + } + }, + "A2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A2" + } + }, + "A3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A3" + } + }, + "A4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A4" + } + }, + "A5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A5" + } + }, + "JIS_B4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JIS_B4" + } + }, + "JIS_B5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JIS_B5" + } + } + } + }, + "com.amazonaws.quicksight#ParameterControl": { + "type": "structure", + "members": { + "DateTimePicker": { + "target": "com.amazonaws.quicksight#ParameterDateTimePickerControl", + "traits": { + "smithy.api#documentation": "

A control from a date parameter that specifies date and time.

" + } + }, + "List": { + "target": "com.amazonaws.quicksight#ParameterListControl", + "traits": { + "smithy.api#documentation": "

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

" + } + }, + "Dropdown": { + "target": "com.amazonaws.quicksight#ParameterDropDownControl", + "traits": { + "smithy.api#documentation": "

A control to display a dropdown list with buttons that are used to select a single value.

" + } + }, + "TextField": { + "target": "com.amazonaws.quicksight#ParameterTextFieldControl", + "traits": { + "smithy.api#documentation": "

A control to display a text box that is used to enter a single entry.

" + } + }, + "TextArea": { + "target": "com.amazonaws.quicksight#ParameterTextAreaControl", + "traits": { + "smithy.api#documentation": "

A control to display a text box that is used to enter multiple entries.

" + } + }, + "Slider": { + "target": "com.amazonaws.quicksight#ParameterSliderControl", + "traits": { + "smithy.api#documentation": "

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The control of a parameter that users can interact with in a dashboard or an analysis.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#ParameterControlList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ParameterControl" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#ParameterDateTimePickerControl": { + "type": "structure", + "members": { + "ParameterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the ParameterDateTimePickerControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the ParameterDateTimePickerControl.

", + "smithy.api#required": {} + } + }, + "SourceParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The name of the ParameterDateTimePickerControl.

", + "smithy.api#required": {} + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#DateTimePickerControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control from a date parameter that specifies date and time.

" + } + }, + "com.amazonaws.quicksight#ParameterDeclaration": { + "type": "structure", + "members": { + "StringParameterDeclaration": { + "target": "com.amazonaws.quicksight#StringParameterDeclaration", + "traits": { + "smithy.api#documentation": "

A parameter declaration for the String data type.

" + } + }, + "DecimalParameterDeclaration": { + "target": "com.amazonaws.quicksight#DecimalParameterDeclaration", + "traits": { + "smithy.api#documentation": "

A parameter declaration for the Decimal data type.

" + } + }, + "IntegerParameterDeclaration": { + "target": "com.amazonaws.quicksight#IntegerParameterDeclaration", + "traits": { + "smithy.api#documentation": "

A parameter declaration for the Integer data type.

" + } + }, + "DateTimeParameterDeclaration": { + "target": "com.amazonaws.quicksight#DateTimeParameterDeclaration", + "traits": { + "smithy.api#documentation": "

A parameter declaration for the DateTime data type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The declaration definition of a parameter.

\n

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#ParameterDeclarationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ParameterDeclaration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#ParameterDropDownControl": { + "type": "structure", + "members": { + "ParameterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the ParameterDropDownControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the ParameterDropDownControl.

", + "smithy.api#required": {} + } + }, + "SourceParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The source parameter name of the ParameterDropDownControl.

", + "smithy.api#required": {} + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#DropDownControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#SheetControlListType", + "traits": { + "smithy.api#documentation": "

The type parameter name of the ParameterDropDownControl.

" + } + }, + "SelectableValues": { + "target": "com.amazonaws.quicksight#ParameterSelectableValues", + "traits": { + "smithy.api#documentation": "

A list of selectable values that are used in a control.

" + } + }, + "CascadingControlConfiguration": { + "target": "com.amazonaws.quicksight#CascadingControlConfiguration", + "traits": { + "smithy.api#documentation": "

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control to display a dropdown list with buttons that are used to select a single value.

" + } + }, + "com.amazonaws.quicksight#ParameterListControl": { + "type": "structure", + "members": { + "ParameterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the ParameterListControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the ParameterListControl.

", + "smithy.api#required": {} + } + }, + "SourceParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The source parameter name of the ParameterListControl.

", + "smithy.api#required": {} + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#ListControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#SheetControlListType", + "traits": { + "smithy.api#documentation": "

The type of ParameterListControl.

" + } + }, + "SelectableValues": { + "target": "com.amazonaws.quicksight#ParameterSelectableValues", + "traits": { + "smithy.api#documentation": "

A list of selectable values that are used in a control.

" + } + }, + "CascadingControlConfiguration": { + "target": "com.amazonaws.quicksight#CascadingControlConfiguration", + "traits": { + "smithy.api#documentation": "

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

" + } + }, + "com.amazonaws.quicksight#ParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.quicksight#ParameterSelectableValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50000 + } + } + }, + "com.amazonaws.quicksight#ParameterSelectableValues": { + "type": "structure", + "members": { + "Values": { + "target": "com.amazonaws.quicksight#ParameterSelectableValueList", + "traits": { + "smithy.api#documentation": "

The values that are used in ParameterSelectableValues.

" + } + }, + "LinkToDataSetColumn": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column identifier that fetches values from the data set.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of selectable values that are used in a control.

" + } + }, + "com.amazonaws.quicksight#ParameterSliderControl": { + "type": "structure", + "members": { + "ParameterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the ParameterSliderControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the ParameterSliderControl.

", + "smithy.api#required": {} + } + }, + "SourceParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The source parameter name of the ParameterSliderControl.

", + "smithy.api#required": {} + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#SliderControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "MaximumValue": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The larger value that is displayed at the right of the slider.

", + "smithy.api#required": {} + } + }, + "MinimumValue": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The smaller value that is displayed at the left of the slider.

", + "smithy.api#required": {} + } + }, + "StepSize": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of increments that the slider bar is divided into.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

" + } + }, + "com.amazonaws.quicksight#ParameterTextAreaControl": { + "type": "structure", + "members": { + "ParameterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the ParameterTextAreaControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the ParameterTextAreaControl.

", + "smithy.api#required": {} + } + }, + "SourceParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The source parameter name of the ParameterTextAreaControl.

", + "smithy.api#required": {} + } + }, + "Delimiter": { + "target": "com.amazonaws.quicksight#TextAreaControlDelimiter", + "traits": { + "smithy.api#documentation": "

The delimiter that is used to separate the lines in text.

" + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#TextAreaControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control to display a text box that is used to enter multiple entries.

" + } + }, + "com.amazonaws.quicksight#ParameterTextFieldControl": { + "type": "structure", + "members": { + "ParameterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the ParameterTextFieldControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the ParameterTextFieldControl.

", + "smithy.api#required": {} + } + }, + "SourceParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The source parameter name of the ParameterTextFieldControl.

", + "smithy.api#required": {} + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#TextFieldControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control to display a text box that is used to enter a single entry.

" + } + }, + "com.amazonaws.quicksight#ParameterValueType": { + "type": "enum", + "members": { + "MULTI_VALUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTI_VALUED" + } + }, + "SINGLE_VALUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_VALUED" + } + } + } + }, + "com.amazonaws.quicksight#Parameters": { + "type": "structure", + "members": { + "StringParameters": { + "target": "com.amazonaws.quicksight#StringParameterList", + "traits": { + "smithy.api#documentation": "

The parameters that have a data type of string.

" + } + }, + "IntegerParameters": { + "target": "com.amazonaws.quicksight#IntegerParameterList", + "traits": { + "smithy.api#documentation": "

The parameters that have a data type of integer.

" + } + }, + "DecimalParameters": { + "target": "com.amazonaws.quicksight#DecimalParameterList", + "traits": { + "smithy.api#documentation": "

The parameters that have a data type of decimal.

" + } + }, + "DateTimeParameters": { + "target": "com.amazonaws.quicksight#DateTimeParameterList", + "traits": { + "smithy.api#documentation": "

The parameters that have a data type of date-time.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of Amazon QuickSight parameters and the list's override values.

" + } + }, + "com.amazonaws.quicksight#Password": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.quicksight#Path": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Arn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#PercentNumber": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#PercentVisibleRange": { + "type": "structure", + "members": { + "From": { + "target": "com.amazonaws.quicksight#PercentNumber", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The lower bound of the range.

" + } + }, + "To": { + "target": "com.amazonaws.quicksight#PercentNumber", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The top bound of the range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The percent range in the visible range.

" + } + }, + "com.amazonaws.quicksight#PercentageDisplayFormatConfiguration": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.quicksight#Prefix", + "traits": { + "smithy.api#documentation": "

Determines the prefix value of the percentage format.

" + } + }, + "Suffix": { + "target": "com.amazonaws.quicksight#Suffix", + "traits": { + "smithy.api#documentation": "

Determines the suffix value of the percentage format.

" + } + }, + "SeparatorConfiguration": { + "target": "com.amazonaws.quicksight#NumericSeparatorConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the numeric separator configuration.

" + } + }, + "DecimalPlacesConfiguration": { + "target": "com.amazonaws.quicksight#DecimalPlacesConfiguration", + "traits": { + "smithy.api#documentation": "

The option that determines the decimal places configuration.

" + } + }, + "NegativeValueConfiguration": { + "target": "com.amazonaws.quicksight#NegativeValueConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the negative value configuration.

" + } + }, + "NullValueFormatConfiguration": { + "target": "com.amazonaws.quicksight#NullValueFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the null value format configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the percentage display format configuration.

" + } + }, + "com.amazonaws.quicksight#PercentileAggregation": { + "type": "structure", + "members": { + "PercentileValue": { + "target": "com.amazonaws.quicksight#PercentileValue", + "traits": { + "smithy.api#documentation": "

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An aggregation based on the percentile of values in a dimension or measure.

" + } + }, + "com.amazonaws.quicksight#PercentileValue": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#PeriodOverPeriodComputation": { + "type": "structure", + "members": { + "ComputationId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for a computation.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of a computation.

" + } + }, + "Time": { + "target": "com.amazonaws.quicksight#DimensionField", + "traits": { + "smithy.api#documentation": "

The time field that is used in a computation.

" + } + }, + "Value": { + "target": "com.amazonaws.quicksight#MeasureField", + "traits": { + "smithy.api#documentation": "

The value field that is used in a computation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The period over period computation configuration.

" + } + }, + "com.amazonaws.quicksight#PeriodToDateComputation": { + "type": "structure", + "members": { + "ComputationId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for a computation.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of a computation.

" + } + }, + "Time": { + "target": "com.amazonaws.quicksight#DimensionField", + "traits": { + "smithy.api#documentation": "

The time field that is used in a computation.

" + } + }, + "Value": { + "target": "com.amazonaws.quicksight#MeasureField", + "traits": { + "smithy.api#documentation": "

The value field that is used in a computation.

" + } + }, + "PeriodTimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The time granularity setup of period to date computation. Choose from the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The period to date computation configuration.

" + } + }, + "com.amazonaws.quicksight#PeriodsBackward": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.quicksight#PeriodsForward": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.quicksight#PhysicalTable": { + "type": "union", + "members": { + "RelationalTable": { + "target": "com.amazonaws.quicksight#RelationalTable", + "traits": { + "smithy.api#documentation": "

A physical table type for relational data sources.

" + } + }, + "CustomSql": { + "target": "com.amazonaws.quicksight#CustomSql", + "traits": { + "smithy.api#documentation": "

A physical table type built from the results of the custom SQL query.

" + } + }, + "S3Source": { + "target": "com.amazonaws.quicksight#S3Source", + "traits": { + "smithy.api#documentation": "

A physical table type for as S3 data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A view of a data source that contains information about the shape of the data in the\n underlying source. This is a variant type structure. For this structure to be valid,\n only one of the attributes can be non-null.

" + } + }, + "com.amazonaws.quicksight#PhysicalTableId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-]*$" + } + }, + "com.amazonaws.quicksight#PhysicalTableMap": { + "type": "map", + "key": { + "target": "com.amazonaws.quicksight#PhysicalTableId" + }, + "value": { + "target": "com.amazonaws.quicksight#PhysicalTable" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + } + } + }, + "com.amazonaws.quicksight#PieChartAggregatedFieldWells": { + "type": "structure", + "members": { + "Category": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The category (group/color) field wells of a pie chart.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The value field wells of a pie chart. Values are aggregated based on categories.

" + } + }, + "SmallMultiples": { + "target": "com.amazonaws.quicksight#SmallMultiplesDimensionFieldList", + "traits": { + "smithy.api#documentation": "

The small multiples field well of a pie chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a pie chart.

" + } + }, + "com.amazonaws.quicksight#PieChartConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#PieChartFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#PieChartSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a pie chart.

" + } + }, + "DonutOptions": { + "target": "com.amazonaws.quicksight#DonutOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart.

" + } + }, + "SmallMultiplesOptions": { + "target": "com.amazonaws.quicksight#SmallMultiplesOptions", + "traits": { + "smithy.api#documentation": "

The small multiples setup for the visual.

" + } + }, + "CategoryLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options of the group/color that is displayed in a pie chart.

" + } + }, + "ValueLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options for the value that is displayed in a pie chart.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "

The legend display setup of the visual.

" + } + }, + "DataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The tooltip display setup of the visual.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" + } + }, + "ContributionAnalysisDefaults": { + "target": "com.amazonaws.quicksight#ContributionAnalysisDefaultList", + "traits": { + "smithy.api#documentation": "

The contribution analysis (anomaly configuration) setup of the visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a pie chart.

" + } + }, + "com.amazonaws.quicksight#PieChartFieldWells": { + "type": "structure", + "members": { + "PieChartAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#PieChartAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a pie chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a pie chart.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#PieChartSortConfiguration": { + "type": "structure", + "members": { + "CategorySort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the category fields.

" + } + }, + "CategoryItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of categories that are displayed in a pie chart.

" + } + }, + "SmallMultiplesSort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the small multiples field.

" + } + }, + "SmallMultiplesLimitConfiguration": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of small multiples panels that are displayed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a pie chart.

" + } + }, + "com.amazonaws.quicksight#PieChartVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#PieChartConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of a pie chart.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A pie or donut chart.

\n

The PieChartVisual structure describes a visual that is a member of the pie chart family.

\n

The following charts can be described by using this structure:

\n \n

For more information, see Using pie charts in the Amazon QuickSight User Guide.

\n

For more information, see Using donut charts in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#PivotFieldSortOptions": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID for the field sort options.

", + "smithy.api#required": {} + } + }, + "SortBy": { + "target": "com.amazonaws.quicksight#PivotTableSortBy", + "traits": { + "smithy.api#documentation": "

The sort by field for the field sort options.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The field sort options for a pivot table sort configuration.

" + } + }, + "com.amazonaws.quicksight#PivotFieldSortOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#PivotFieldSortOptions" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#PivotMeasureFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MeasureField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 40 + } + } + }, + "com.amazonaws.quicksight#PivotTableAggregatedFieldWells": { + "type": "structure", + "members": { + "Rows": { + "target": "com.amazonaws.quicksight#PivotTableDimensionList", + "traits": { + "smithy.api#documentation": "

The rows field well for a pivot table. Values are grouped by rows fields.

" + } + }, + "Columns": { + "target": "com.amazonaws.quicksight#PivotTableDimensionList", + "traits": { + "smithy.api#documentation": "

The columns field well for a pivot table. Values are grouped by columns fields.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#PivotMeasureFieldList", + "traits": { + "smithy.api#documentation": "

The values field well for a pivot table. Values are aggregated based on rows and columns fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The aggregated field well for the pivot table.

" + } + }, + "com.amazonaws.quicksight#PivotTableCellConditionalFormatting": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID of the cell for conditional formatting.

", + "smithy.api#required": {} + } + }, + "TextFormat": { + "target": "com.amazonaws.quicksight#TextConditionalFormat", + "traits": { + "smithy.api#documentation": "

The text format of the cell for conditional formatting.

" + } + }, + "Scope": { + "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingScope", + "traits": { + "smithy.api#documentation": "

The scope of the cell for conditional formatting.

" + } + }, + "Scopes": { + "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingScopeList", + "traits": { + "smithy.api#documentation": "

A list of cell scopes for conditional formatting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The cell conditional formatting option for a pivot table.

" + } + }, + "com.amazonaws.quicksight#PivotTableConditionalFormatting": { + "type": "structure", + "members": { + "ConditionalFormattingOptions": { + "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingOptionList", + "traits": { + "smithy.api#documentation": "

Conditional formatting options for a PivotTableVisual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting for a PivotTableVisual.

" + } + }, + "com.amazonaws.quicksight#PivotTableConditionalFormattingOption": { + "type": "structure", + "members": { + "Cell": { + "target": "com.amazonaws.quicksight#PivotTableCellConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The cell conditional formatting option for a pivot table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Conditional formatting options for a PivotTableVisual.

" + } + }, + "com.amazonaws.quicksight#PivotTableConditionalFormattingOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingOption" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.quicksight#PivotTableConditionalFormattingScope": { + "type": "structure", + "members": { + "Role": { + "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingScopeRole", + "traits": { + "smithy.api#documentation": "

The role (field, field total, grand total) of the cell for conditional formatting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The scope of the cell for conditional formatting.

" + } + }, + "com.amazonaws.quicksight#PivotTableConditionalFormattingScopeList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingScope" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.quicksight#PivotTableConditionalFormattingScopeRole": { + "type": "enum", + "members": { + "FIELD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIELD" + } + }, + "FIELD_TOTAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIELD_TOTAL" + } + }, + "GRAND_TOTAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GRAND_TOTAL" + } + } + } + }, + "com.amazonaws.quicksight#PivotTableConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#PivotTableFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#PivotTableSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration for a PivotTableVisual.

" + } + }, + "TableOptions": { + "target": "com.amazonaws.quicksight#PivotTableOptions", + "traits": { + "smithy.api#documentation": "

The table options for a pivot table visual.

" + } + }, + "TotalOptions": { + "target": "com.amazonaws.quicksight#PivotTableTotalOptions", + "traits": { + "smithy.api#documentation": "

The total options for a pivot table visual.

" + } + }, + "FieldOptions": { + "target": "com.amazonaws.quicksight#PivotTableFieldOptions", + "traits": { + "smithy.api#documentation": "

The field options for a pivot table visual.

" + } + }, + "PaginatedReportOptions": { + "target": "com.amazonaws.quicksight#PivotTablePaginatedReportOptions", + "traits": { + "smithy.api#documentation": "

The paginated report options for a pivot table visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a PivotTableVisual.

" + } + }, + "com.amazonaws.quicksight#PivotTableDataPathOption": { + "type": "structure", + "members": { + "DataPathList": { + "target": "com.amazonaws.quicksight#DataPathValueList", + "traits": { + "smithy.api#documentation": "

The list of data path values for the data path options.

", + "smithy.api#required": {} + } + }, + "Width": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The width of the data path option.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data path options for the pivot table field options.

" + } + }, + "com.amazonaws.quicksight#PivotTableDataPathOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#PivotTableDataPathOption" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#PivotTableDataPathType": { + "type": "enum", + "members": { + "HIERARCHY_ROWS_LAYOUT_COLUMN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIERARCHY_ROWS_LAYOUT_COLUMN" + } + }, + "MULTIPLE_ROW_METRICS_COLUMN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTIPLE_ROW_METRICS_COLUMN" + } + }, + "EMPTY_COLUMN_HEADER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMPTY_COLUMN_HEADER" + } + }, + "COUNT_METRIC_COLUMN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT_METRIC_COLUMN" + } + } + } + }, + "com.amazonaws.quicksight#PivotTableDimensionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 40 + } + } + }, + "com.amazonaws.quicksight#PivotTableFieldCollapseState": { + "type": "enum", + "members": { + "COLLAPSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLLAPSED" + } + }, + "EXPANDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPANDED" + } + } + } + }, + "com.amazonaws.quicksight#PivotTableFieldCollapseStateOption": { + "type": "structure", + "members": { + "Target": { + "target": "com.amazonaws.quicksight#PivotTableFieldCollapseStateTarget", + "traits": { + "smithy.api#documentation": "

A tagged-union object that sets the collapse state.

", + "smithy.api#required": {} + } + }, + "State": { + "target": "com.amazonaws.quicksight#PivotTableFieldCollapseState", + "traits": { + "smithy.api#documentation": "

The state of the field target of a pivot table. Choose one of the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The collapse state options for the pivot table field options.

" + } + }, + "com.amazonaws.quicksight#PivotTableFieldCollapseStateOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#PivotTableFieldCollapseStateOption" + } + }, + "com.amazonaws.quicksight#PivotTableFieldCollapseStateTarget": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The field ID of the pivot table that the collapse state needs to be set to.

" + } + }, + "FieldDataPathValues": { + "target": "com.amazonaws.quicksight#DataPathValueList", + "traits": { + "smithy.api#documentation": "

The data path of the pivot table's header. Used to set the collapse state.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The target of a pivot table field collapse state.

" + } + }, + "com.amazonaws.quicksight#PivotTableFieldOption": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID of the pivot table field.

", + "smithy.api#required": {} + } + }, + "CustomLabel": { + "target": "com.amazonaws.quicksight#CustomLabel", + "traits": { + "smithy.api#documentation": "

The custom label of the pivot table field.

" + } + }, + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the pivot table field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The selected field options for the pivot table field options.

" + } + }, + "com.amazonaws.quicksight#PivotTableFieldOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#PivotTableFieldOption" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#PivotTableFieldOptions": { + "type": "structure", + "members": { + "SelectedFieldOptions": { + "target": "com.amazonaws.quicksight#PivotTableFieldOptionList", + "traits": { + "smithy.api#documentation": "

The selected field options for the pivot table field options.

" + } + }, + "DataPathOptions": { + "target": "com.amazonaws.quicksight#PivotTableDataPathOptionList", + "traits": { + "smithy.api#documentation": "

The data path options for the pivot table field options.

" + } + }, + "CollapseStateOptions": { + "target": "com.amazonaws.quicksight#PivotTableFieldCollapseStateOptionList", + "traits": { + "smithy.api#documentation": "

The collapse state options for the pivot table field options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field options for a pivot table visual.

" + } + }, + "com.amazonaws.quicksight#PivotTableFieldSubtotalOptions": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID of the subtotal options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The optional configuration of subtotals cells.

" + } + }, + "com.amazonaws.quicksight#PivotTableFieldSubtotalOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#PivotTableFieldSubtotalOptions" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#PivotTableFieldWells": { + "type": "structure", + "members": { + "PivotTableAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#PivotTableAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field well for the pivot table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field wells for a pivot table visual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#PivotTableMetricPlacement": { + "type": "enum", + "members": { + "ROW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROW" + } + }, + "COLUMN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLUMN" + } + } + } + }, + "com.amazonaws.quicksight#PivotTableOptions": { + "type": "structure", + "members": { + "MetricPlacement": { + "target": "com.amazonaws.quicksight#PivotTableMetricPlacement", + "traits": { + "smithy.api#documentation": "

The metric placement (row, column) options.

" + } + }, + "SingleMetricVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the single metric options.

" + } + }, + "ColumnNamesVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the column names.

" + } + }, + "ToggleButtonsVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines the visibility of the pivot table.

" + } + }, + "ColumnHeaderStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The table cell style of the column header.

" + } + }, + "RowHeaderStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The table cell style of the row headers.

" + } + }, + "CellStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The table cell style of cells.

" + } + }, + "RowFieldNamesStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The table cell style of row field names.

" + } + }, + "RowAlternateColorOptions": { + "target": "com.amazonaws.quicksight#RowAlternateColorOptions", + "traits": { + "smithy.api#documentation": "

The row alternate color options (widget status, row alternate colors).

" + } + }, + "CollapsedRowDimensionsVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is HIDDEN, all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE.

" + } + }, + "RowsLayout": { + "target": "com.amazonaws.quicksight#PivotTableRowsLayout", + "traits": { + "smithy.api#documentation": "

The layout for the row dimension headers of a pivot table. Choose one of the following options.

\n " + } + }, + "RowsLabelOptions": { + "target": "com.amazonaws.quicksight#PivotTableRowsLabelOptions", + "traits": { + "smithy.api#documentation": "

The options for the label that is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.

" + } + }, + "DefaultCellWidth": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The default cell width of the pivot table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The table options for a pivot table visual.

" + } + }, + "com.amazonaws.quicksight#PivotTablePaginatedReportOptions": { + "type": "structure", + "members": { + "VerticalOverflowVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the printing table overflow across pages.

" + } + }, + "OverflowColumnHeaderVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the repeating header rows on each page.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The paginated report options for a pivot table visual.

" + } + }, + "com.amazonaws.quicksight#PivotTableRowsLabelOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the rows label.

" + } + }, + "CustomLabel": { + "target": "com.amazonaws.quicksight#PivotTableRowsLabelText", + "traits": { + "smithy.api#documentation": "

The custom label string for the rows label.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for the label thta is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.

" + } + }, + "com.amazonaws.quicksight#PivotTableRowsLabelText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.quicksight#PivotTableRowsLayout": { + "type": "enum", + "members": { + "TABULAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TABULAR" + } + }, + "HIERARCHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIERARCHY" + } + } + } + }, + "com.amazonaws.quicksight#PivotTableSortBy": { + "type": "structure", + "members": { + "Field": { + "target": "com.amazonaws.quicksight#FieldSort", + "traits": { + "smithy.api#documentation": "

The field sort (field id, direction) for the pivot table sort by options.

" + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnSort", + "traits": { + "smithy.api#documentation": "

The column sort (field id, direction) for the pivot table sort by options.

" + } + }, + "DataPath": { + "target": "com.amazonaws.quicksight#DataPathSort", + "traits": { + "smithy.api#documentation": "

The data path sort (data path value, direction) for the pivot table sort by options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort by field for the field sort options.

" + } + }, + "com.amazonaws.quicksight#PivotTableSortConfiguration": { + "type": "structure", + "members": { + "FieldSortOptions": { + "target": "com.amazonaws.quicksight#PivotFieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The field sort options for a pivot table sort configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration for a PivotTableVisual.

" + } + }, + "com.amazonaws.quicksight#PivotTableSubtotalLevel": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + }, + "LAST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST" + } + } + } + }, + "com.amazonaws.quicksight#PivotTableTotalOptions": { + "type": "structure", + "members": { + "RowSubtotalOptions": { + "target": "com.amazonaws.quicksight#SubtotalOptions", + "traits": { + "smithy.api#documentation": "

The row subtotal options.

" + } + }, + "ColumnSubtotalOptions": { + "target": "com.amazonaws.quicksight#SubtotalOptions", + "traits": { + "smithy.api#documentation": "

The column subtotal options.

" + } + }, + "RowTotalOptions": { + "target": "com.amazonaws.quicksight#PivotTotalOptions", + "traits": { + "smithy.api#documentation": "

The row total options.

" + } + }, + "ColumnTotalOptions": { + "target": "com.amazonaws.quicksight#PivotTotalOptions", + "traits": { + "smithy.api#documentation": "

The column total options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The total options for a pivot table visual.

" + } + }, + "com.amazonaws.quicksight#PivotTableVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#PivotTableConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "ConditionalFormatting": { + "target": "com.amazonaws.quicksight#PivotTableConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting for a PivotTableVisual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A pivot table.

\n

For more information, see Using pivot tables in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#PivotTotalOptions": { + "type": "structure", + "members": { + "TotalsVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility configuration for the total cells.

" + } + }, + "Placement": { + "target": "com.amazonaws.quicksight#TableTotalsPlacement", + "traits": { + "smithy.api#documentation": "

The placement (start, end) for the total cells.

" + } + }, + "ScrollStatus": { + "target": "com.amazonaws.quicksight#TableTotalsScrollStatus", + "traits": { + "smithy.api#documentation": "

The scroll status (pinned, scrolled) for the total cells.

" + } + }, + "CustomLabel": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The custom label string for the total cells.

" + } + }, + "TotalCellStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The cell styling options for the total cells.

" + } + }, + "ValueCellStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The cell styling options for the totals of value cells.

" + } + }, + "MetricHeaderCellStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The cell styling options for the total of header cells.

" + } + }, + "TotalAggregationOptions": { + "target": "com.amazonaws.quicksight#TotalAggregationOptionList", + "traits": { + "smithy.api#documentation": "

The total aggregation options for each value field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The optional configuration of totals cells in a PivotTableVisual.

" + } + }, + "com.amazonaws.quicksight#PixelLength": { + "type": "string", + "traits": { + "smithy.api#documentation": "String based length that is composed of value and unit in px" + } + }, + "com.amazonaws.quicksight#Port": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 65535 + } + } + }, + "com.amazonaws.quicksight#PositiveInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.quicksight#PositiveLong": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.quicksight#PostgreSqlParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

Host.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

Port.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

Database.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for PostgreSQL.

" + } + }, + "com.amazonaws.quicksight#PreconditionNotMetException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

One or more preconditions aren't met.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.quicksight#PredefinedHierarchy": { + "type": "structure", + "members": { + "HierarchyId": { + "target": "com.amazonaws.quicksight#HierarchyId", + "traits": { + "smithy.api#documentation": "

The hierarchy ID of the predefined hierarchy.

", + "smithy.api#required": {} + } + }, + "Columns": { + "target": "com.amazonaws.quicksight#PredefinedHierarchyColumnList", + "traits": { + "smithy.api#documentation": "

The list of columns that define the predefined hierarchy.

", + "smithy.api#required": {} + } + }, + "DrillDownFilters": { + "target": "com.amazonaws.quicksight#DrillDownFilterList", + "traits": { + "smithy.api#documentation": "

The option that determines the drill down filters for the predefined hierarchy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.

" + } + }, + "com.amazonaws.quicksight#PredefinedHierarchyColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#PredictionInterval": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 50, + "max": 95 + } + } + }, + "com.amazonaws.quicksight#Prefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#PrestoParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

Host.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

Port.

", + "smithy.api#required": {} + } + }, + "Catalog": { + "target": "com.amazonaws.quicksight#Catalog", + "traits": { + "smithy.api#documentation": "

Catalog.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for Presto.

" + } + }, + "com.amazonaws.quicksight#PrimaryValueDisplayType": { + "type": "enum", + "members": { + "HIDDEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIDDEN" + } + }, + "COMPARISON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPARISON" + } + }, + "ACTUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTUAL" + } + } + } + }, + "com.amazonaws.quicksight#Principal": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#PrincipalList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#String" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#ProgressBarOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the progress bar.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the progress bar of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#ProjectId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#ProjectOperation": { + "type": "structure", + "members": { + "ProjectedColumns": { + "target": "com.amazonaws.quicksight#ProjectedColumnList", + "traits": { + "smithy.api#documentation": "

Projected columns.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A transform operation that projects columns. Operations that come after a projection\n can only refer to projected columns.

" + } + }, + "com.amazonaws.quicksight#ProjectedColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#String" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + } + } + }, + "com.amazonaws.quicksight#PropertyRole": { + "type": "enum", + "members": { + "PRIMARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIMARY" + } + }, + "ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ID" + } + } + } + }, + "com.amazonaws.quicksight#PropertyUsage": { + "type": "enum", + "members": { + "INHERIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INHERIT" + } + }, + "DIMENSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIMENSION" + } + }, + "MEASURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEASURE" + } + } + } + }, + "com.amazonaws.quicksight#PurchaseMode": { + "type": "enum", + "members": { + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + }, + "AUTO_PURCHASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO_PURCHASE" + } + } + } + }, + "com.amazonaws.quicksight#PutDataSetRefreshProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#PutDataSetRefreshPropertiesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#PutDataSetRefreshPropertiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates the dataset refresh properties for the dataset.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#PutDataSetRefreshPropertiesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetRefreshProperties": { + "target": "com.amazonaws.quicksight#DataSetRefreshProperties", + "traits": { + "smithy.api#documentation": "

The dataset refresh properties.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#PutDataSetRefreshPropertiesResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#Query": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#QueryExecutionMode": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + } + } + }, + "com.amazonaws.quicksight#QueryExecutionOptions": { + "type": "structure", + "members": { + "QueryExecutionMode": { + "target": "com.amazonaws.quicksight#QueryExecutionMode", + "traits": { + "smithy.api#documentation": "

A structure that describes the query execution mode.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that describes the query execution options.

" + } + }, + "com.amazonaws.quicksight#QueueInfo": { + "type": "structure", + "members": { + "WaitingOnIngestion": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the queued ingestion.

", + "smithy.api#required": {} + } + }, + "QueuedIngestion": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing\n ingestion to complete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a queued dataset SPICE ingestion.

" + } + }, + "com.amazonaws.quicksight#QuickSightUserNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The user with the provided name isn't found. This error can happen in any operation\n\t\t\tthat requires finding a user based on a provided user name, such as\n\t\t\t\tDeleteUser, DescribeUser, and so on.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.quicksight#QuickSight_20180401": { + "type": "service", + "version": "2018-04-01", + "operations": [ + { + "target": "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswer" + }, + { + "target": "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswer" + }, + { + "target": "com.amazonaws.quicksight#CancelIngestion" + }, + { + "target": "com.amazonaws.quicksight#CreateAccountCustomization" + }, + { + "target": "com.amazonaws.quicksight#CreateAccountSubscription" + }, + { + "target": "com.amazonaws.quicksight#CreateAnalysis" + }, + { + "target": "com.amazonaws.quicksight#CreateDashboard" + }, + { + "target": "com.amazonaws.quicksight#CreateDataSet" + }, + { + "target": "com.amazonaws.quicksight#CreateDataSource" + }, + { + "target": "com.amazonaws.quicksight#CreateFolder" + }, + { + "target": "com.amazonaws.quicksight#CreateFolderMembership" + }, + { + "target": "com.amazonaws.quicksight#CreateGroup" + }, + { + "target": "com.amazonaws.quicksight#CreateGroupMembership" + }, + { + "target": "com.amazonaws.quicksight#CreateIAMPolicyAssignment" + }, + { + "target": "com.amazonaws.quicksight#CreateIngestion" + }, + { + "target": "com.amazonaws.quicksight#CreateNamespace" + }, + { + "target": "com.amazonaws.quicksight#CreateRefreshSchedule" + }, + { + "target": "com.amazonaws.quicksight#CreateRoleMembership" + }, + { + "target": "com.amazonaws.quicksight#CreateTemplate" + }, + { + "target": "com.amazonaws.quicksight#CreateTemplateAlias" + }, + { + "target": "com.amazonaws.quicksight#CreateTheme" + }, + { + "target": "com.amazonaws.quicksight#CreateThemeAlias" + }, + { + "target": "com.amazonaws.quicksight#CreateTopic" + }, + { + "target": "com.amazonaws.quicksight#CreateTopicRefreshSchedule" + }, + { + "target": "com.amazonaws.quicksight#CreateVPCConnection" + }, + { + "target": "com.amazonaws.quicksight#DeleteAccountCustomization" + }, + { + "target": "com.amazonaws.quicksight#DeleteAccountSubscription" + }, + { + "target": "com.amazonaws.quicksight#DeleteAnalysis" + }, + { + "target": "com.amazonaws.quicksight#DeleteDashboard" + }, + { + "target": "com.amazonaws.quicksight#DeleteDataSet" + }, + { + "target": "com.amazonaws.quicksight#DeleteDataSetRefreshProperties" + }, + { + "target": "com.amazonaws.quicksight#DeleteDataSource" + }, + { + "target": "com.amazonaws.quicksight#DeleteFolder" + }, + { + "target": "com.amazonaws.quicksight#DeleteFolderMembership" + }, + { + "target": "com.amazonaws.quicksight#DeleteGroup" + }, + { + "target": "com.amazonaws.quicksight#DeleteGroupMembership" + }, + { + "target": "com.amazonaws.quicksight#DeleteIAMPolicyAssignment" + }, + { + "target": "com.amazonaws.quicksight#DeleteIdentityPropagationConfig" + }, + { + "target": "com.amazonaws.quicksight#DeleteNamespace" + }, + { + "target": "com.amazonaws.quicksight#DeleteRefreshSchedule" + }, + { + "target": "com.amazonaws.quicksight#DeleteRoleCustomPermission" + }, + { + "target": "com.amazonaws.quicksight#DeleteRoleMembership" + }, + { + "target": "com.amazonaws.quicksight#DeleteTemplate" + }, + { + "target": "com.amazonaws.quicksight#DeleteTemplateAlias" + }, + { + "target": "com.amazonaws.quicksight#DeleteTheme" + }, + { + "target": "com.amazonaws.quicksight#DeleteThemeAlias" + }, + { + "target": "com.amazonaws.quicksight#DeleteTopic" + }, + { + "target": "com.amazonaws.quicksight#DeleteTopicRefreshSchedule" + }, + { + "target": "com.amazonaws.quicksight#DeleteUser" + }, + { + "target": "com.amazonaws.quicksight#DeleteUserByPrincipalId" + }, + { + "target": "com.amazonaws.quicksight#DeleteVPCConnection" + }, + { + "target": "com.amazonaws.quicksight#DescribeAccountCustomization" + }, + { + "target": "com.amazonaws.quicksight#DescribeAccountSettings" + }, + { + "target": "com.amazonaws.quicksight#DescribeAccountSubscription" + }, + { + "target": "com.amazonaws.quicksight#DescribeAnalysis" + }, + { + "target": "com.amazonaws.quicksight#DescribeAnalysisDefinition" + }, + { + "target": "com.amazonaws.quicksight#DescribeAnalysisPermissions" + }, + { + "target": "com.amazonaws.quicksight#DescribeAssetBundleExportJob" + }, + { + "target": "com.amazonaws.quicksight#DescribeAssetBundleImportJob" + }, + { + "target": "com.amazonaws.quicksight#DescribeDashboard" + }, + { + "target": "com.amazonaws.quicksight#DescribeDashboardDefinition" + }, + { + "target": "com.amazonaws.quicksight#DescribeDashboardPermissions" + }, + { + "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJob" + }, + { + "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResult" + }, + { + "target": "com.amazonaws.quicksight#DescribeDataSet" + }, + { + "target": "com.amazonaws.quicksight#DescribeDataSetPermissions" + }, + { + "target": "com.amazonaws.quicksight#DescribeDataSetRefreshProperties" + }, + { + "target": "com.amazonaws.quicksight#DescribeDataSource" + }, + { + "target": "com.amazonaws.quicksight#DescribeDataSourcePermissions" + }, + { + "target": "com.amazonaws.quicksight#DescribeFolder" + }, + { + "target": "com.amazonaws.quicksight#DescribeFolderPermissions" + }, + { + "target": "com.amazonaws.quicksight#DescribeFolderResolvedPermissions" + }, + { + "target": "com.amazonaws.quicksight#DescribeGroup" + }, + { + "target": "com.amazonaws.quicksight#DescribeGroupMembership" + }, + { + "target": "com.amazonaws.quicksight#DescribeIAMPolicyAssignment" + }, + { + "target": "com.amazonaws.quicksight#DescribeIngestion" + }, + { + "target": "com.amazonaws.quicksight#DescribeIpRestriction" + }, + { + "target": "com.amazonaws.quicksight#DescribeKeyRegistration" + }, + { + "target": "com.amazonaws.quicksight#DescribeNamespace" + }, + { + "target": "com.amazonaws.quicksight#DescribeRefreshSchedule" + }, + { + "target": "com.amazonaws.quicksight#DescribeRoleCustomPermission" + }, + { + "target": "com.amazonaws.quicksight#DescribeTemplate" + }, + { + "target": "com.amazonaws.quicksight#DescribeTemplateAlias" + }, + { + "target": "com.amazonaws.quicksight#DescribeTemplateDefinition" + }, + { + "target": "com.amazonaws.quicksight#DescribeTemplatePermissions" + }, + { + "target": "com.amazonaws.quicksight#DescribeTheme" + }, + { + "target": "com.amazonaws.quicksight#DescribeThemeAlias" + }, + { + "target": "com.amazonaws.quicksight#DescribeThemePermissions" + }, + { + "target": "com.amazonaws.quicksight#DescribeTopic" + }, + { + "target": "com.amazonaws.quicksight#DescribeTopicPermissions" + }, + { + "target": "com.amazonaws.quicksight#DescribeTopicRefresh" + }, + { + "target": "com.amazonaws.quicksight#DescribeTopicRefreshSchedule" + }, + { + "target": "com.amazonaws.quicksight#DescribeUser" + }, + { + "target": "com.amazonaws.quicksight#DescribeVPCConnection" + }, + { + "target": "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUser" + }, + { + "target": "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUser" + }, + { + "target": "com.amazonaws.quicksight#GetDashboardEmbedUrl" + }, + { + "target": "com.amazonaws.quicksight#GetSessionEmbedUrl" + }, + { + "target": "com.amazonaws.quicksight#ListAnalyses" + }, + { + "target": "com.amazonaws.quicksight#ListAssetBundleExportJobs" + }, + { + "target": "com.amazonaws.quicksight#ListAssetBundleImportJobs" + }, + { + "target": "com.amazonaws.quicksight#ListDashboards" + }, + { + "target": "com.amazonaws.quicksight#ListDashboardVersions" + }, + { + "target": "com.amazonaws.quicksight#ListDataSets" + }, + { + "target": "com.amazonaws.quicksight#ListDataSources" + }, + { + "target": "com.amazonaws.quicksight#ListFolderMembers" + }, + { + "target": "com.amazonaws.quicksight#ListFolders" + }, + { + "target": "com.amazonaws.quicksight#ListGroupMemberships" + }, + { + "target": "com.amazonaws.quicksight#ListGroups" + }, + { + "target": "com.amazonaws.quicksight#ListIAMPolicyAssignments" + }, + { + "target": "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUser" + }, + { + "target": "com.amazonaws.quicksight#ListIdentityPropagationConfigs" + }, + { + "target": "com.amazonaws.quicksight#ListIngestions" + }, + { + "target": "com.amazonaws.quicksight#ListNamespaces" + }, + { + "target": "com.amazonaws.quicksight#ListRefreshSchedules" + }, + { + "target": "com.amazonaws.quicksight#ListRoleMemberships" + }, + { + "target": "com.amazonaws.quicksight#ListTagsForResource" + }, + { + "target": "com.amazonaws.quicksight#ListTemplateAliases" + }, + { + "target": "com.amazonaws.quicksight#ListTemplates" + }, + { + "target": "com.amazonaws.quicksight#ListTemplateVersions" + }, + { + "target": "com.amazonaws.quicksight#ListThemeAliases" + }, + { + "target": "com.amazonaws.quicksight#ListThemes" + }, + { + "target": "com.amazonaws.quicksight#ListThemeVersions" + }, + { + "target": "com.amazonaws.quicksight#ListTopicRefreshSchedules" + }, + { + "target": "com.amazonaws.quicksight#ListTopicReviewedAnswers" + }, + { + "target": "com.amazonaws.quicksight#ListTopics" + }, + { + "target": "com.amazonaws.quicksight#ListUserGroups" + }, + { + "target": "com.amazonaws.quicksight#ListUsers" + }, + { + "target": "com.amazonaws.quicksight#ListVPCConnections" + }, + { + "target": "com.amazonaws.quicksight#PutDataSetRefreshProperties" + }, + { + "target": "com.amazonaws.quicksight#RegisterUser" + }, + { + "target": "com.amazonaws.quicksight#RestoreAnalysis" + }, + { + "target": "com.amazonaws.quicksight#SearchAnalyses" + }, + { + "target": "com.amazonaws.quicksight#SearchDashboards" + }, + { + "target": "com.amazonaws.quicksight#SearchDataSets" + }, + { + "target": "com.amazonaws.quicksight#SearchDataSources" + }, + { + "target": "com.amazonaws.quicksight#SearchFolders" + }, + { + "target": "com.amazonaws.quicksight#SearchGroups" + }, + { + "target": "com.amazonaws.quicksight#StartAssetBundleExportJob" + }, + { + "target": "com.amazonaws.quicksight#StartAssetBundleImportJob" + }, + { + "target": "com.amazonaws.quicksight#StartDashboardSnapshotJob" + }, + { + "target": "com.amazonaws.quicksight#TagResource" + }, + { + "target": "com.amazonaws.quicksight#UntagResource" + }, + { + "target": "com.amazonaws.quicksight#UpdateAccountCustomization" + }, + { + "target": "com.amazonaws.quicksight#UpdateAccountSettings" + }, + { + "target": "com.amazonaws.quicksight#UpdateAnalysis" + }, + { + "target": "com.amazonaws.quicksight#UpdateAnalysisPermissions" + }, + { + "target": "com.amazonaws.quicksight#UpdateDashboard" + }, + { + "target": "com.amazonaws.quicksight#UpdateDashboardLinks" + }, + { + "target": "com.amazonaws.quicksight#UpdateDashboardPermissions" + }, + { + "target": "com.amazonaws.quicksight#UpdateDashboardPublishedVersion" + }, + { + "target": "com.amazonaws.quicksight#UpdateDataSet" + }, + { + "target": "com.amazonaws.quicksight#UpdateDataSetPermissions" + }, + { + "target": "com.amazonaws.quicksight#UpdateDataSource" + }, + { + "target": "com.amazonaws.quicksight#UpdateDataSourcePermissions" + }, + { + "target": "com.amazonaws.quicksight#UpdateFolder" + }, + { + "target": "com.amazonaws.quicksight#UpdateFolderPermissions" + }, + { + "target": "com.amazonaws.quicksight#UpdateGroup" + }, + { + "target": "com.amazonaws.quicksight#UpdateIAMPolicyAssignment" + }, + { + "target": "com.amazonaws.quicksight#UpdateIdentityPropagationConfig" + }, + { + "target": "com.amazonaws.quicksight#UpdateIpRestriction" + }, + { + "target": "com.amazonaws.quicksight#UpdateKeyRegistration" + }, + { + "target": "com.amazonaws.quicksight#UpdatePublicSharingSettings" + }, + { + "target": "com.amazonaws.quicksight#UpdateRefreshSchedule" + }, + { + "target": "com.amazonaws.quicksight#UpdateRoleCustomPermission" + }, + { + "target": "com.amazonaws.quicksight#UpdateSPICECapacityConfiguration" + }, + { + "target": "com.amazonaws.quicksight#UpdateTemplate" + }, + { + "target": "com.amazonaws.quicksight#UpdateTemplateAlias" + }, + { + "target": "com.amazonaws.quicksight#UpdateTemplatePermissions" + }, + { + "target": "com.amazonaws.quicksight#UpdateTheme" + }, + { + "target": "com.amazonaws.quicksight#UpdateThemeAlias" + }, + { + "target": "com.amazonaws.quicksight#UpdateThemePermissions" + }, + { + "target": "com.amazonaws.quicksight#UpdateTopic" + }, + { + "target": "com.amazonaws.quicksight#UpdateTopicPermissions" + }, + { + "target": "com.amazonaws.quicksight#UpdateTopicRefreshSchedule" + }, + { + "target": "com.amazonaws.quicksight#UpdateUser" + }, + { + "target": "com.amazonaws.quicksight#UpdateVPCConnection" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "QuickSight", + "arnNamespace": "quicksight", + "cloudFormationName": "QuickSight", + "cloudTrailEventSource": "quicksight.amazonaws.com", + "endpointPrefix": "quicksight" + }, + "aws.auth#sigv4": { + "name": "quicksight" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Amazon QuickSight API Reference\n

Amazon QuickSight is a fully managed, serverless business intelligence service for the\n Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your\n organization. This API reference contains documentation for a programming interface that\n you can use to manage Amazon QuickSight.

", + "smithy.api#title": "Amazon QuickSight", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://quicksight-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://quicksight-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://quicksight.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://quicksight.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.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://quicksight.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.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://quicksight.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://quicksight.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region api with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.api.amazonaws.com" + } + }, + "params": { + "Region": "api", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.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://quicksight.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.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://quicksight.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.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://quicksight.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://quicksight-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://quicksight-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://quicksight.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://quicksight-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://quicksight-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://quicksight.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://quicksight.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region api with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.api.amazonaws.com" + } + }, + "params": { + "Region": "api", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://quicksight-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://quicksight-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://quicksight.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://quicksight.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://quicksight-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://quicksight.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://quicksight-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://quicksight.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.quicksight#RadarChartAggregatedFieldWells": { + "type": "structure", + "members": { + "Category": { + "target": "com.amazonaws.quicksight#RadarChartCategoryFieldList", + "traits": { + "smithy.api#documentation": "

The aggregated field well categories of a radar chart.

" + } + }, + "Color": { + "target": "com.amazonaws.quicksight#RadarChartColorFieldList", + "traits": { + "smithy.api#documentation": "

The color that are assigned to the aggregated field wells of a radar chart.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#RadarChartValuesFieldList", + "traits": { + "smithy.api#documentation": "

The values that are assigned to the aggregated field wells of a radar chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The aggregated field well configuration of a RadarChartVisual.

" + } + }, + "com.amazonaws.quicksight#RadarChartAreaStyleSettings": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility settings of a radar chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configured style settings of a radar chart.

" + } + }, + "com.amazonaws.quicksight#RadarChartAxesRangeScale": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "INDEPENDENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INDEPENDENT" + } + }, + "SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED" + } + } + } + }, + "com.amazonaws.quicksight#RadarChartCategoryFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#RadarChartColorFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#RadarChartConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#RadarChartFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a RadarChartVisual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#RadarChartSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a RadarChartVisual.

" + } + }, + "Shape": { + "target": "com.amazonaws.quicksight#RadarChartShape", + "traits": { + "smithy.api#documentation": "

The shape of the radar chart.

" + } + }, + "BaseSeriesSettings": { + "target": "com.amazonaws.quicksight#RadarChartSeriesSettings", + "traits": { + "smithy.api#documentation": "

The base sreies settings of a radar chart.

" + } + }, + "StartAngle": { + "target": "com.amazonaws.quicksight#RadarChartStartAngle", + "traits": { + "smithy.api#documentation": "

The start angle of a radar chart's axis.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" + } + }, + "AlternateBandColorsVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines the visibility of the colors of alternatign bands in a radar chart.

" + } + }, + "AlternateBandEvenColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color of the even-numbered alternate bands of a radar chart.

" + } + }, + "AlternateBandOddColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color of the odd-numbered alternate bands of a radar chart.

" + } + }, + "CategoryAxis": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The category axis of a radar chart.

" + } + }, + "CategoryLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The category label options of a radar chart.

" + } + }, + "ColorAxis": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The color axis of a radar chart.

" + } + }, + "ColorLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The color label options of a radar chart.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "

The legend display setup of the visual.

" + } + }, + "AxesRangeScale": { + "target": "com.amazonaws.quicksight#RadarChartAxesRangeScale", + "traits": { + "smithy.api#documentation": "

The axis behavior options of a radar chart.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a RadarChartVisual.

" + } + }, + "com.amazonaws.quicksight#RadarChartFieldWells": { + "type": "structure", + "members": { + "RadarChartAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#RadarChartAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a radar chart visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field wells of a radar chart visual.

" + } + }, + "com.amazonaws.quicksight#RadarChartSeriesSettings": { + "type": "structure", + "members": { + "AreaStyleSettings": { + "target": "com.amazonaws.quicksight#RadarChartAreaStyleSettings", + "traits": { + "smithy.api#documentation": "

The area style settings of a radar chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The series settings of a radar chart.

" + } + }, + "com.amazonaws.quicksight#RadarChartShape": { + "type": "enum", + "members": { + "CIRCLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CIRCLE" + } + }, + "POLYGON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POLYGON" + } + } + } + }, + "com.amazonaws.quicksight#RadarChartSortConfiguration": { + "type": "structure", + "members": { + "CategorySort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The category sort options of a radar chart.

" + } + }, + "CategoryItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The category items limit for a radar chart.

" + } + }, + "ColorSort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The color sort configuration of a radar chart.

" + } + }, + "ColorItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The color items limit of a radar chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a RadarChartVisual.

" + } + }, + "com.amazonaws.quicksight#RadarChartStartAngle": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": -360, + "max": 360 + } + } + }, + "com.amazonaws.quicksight#RadarChartValuesFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MeasureField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#RadarChartVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#RadarChartConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A radar chart visual.

" + } + }, + "com.amazonaws.quicksight#RangeConstant": { + "type": "structure", + "members": { + "Minimum": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The minimum value for a range constant.

" + } + }, + "Maximum": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The maximum value for a range constant.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a range constant.

" + } + }, + "com.amazonaws.quicksight#RangeEndsLabelType": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the range ends label.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The range ends label type of a data path label.

" + } + }, + "com.amazonaws.quicksight#RdsParameters": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.quicksight#InstanceId", + "traits": { + "smithy.api#documentation": "

Instance ID.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

Database.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for Amazon RDS.

" + } + }, + "com.amazonaws.quicksight#RecoveryWindowInDays": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 7, + "max": 30 + } + } + }, + "com.amazonaws.quicksight#RedshiftIAMParameters": { + "type": "structure", + "members": { + "RoleArn": { + "target": "com.amazonaws.quicksight#RoleArn", + "traits": { + "smithy.api#documentation": "

Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.

", + "smithy.api#required": {} + } + }, + "DatabaseUser": { + "target": "com.amazonaws.quicksight#DatabaseUser", + "traits": { + "smithy.api#documentation": "

The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.

" + } + }, + "DatabaseGroups": { + "target": "com.amazonaws.quicksight#DatabaseGroupList", + "traits": { + "smithy.api#documentation": "

A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.

" + } + }, + "AutoCreateDatabaseUser": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that grants Amazon QuickSight access to your cluster and make a call to the redshift:GetClusterCredentials API. For more information on the redshift:GetClusterCredentials API, see \n GetClusterCredentials\n .

" + } + }, + "com.amazonaws.quicksight#RedshiftParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

Host. This field can be blank if ClusterId is provided.

" + } + }, + "Port": { + "target": "com.amazonaws.quicksight#OptionalPort", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Port. This field can be blank if the ClusterId is provided.

" + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

Database.

", + "smithy.api#required": {} + } + }, + "ClusterId": { + "target": "com.amazonaws.quicksight#ClusterId", + "traits": { + "smithy.api#documentation": "

Cluster ID. This field can be blank if the Host and Port are\n provided.

" + } + }, + "IAMParameters": { + "target": "com.amazonaws.quicksight#RedshiftIAMParameters", + "traits": { + "smithy.api#documentation": "

An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.

" + } + }, + "IdentityCenterConfiguration": { + "target": "com.amazonaws.quicksight#IdentityCenterConfiguration", + "traits": { + "smithy.api#documentation": "

An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.

\n

This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for Amazon Redshift. The ClusterId field can be blank if\n Host and Port are both set. The Host and Port fields can be blank if the ClusterId field is set.

" + } + }, + "com.amazonaws.quicksight#ReferenceLine": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#WidgetStatus", + "traits": { + "smithy.api#documentation": "

The status of the reference line. Choose one of the following options:

\n " + } + }, + "DataConfiguration": { + "target": "com.amazonaws.quicksight#ReferenceLineDataConfiguration", + "traits": { + "smithy.api#documentation": "

The data configuration of the reference line.

", + "smithy.api#required": {} + } + }, + "StyleConfiguration": { + "target": "com.amazonaws.quicksight#ReferenceLineStyleConfiguration", + "traits": { + "smithy.api#documentation": "

The style configuration of the reference line.

" + } + }, + "LabelConfiguration": { + "target": "com.amazonaws.quicksight#ReferenceLineLabelConfiguration", + "traits": { + "smithy.api#documentation": "

The label configuration of the reference line.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The reference line visual display options.

" + } + }, + "com.amazonaws.quicksight#ReferenceLineCustomLabelConfiguration": { + "type": "structure", + "members": { + "CustomLabel": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The string text of the custom label.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a custom label on a ReferenceLine.

" + } + }, + "com.amazonaws.quicksight#ReferenceLineDataConfiguration": { + "type": "structure", + "members": { + "StaticConfiguration": { + "target": "com.amazonaws.quicksight#ReferenceLineStaticDataConfiguration", + "traits": { + "smithy.api#documentation": "

The static data configuration of the reference line data configuration.

" + } + }, + "DynamicConfiguration": { + "target": "com.amazonaws.quicksight#ReferenceLineDynamicDataConfiguration", + "traits": { + "smithy.api#documentation": "

The dynamic configuration of the reference line data configuration.

" + } + }, + "AxisBinding": { + "target": "com.amazonaws.quicksight#AxisBinding", + "traits": { + "smithy.api#documentation": "

The axis binding type of the reference line. Choose one of the following options:

\n " + } + }, + "SeriesType": { + "target": "com.amazonaws.quicksight#ReferenceLineSeriesType", + "traits": { + "smithy.api#documentation": "

The series type of the reference line data configuration. Choose one of the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The data configuration of the reference line.

" + } + }, + "com.amazonaws.quicksight#ReferenceLineDynamicDataConfiguration": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the dynamic data targets.

", + "smithy.api#required": {} + } + }, + "MeasureAggregationFunction": { + "target": "com.amazonaws.quicksight#AggregationFunction", + "traits": { + "smithy.api#documentation": "

The aggregation function that is used in the dynamic data.

" + } + }, + "Calculation": { + "target": "com.amazonaws.quicksight#NumericalAggregationFunction", + "traits": { + "smithy.api#documentation": "

The calculation that is used in the dynamic data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The dynamic configuration of the reference line data configuration.

" + } + }, + "com.amazonaws.quicksight#ReferenceLineLabelConfiguration": { + "type": "structure", + "members": { + "ValueLabelConfiguration": { + "target": "com.amazonaws.quicksight#ReferenceLineValueLabelConfiguration", + "traits": { + "smithy.api#documentation": "

The value label configuration of the label in a reference line.

" + } + }, + "CustomLabelConfiguration": { + "target": "com.amazonaws.quicksight#ReferenceLineCustomLabelConfiguration", + "traits": { + "smithy.api#documentation": "

The custom label configuration of the label in a reference line.

" + } + }, + "FontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration", + "traits": { + "smithy.api#documentation": "

The font configuration of the label in a reference line.

" + } + }, + "FontColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The font color configuration of the label in a reference line.

" + } + }, + "HorizontalPosition": { + "target": "com.amazonaws.quicksight#ReferenceLineLabelHorizontalPosition", + "traits": { + "smithy.api#documentation": "

The horizontal position configuration of the label in a reference line. Choose one of\n the following options:

\n " + } + }, + "VerticalPosition": { + "target": "com.amazonaws.quicksight#ReferenceLineLabelVerticalPosition", + "traits": { + "smithy.api#documentation": "

The vertical position configuration of the label in a reference line. Choose one of the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The label configuration of a reference line.

" + } + }, + "com.amazonaws.quicksight#ReferenceLineLabelHorizontalPosition": { + "type": "enum", + "members": { + "LEFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEFT" + } + }, + "CENTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CENTER" + } + }, + "RIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RIGHT" + } + } + } + }, + "com.amazonaws.quicksight#ReferenceLineLabelVerticalPosition": { + "type": "enum", + "members": { + "ABOVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABOVE" + } + }, + "BELOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BELOW" + } + } + } + }, + "com.amazonaws.quicksight#ReferenceLineList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ReferenceLine" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#ReferenceLinePatternType": { + "type": "enum", + "members": { + "SOLID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOLID" + } + }, + "DASHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DASHED" + } + }, + "DOTTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOTTED" + } + } + } + }, + "com.amazonaws.quicksight#ReferenceLineSeriesType": { + "type": "enum", + "members": { + "BAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BAR" + } + }, + "LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINE" + } + } + } + }, + "com.amazonaws.quicksight#ReferenceLineStaticDataConfiguration": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.quicksight#SensitiveDouble", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The double input of the static data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The static data configuration of the reference line data configuration.

" + } + }, + "com.amazonaws.quicksight#ReferenceLineStyleConfiguration": { + "type": "structure", + "members": { + "Pattern": { + "target": "com.amazonaws.quicksight#ReferenceLinePatternType", + "traits": { + "smithy.api#documentation": "

The pattern type of the line style. Choose one of the following options:

\n " + } + }, + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The hex color of the reference line.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The style configuration of the reference\n line.

" + } + }, + "com.amazonaws.quicksight#ReferenceLineValueLabelConfiguration": { + "type": "structure", + "members": { + "RelativePosition": { + "target": "com.amazonaws.quicksight#ReferenceLineValueLabelRelativePosition", + "traits": { + "smithy.api#documentation": "

The relative position of the value label. Choose one of the following options:

\n " + } + }, + "FormatConfiguration": { + "target": "com.amazonaws.quicksight#NumericFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The format configuration of the value label.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The value label configuration of the label in a reference line.

" + } + }, + "com.amazonaws.quicksight#ReferenceLineValueLabelRelativePosition": { + "type": "enum", + "members": { + "BEFORE_CUSTOM_LABEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEFORE_CUSTOM_LABEL" + } + }, + "AFTER_CUSTOM_LABEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AFTER_CUSTOM_LABEL" + } + } + } + }, + "com.amazonaws.quicksight#RefreshConfiguration": { + "type": "structure", + "members": { + "IncrementalRefresh": { + "target": "com.amazonaws.quicksight#IncrementalRefresh", + "traits": { + "smithy.api#documentation": "

The incremental refresh for the dataset.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The refresh configuration of a dataset.

" + } + }, + "com.amazonaws.quicksight#RefreshFrequency": { + "type": "structure", + "members": { + "Interval": { + "target": "com.amazonaws.quicksight#RefreshInterval", + "traits": { + "smithy.api#documentation": "

The interval between scheduled refreshes. Valid values are as follows:

\n ", + "smithy.api#required": {} + } + }, + "RefreshOnDay": { + "target": "com.amazonaws.quicksight#ScheduleRefreshOnEntity", + "traits": { + "smithy.api#documentation": "

The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.

" + } + }, + "Timezone": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs().

" + } + }, + "TimeOfTheDay": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the interval between each scheduled refresh of a dataset.

" + } + }, + "com.amazonaws.quicksight#RefreshInterval": { + "type": "enum", + "members": { + "MINUTE15": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MINUTE15" + } + }, + "MINUTE30": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MINUTE30" + } + }, + "HOURLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOURLY" + } + }, + "DAILY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAILY" + } + }, + "WEEKLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEEKLY" + } + }, + "MONTHLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTHLY" + } + } + } + }, + "com.amazonaws.quicksight#RefreshSchedule": { + "type": "structure", + "members": { + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

An identifier for the refresh schedule.

", + "smithy.api#required": {} + } + }, + "ScheduleFrequency": { + "target": "com.amazonaws.quicksight#RefreshFrequency", + "traits": { + "smithy.api#documentation": "

The frequency for the refresh schedule.

", + "smithy.api#required": {} + } + }, + "StartAfterDateTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

" + } + }, + "RefreshType": { + "target": "com.amazonaws.quicksight#IngestionType", + "traits": { + "smithy.api#documentation": "

The type of refresh that a datset undergoes. Valid values are as follows:

\n \n

For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon QuickSight User Guide.

", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the refresh schedule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The refresh schedule of a dataset.

" + } + }, + "com.amazonaws.quicksight#RefreshSchedules": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#RefreshSchedule", + "traits": { + "smithy.api#documentation": "

A list of RefreshSchedule objects.

" + } + } + }, + "com.amazonaws.quicksight#RegisterUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#RegisterUserRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#RegisterUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#RegisterUserRequest": { + "type": "structure", + "members": { + "IdentityType": { + "target": "com.amazonaws.quicksight#IdentityType", + "traits": { + "smithy.api#documentation": "

The identity type that your Amazon QuickSight account uses to manage the identity of users.

", + "smithy.api#required": {} + } + }, + "Email": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The email address of the user that you want to register.

", + "smithy.api#required": {} + } + }, + "UserRole": { + "target": "com.amazonaws.quicksight#UserRole", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight role for the user. The user role can be one of the\n\t\t\tfollowing:

\n ", + "smithy.api#required": {} + } + }, + "IamArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM user or role that you are registering with Amazon QuickSight.

" + } + }, + "SessionName": { + "target": "com.amazonaws.quicksight#RoleSessionName", + "traits": { + "smithy.api#documentation": "

You need to use this parameter only when you register one or more users using an assumed\n\t\t\tIAM role. You don't need to provide the session name for other scenarios, for example when\n\t\t\tyou are registering an IAM user or an Amazon QuickSight user. You can register multiple\n\t\t\tusers using the same IAM role if each user has a different session name. For more\n\t\t\tinformation on assuming IAM roles, see \n assume-role\n in the CLI Reference.\n

" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "UserName": { + "target": "com.amazonaws.quicksight#UserName", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight user name that you want to create for the user you are\n\t\t\tregistering.

" + } + }, + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#RoleName", + "traits": { + "smithy.api#documentation": "

(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:

\n \n

To add custom permissions to an existing user, use \n UpdateUser\n instead.

\n

A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the Amazon QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a Amazon QuickSight user.

\n

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning Amazon QuickSight users to one of the\n default security cohorts in Amazon QuickSight (admin, author, reader, admin pro, author pro, reader pro).

\n

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

" + } + }, + "ExternalLoginFederationProviderType": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

\n " + } + }, + "CustomFederationProviderUrl": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate\n into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should\n only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

" + } + }, + "ExternalLoginId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The identity ID for a user in the external login provider.

" + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

The tags to associate with the user.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#RegisterUserResponse": { + "type": "structure", + "members": { + "User": { + "target": "com.amazonaws.quicksight#User", + "traits": { + "smithy.api#documentation": "

The user's user name.

" + } + }, + "UserInvitationUrl": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The URL the user visits to complete registration and provide a password. This is\n\t\t\treturned only for users with an identity type of QUICKSIGHT.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#RegisteredCustomerManagedKey": { + "type": "structure", + "members": { + "KeyArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key that is registered to a Amazon QuickSight account for encryption and decryption use.

" + } + }, + "DefaultKey": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a RegisteredCustomerManagedKey is set as the default key for encryption and decryption use.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A customer managed key structure that contains the information listed below:

\n " + } + }, + "com.amazonaws.quicksight#RegisteredUserConsoleFeatureConfigurations": { + "type": "structure", + "members": { + "StatePersistence": { + "target": "com.amazonaws.quicksight#StatePersistenceConfigurations", + "traits": { + "smithy.api#documentation": "

The state persistence configurations of an embedded Amazon QuickSight console.

" + } + }, + "SharedView": { + "target": "com.amazonaws.quicksight#SharedViewConfigurations", + "traits": { + "smithy.api#documentation": "

The shared view settings of an embedded dashboard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The feature configurations of an embedded Amazon QuickSight console.

" + } + }, + "com.amazonaws.quicksight#RegisteredUserDashboardEmbeddingConfiguration": { + "type": "structure", + "members": { + "InitialDashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.

\n

If the user does not have permission to view this dashboard, they see a permissions error message.

", + "smithy.api#required": {} + } + }, + "FeatureConfigurations": { + "target": "com.amazonaws.quicksight#RegisteredUserDashboardFeatureConfigurations", + "traits": { + "smithy.api#documentation": "

The feature configurations of an embbedded Amazon QuickSight dashboard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the dashboard you want to embed.

" + } + }, + "com.amazonaws.quicksight#RegisteredUserDashboardFeatureConfigurations": { + "type": "structure", + "members": { + "StatePersistence": { + "target": "com.amazonaws.quicksight#StatePersistenceConfigurations", + "traits": { + "smithy.api#documentation": "

The state persistence settings of an embedded dashboard.

" + } + }, + "SharedView": { + "target": "com.amazonaws.quicksight#SharedViewConfigurations", + "traits": { + "smithy.api#documentation": "

The shared view settings of an embedded dashboard.

" + } + }, + "Bookmarks": { + "target": "com.amazonaws.quicksight#BookmarksConfigurations", + "traits": { + "smithy.api#documentation": "

The bookmarks configuration for an embedded dashboard in Amazon QuickSight.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The feature configuration for an embedded dashboard.

" + } + }, + "com.amazonaws.quicksight#RegisteredUserDashboardVisualEmbeddingConfiguration": { + "type": "structure", + "members": { + "InitialDashboardVisualId": { + "target": "com.amazonaws.quicksight#DashboardVisualId", + "traits": { + "smithy.api#documentation": "

The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.

\n

The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.

" + } + }, + "com.amazonaws.quicksight#RegisteredUserEmbeddingExperienceConfiguration": { + "type": "structure", + "members": { + "Dashboard": { + "target": "com.amazonaws.quicksight#RegisteredUserDashboardEmbeddingConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration details for providing a dashboard embedding experience.

" + } + }, + "QuickSightConsole": { + "target": "com.amazonaws.quicksight#RegisteredUserQuickSightConsoleEmbeddingConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User\n Guide.

\n

Use \n GenerateEmbedUrlForRegisteredUser\n \n where\n you want to provide an authoring portal that allows users to create data sources,\n datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console\n needs to belong to the author or admin security cohort. If you want to restrict permissions\n to some of these features, add a custom permissions profile to the user with the\n \n UpdateUser\n API operation. Use the \n RegisterUser\n API operation to add a new user with a custom permission profile attached. For more\n information, see the following sections in the Amazon QuickSight User\n Guide:

\n \n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

" + } + }, + "QSearchBar": { + "target": "com.amazonaws.quicksight#RegisteredUserQSearchBarEmbeddingConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration details for embedding the Q search bar.

\n

For more information about embedding the Q search bar, see Embedding Overview in\n the Amazon QuickSight User Guide.

" + } + }, + "DashboardVisual": { + "target": "com.amazonaws.quicksight#RegisteredUserDashboardVisualEmbeddingConfiguration", + "traits": { + "smithy.api#documentation": "

The type of embedding experience. In this case, Amazon QuickSight visuals.

" + } + }, + "GenerativeQnA": { + "target": "com.amazonaws.quicksight#RegisteredUserGenerativeQnAEmbeddingConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration details for embedding the Generative Q&A experience.

\n

For more information about embedding the Generative Q&A experience, see Embedding Overview in\n the Amazon QuickSight User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.

\n \n

Exactly one of the experience configurations is required. You can choose\n Dashboard or QuickSightConsole. You cannot choose more\n than one experience configuration.

\n " + } + }, + "com.amazonaws.quicksight#RegisteredUserGenerativeQnAEmbeddingConfiguration": { + "type": "structure", + "members": { + "InitialTopicId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&A experience.\n You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening\n a topic. The ID is in the URL for the topic that you open.

\n

If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader experience topics is shown in the Generative Q&A experience for your readers. When you select an initial new reader experience topic, you can specify whether or not readers are allowed to select other new reader experience topics from the available ones in the list.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that provides information about the configuration of a Generative Q&A experience.

" + } + }, + "com.amazonaws.quicksight#RegisteredUserQSearchBarEmbeddingConfiguration": { + "type": "structure", + "members": { + "InitialTopicId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the Amazon QuickSight console, navigate to the Topics pane, and choose thre topic that you want to use. The TopicID is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers\n are allowed to select other topics from the list of available topics.

\n

If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the Q search bar embedding experience.

" + } + }, + "com.amazonaws.quicksight#RegisteredUserQuickSightConsoleEmbeddingConfiguration": { + "type": "structure", + "members": { + "InitialPath": { + "target": "com.amazonaws.quicksight#EntryPath", + "traits": { + "smithy.api#documentation": "

The initial URL path for the Amazon QuickSight console. InitialPath is required.

\n

The entry point URL is constrained to the following paths:

\n " + } + }, + "FeatureConfigurations": { + "target": "com.amazonaws.quicksight#RegisteredUserConsoleFeatureConfigurations", + "traits": { + "smithy.api#documentation": "

The embedding configuration of an embedded Amazon QuickSight console.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the Amazon QuickSight console that you want to embed.

" + } + }, + "com.amazonaws.quicksight#RelationalTable": { + "type": "structure", + "members": { + "DataSourceArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the data source.

", + "smithy.api#required": {} + } + }, + "Catalog": { + "target": "com.amazonaws.quicksight#RelationalTableCatalog", + "traits": { + "smithy.api#documentation": "

The catalog associated with a table.

" + } + }, + "Schema": { + "target": "com.amazonaws.quicksight#RelationalTableSchema", + "traits": { + "smithy.api#documentation": "

The schema name. This name applies to certain relational database engines.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#RelationalTableName", + "traits": { + "smithy.api#documentation": "

The name of the relational table.

", + "smithy.api#required": {} + } + }, + "InputColumns": { + "target": "com.amazonaws.quicksight#InputColumnList", + "traits": { + "smithy.api#documentation": "

The column schema of the table.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A physical table type for relational data sources.

" + } + }, + "com.amazonaws.quicksight#RelationalTableCatalog": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#RelationalTableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#RelationalTableSchema": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#RelativeDateTimeControlDisplayOptions": { + "type": "structure", + "members": { + "TitleOptions": { + "target": "com.amazonaws.quicksight#LabelOptions", + "traits": { + "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" + } + }, + "DateTimeFormat": { + "target": "com.amazonaws.quicksight#DateTimeFormat", + "traits": { + "smithy.api#documentation": "

Customize how dates are formatted in controls.

" + } + }, + "InfoIconLabelOptions": { + "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", + "traits": { + "smithy.api#documentation": "

The configuration of info icon label options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "com.amazonaws.quicksight#RelativeDateType": { + "type": "enum", + "members": { + "PREVIOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREVIOUS" + } + }, + "THIS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THIS" + } + }, + "LAST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST" + } + }, + "NOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOW" + } + }, + "NEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEXT" + } + } + } + }, + "com.amazonaws.quicksight#RelativeDatesFilter": { + "type": "structure", + "members": { + "FilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "AnchorDateConfiguration": { + "target": "com.amazonaws.quicksight#AnchorDateConfiguration", + "traits": { + "smithy.api#documentation": "

The date configuration of the filter.

", + "smithy.api#required": {} + } + }, + "MinimumGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The minimum granularity (period granularity) of the relative dates filter.

" + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

", + "smithy.api#required": {} + } + }, + "RelativeDateType": { + "target": "com.amazonaws.quicksight#RelativeDateType", + "traits": { + "smithy.api#documentation": "

The range date type of the filter. Choose one of the options below:

\n ", + "smithy.api#required": {} + } + }, + "RelativeDateValue": { + "target": "com.amazonaws.quicksight#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The date value of the filter.

" + } + }, + "ParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The parameter whose value should be used for the filter value.

" + } + }, + "NullOption": { + "target": "com.amazonaws.quicksight#FilterNullOption", + "traits": { + "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", + "smithy.api#required": {} + } + }, + "ExcludePeriodConfiguration": { + "target": "com.amazonaws.quicksight#ExcludePeriodConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for the exclude period of the filter.

" + } + }, + "DefaultFilterControlConfiguration": { + "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", + "traits": { + "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A RelativeDatesFilter filters relative dates values.

" + } + }, + "com.amazonaws.quicksight#RelativeFontSize": { + "type": "enum", + "members": { + "EXTRA_SMALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTRA_SMALL" + } + }, + "SMALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMALL" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LARGE" + } + }, + "EXTRA_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTRA_LARGE" + } + } + } + }, + "com.amazonaws.quicksight#RenameColumnOperation": { + "type": "structure", + "members": { + "ColumnName": { + "target": "com.amazonaws.quicksight#ColumnName", + "traits": { + "smithy.api#documentation": "

The name of the column to be renamed.

", + "smithy.api#required": {} + } + }, + "NewColumnName": { + "target": "com.amazonaws.quicksight#ColumnName", + "traits": { + "smithy.api#documentation": "

The new name for the column.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A transform operation that renames a column.

" + } + }, + "com.amazonaws.quicksight#ResizeOption": { + "type": "enum", + "members": { + "FIXED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIXED" + } + }, + "RESPONSIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESPONSIVE" + } + } + } + }, + "com.amazonaws.quicksight#ResourceExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "ResourceType": { + "target": "com.amazonaws.quicksight#ExceptionResourceType", + "traits": { + "smithy.api#documentation": "

The resource type for this request.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The resource specified already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.quicksight#ResourceId": { + "type": "string" + }, + "com.amazonaws.quicksight#ResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.quicksight#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "ResourceType": { + "target": "com.amazonaws.quicksight#ExceptionResourceType", + "traits": { + "smithy.api#documentation": "

The resource type for this request.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

One or more resources can't be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.quicksight#ResourcePermission": { + "type": "structure", + "members": { + "Principal": { + "target": "com.amazonaws.quicksight#Principal", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n ", + "smithy.api#required": {} + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#ActionList", + "traits": { + "smithy.api#documentation": "

The IAM action to grant or revoke permissions on.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Permission for the resource.

" + } + }, + "com.amazonaws.quicksight#ResourcePermissionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ResourcePermission" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#ResourceStatus": { + "type": "enum", + "members": { + "CREATION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_IN_PROGRESS" + } + }, + "CREATION_SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_SUCCESSFUL" + } + }, + "CREATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_FAILED" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" + } + }, + "UPDATE_SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_SUCCESSFUL" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.quicksight#ResourceUnavailableException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "ResourceType": { + "target": "com.amazonaws.quicksight#ExceptionResourceType", + "traits": { + "smithy.api#documentation": "

The resource type for this request.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This resource is currently unavailable.

", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.quicksight#RestoreAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#RestoreAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#RestoreAnalysisResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Restores an analysis.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/restore/analyses/{AnalysisId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#RestoreAnalysisRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis that you're restoring.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#RestoreAnalysisResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the analysis that you're restoring.

" + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis that you're restoring.\n

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#RestrictiveResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[\\w\\-]+$" + } + }, + "com.amazonaws.quicksight#ReviewedAnswerErrorCode": { + "type": "enum", + "members": { + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + }, + "MISSING_ANSWER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISSING_ANSWER" + } + }, + "DATASET_DOES_NOT_EXIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATASET_DOES_NOT_EXIST" + } + }, + "INVALID_DATASET_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_DATASET_ARN" + } + }, + "DUPLICATED_ANSWER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DUPLICATED_ANSWER" + } + }, + "INVALID_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_DATA" + } + }, + "MISSING_REQUIRED_FIELDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISSING_REQUIRED_FIELDS" + } + } + } + }, + "com.amazonaws.quicksight#Role": { + "type": "enum", + "members": { + "ADMIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADMIN" + } + }, + "AUTHOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHOR" + } + }, + "READER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READER" + } + }, + "ADMIN_PRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADMIN_PRO" + } + }, + "AUTHOR_PRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHOR_PRO" + } + }, + "READER_PRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READER_PRO" + } + } + } + }, + "com.amazonaws.quicksight#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#RoleName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9+=,.@_-]+$" + } + }, + "com.amazonaws.quicksight#RoleSessionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 64 + }, + "smithy.api#pattern": "^[\\w+=.@-]*$" + } + }, + "com.amazonaws.quicksight#RollingDateConfiguration": { + "type": "structure", + "members": { + "DataSetIdentifier": { + "target": "com.amazonaws.quicksight#DataSetIdentifier", + "traits": { + "smithy.api#documentation": "

The data set that is used in the rolling date configuration.

" + } + }, + "Expression": { + "target": "com.amazonaws.quicksight#Expression", + "traits": { + "smithy.api#documentation": "

The expression of the rolling date configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The rolling date configuration of a date time filter.

" + } + }, + "com.amazonaws.quicksight#RowAlternateColorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#HexColor" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#RowAlternateColorOptions": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#WidgetStatus", + "traits": { + "smithy.api#documentation": "

Determines the widget status.

" + } + }, + "RowAlternateColors": { + "target": "com.amazonaws.quicksight#RowAlternateColorList", + "traits": { + "smithy.api#documentation": "

Determines the list of row alternate colors.

" + } + }, + "UsePrimaryBackgroundColor": { + "target": "com.amazonaws.quicksight#WidgetStatus", + "traits": { + "smithy.api#documentation": "

The primary background color options for alternate rows.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the row alternate color options.

" + } + }, + "com.amazonaws.quicksight#RowInfo": { + "type": "structure", + "members": { + "RowsIngested": { + "target": "com.amazonaws.quicksight#Long", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The number of rows that were ingested.

" + } + }, + "RowsDropped": { + "target": "com.amazonaws.quicksight#Long", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The number of rows that were not ingested.

" + } + }, + "TotalRowsInDataset": { + "target": "com.amazonaws.quicksight#Long", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The total number of rows in the dataset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about rows for a data set SPICE ingestion.

" + } + }, + "com.amazonaws.quicksight#RowLevelPermissionDataSet": { + "type": "structure", + "members": { + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace associated with the dataset that contains permissions for RLS.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

", + "smithy.api#required": {} + } + }, + "PermissionPolicy": { + "target": "com.amazonaws.quicksight#RowLevelPermissionPolicy", + "traits": { + "smithy.api#documentation": "

The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS\n is included for backward compatibility only.

", + "smithy.api#required": {} + } + }, + "FormatVersion": { + "target": "com.amazonaws.quicksight#RowLevelPermissionFormatVersion", + "traits": { + "smithy.api#documentation": "

The user or group rules associated with the dataset that contains permissions for RLS.

\n

By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#Status", + "traits": { + "smithy.api#documentation": "

The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a dataset that contains permissions for row-level security (RLS).\n The permissions dataset maps fields to users or groups. For more information, see\n Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User\n Guide.

\n

The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is\n not supported for new RLS datasets.

" + } + }, + "com.amazonaws.quicksight#RowLevelPermissionFormatVersion": { + "type": "enum", + "members": { + "VERSION_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERSION_1" + } + }, + "VERSION_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERSION_2" + } + } + } + }, + "com.amazonaws.quicksight#RowLevelPermissionPolicy": { + "type": "enum", + "members": { + "GRANT_ACCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GRANT_ACCESS" + } + }, + "DENY_ACCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DENY_ACCESS" + } + } + } + }, + "com.amazonaws.quicksight#RowLevelPermissionTagConfiguration": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#Status", + "traits": { + "smithy.api#documentation": "

The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

" + } + }, + "TagRules": { + "target": "com.amazonaws.quicksight#RowLevelPermissionTagRuleList", + "traits": { + "smithy.api#documentation": "

A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

", + "smithy.api#required": {} + } + }, + "TagRuleConfigurations": { + "target": "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfigurationList", + "traits": { + "smithy.api#documentation": "

A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of tags on a dataset to set row-level security.

" + } + }, + "com.amazonaws.quicksight#RowLevelPermissionTagDelimiter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#RowLevelPermissionTagRule": { + "type": "structure", + "members": { + "TagKey": { + "target": "com.amazonaws.quicksight#SessionTagKey", + "traits": { + "smithy.api#documentation": "

The unique key for a tag.

", + "smithy.api#required": {} + } + }, + "ColumnName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The column name that a tag key is assigned to.

", + "smithy.api#required": {} + } + }, + "TagMultiValueDelimiter": { + "target": "com.amazonaws.quicksight#RowLevelPermissionTagDelimiter", + "traits": { + "smithy.api#documentation": "

A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.

" + } + }, + "MatchAllValue": { + "target": "com.amazonaws.quicksight#SessionTagValue", + "traits": { + "smithy.api#documentation": "

A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A set of rules associated with a tag.

" + } + }, + "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfiguration": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SessionTagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#RowLevelPermissionTagRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#RowLevelPermissionTagRule" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#RowSortList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FieldSortOptions" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#S3Bucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.quicksight#S3BucketConfiguration": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.

", + "smithy.api#required": {} + } + }, + "BucketPrefix": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The prefix of the Amazon S3 bucket that the generated snapshots are stored in.

", + "smithy.api#required": {} + } + }, + "BucketRegion": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An optional structure that contains the Amazon S3 bucket configuration that the generated snapshots are stored in. If you don't provide this information, generated snapshots are stored in the default Amazon QuickSight bucket.

" + } + }, + "com.amazonaws.quicksight#S3Key": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.quicksight#S3Parameters": { + "type": "structure", + "members": { + "ManifestFileLocation": { + "target": "com.amazonaws.quicksight#ManifestFileLocation", + "traits": { + "smithy.api#documentation": "

Location of the Amazon S3 manifest file. This is NULL if the manifest file was\n uploaded into Amazon QuickSight.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.quicksight#RoleArn", + "traits": { + "smithy.api#documentation": "

Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for S3.

" + } + }, + "com.amazonaws.quicksight#S3Source": { + "type": "structure", + "members": { + "DataSourceArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the data source.

", + "smithy.api#required": {} + } + }, + "UploadSettings": { + "target": "com.amazonaws.quicksight#UploadSettings", + "traits": { + "smithy.api#documentation": "

Information about the format for the S3 source file or files.

" + } + }, + "InputColumns": { + "target": "com.amazonaws.quicksight#InputColumnList", + "traits": { + "smithy.api#documentation": "

A physical table type for an S3 data source.

\n \n

For files that aren't JSON, only STRING data types are supported in input columns.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A physical table type for an S3 data source.

" + } + }, + "com.amazonaws.quicksight#S3Uri": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(https|s3)://([^/]+)/?(.*)$" + } + }, + "com.amazonaws.quicksight#SameSheetTargetVisualConfiguration": { + "type": "structure", + "members": { + "TargetVisuals": { + "target": "com.amazonaws.quicksight#TargetVisualList", + "traits": { + "smithy.api#documentation": "

A list of the target visual IDs that are located in the same sheet of the analysis.

" + } + }, + "TargetVisualOptions": { + "target": "com.amazonaws.quicksight#TargetVisualOptions", + "traits": { + "smithy.api#documentation": "

The options that choose the target visual in the same sheet.

\n

Valid values are defined as follows:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of the same-sheet target visuals that you want to be filtered.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#SankeyDiagramAggregatedFieldWells": { + "type": "structure", + "members": { + "Source": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The source field wells of a sankey diagram.

" + } + }, + "Destination": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The destination field wells of a sankey diagram.

" + } + }, + "Weight": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The weight field wells of a sankey diagram.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a sankey diagram.

" + } + }, + "com.amazonaws.quicksight#SankeyDiagramChartConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#SankeyDiagramFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a sankey diagram.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#SankeyDiagramSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a sankey diagram.

" + } + }, + "DataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The data label configuration of a sankey diagram.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a sankey diagram.

" + } + }, + "com.amazonaws.quicksight#SankeyDiagramFieldWells": { + "type": "structure", + "members": { + "SankeyDiagramAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#SankeyDiagramAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a sankey diagram.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a sankey diagram.

" + } + }, + "com.amazonaws.quicksight#SankeyDiagramSortConfiguration": { + "type": "structure", + "members": { + "WeightSort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the weight fields.

" + } + }, + "SourceItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of source nodes that are displayed in a sankey diagram.

" + } + }, + "DestinationItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of destination nodes that are displayed in a sankey diagram.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a sankey diagram.

" + } + }, + "com.amazonaws.quicksight#SankeyDiagramVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#SankeyDiagramChartConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of a sankey diagram.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A sankey diagram.

\n

For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#ScatterPlotCategoricallyAggregatedFieldWells": { + "type": "structure", + "members": { + "XAxis": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The x-axis field well of a scatter plot.

\n

The x-axis is aggregated by category.

" + } + }, + "YAxis": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The y-axis field well of a scatter plot.

\n

The y-axis is aggregated by category.

" + } + }, + "Category": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The category field well of a scatter plot.

" + } + }, + "Size": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The size field well of a scatter plot.

" + } + }, + "Label": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The label field well of a scatter plot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The aggregated field well of a scatter plot.

" + } + }, + "com.amazonaws.quicksight#ScatterPlotConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#ScatterPlotFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#ScatterPlotSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a scatter plot.

" + } + }, + "XAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.

" + } + }, + "XAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.

" + } + }, + "YAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.

" + } + }, + "YAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "

The legend display setup of the visual.

" + } + }, + "DataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The legend display setup of the visual.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a scatter plot.

" + } + }, + "com.amazonaws.quicksight#ScatterPlotFieldWells": { + "type": "structure", + "members": { + "ScatterPlotCategoricallyAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#ScatterPlotCategoricallyAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a scatter plot. The x and y-axes of scatter plots with aggregated field wells are aggregated by category, label, or both.

" + } + }, + "ScatterPlotUnaggregatedFieldWells": { + "target": "com.amazonaws.quicksight#ScatterPlotUnaggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The unaggregated field wells of a scatter plot. The x and y-axes of these scatter plots are\n unaggregated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a scatter plot.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#ScatterPlotSortConfiguration": { + "type": "structure", + "members": { + "ScatterPlotLimitConfiguration": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a scatter plot.

" + } + }, + "com.amazonaws.quicksight#ScatterPlotUnaggregatedFieldWells": { + "type": "structure", + "members": { + "XAxis": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The x-axis field well of a scatter plot.

\n

The x-axis is a dimension field and cannot be aggregated.

" + } + }, + "YAxis": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The y-axis field well of a scatter plot.

\n

The y-axis is a dimension field and cannot be aggregated.

" + } + }, + "Size": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The size field well of a scatter plot.

" + } + }, + "Category": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The category field well of a scatter plot.

" + } + }, + "Label": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The label field well of a scatter plot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The unaggregated field wells of a scatter plot.

" + } + }, + "com.amazonaws.quicksight#ScatterPlotVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#ScatterPlotConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A scatter plot.

\n

For more information, see Using scatter plots in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#ScheduleRefreshOnEntity": { + "type": "structure", + "members": { + "DayOfWeek": { + "target": "com.amazonaws.quicksight#DayOfWeek", + "traits": { + "smithy.api#documentation": "

The day of the week that you want to schedule a refresh on.

" + } + }, + "DayOfMonth": { + "target": "com.amazonaws.quicksight#DayOfMonth", + "traits": { + "smithy.api#documentation": "

The day of the month that you want to schedule refresh on.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The refresh on entity for weekly or monthly schedules.

" + } + }, + "com.amazonaws.quicksight#ScrollBarOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the data zoom scroll bar.

" + } + }, + "VisibleRange": { + "target": "com.amazonaws.quicksight#VisibleRangeOptions", + "traits": { + "smithy.api#documentation": "

The visibility range for the data zoom scroll bar.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The visual display options for a data zoom scroll bar.

" + } + }, + "com.amazonaws.quicksight#SearchAnalyses": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#SearchAnalysesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#SearchAnalysesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Searches for analyses that belong to the user specified in the filter.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/search/analyses", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AnalysisSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#SearchAnalysesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analyses that you're searching\n for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.quicksight#AnalysisSearchFilterList", + "traits": { + "smithy.api#documentation": "

The structure for the search filters that you want to apply to your search.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#SearchAnalysesResponse": { + "type": "structure", + "members": { + "AnalysisSummaryList": { + "target": "com.amazonaws.quicksight#AnalysisSummaryList", + "traits": { + "smithy.api#documentation": "

Metadata describing the analyses that you searched for.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.\n

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#SearchDashboards": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#SearchDashboardsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#SearchDashboardsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Searches for dashboards that belong to a user.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/search/dashboards", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DashboardSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#SearchDashboardsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the user whose dashboards you're searching\n for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.quicksight#DashboardSearchFilterList", + "traits": { + "smithy.api#documentation": "

The filters to apply to the search. Currently, you can search only by user name, for\n example, \"Filters\": [ { \"Name\": \"QUICKSIGHT_USER\", \"Operator\": \"StringEquals\",\n \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\" } ]\n

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#SearchDashboardsResponse": { + "type": "structure", + "members": { + "DashboardSummaryList": { + "target": "com.amazonaws.quicksight#DashboardSummaryList", + "traits": { + "smithy.api#documentation": "

The list of dashboards owned by the user specified in Filters in your\n request.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#SearchDataSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#SearchDataSetsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#SearchDataSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Use the SearchDataSets operation to search for datasets that belong to an account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/search/data-sets", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DataSetSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#SearchDataSetsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.quicksight#DataSetSearchFilterList", + "traits": { + "smithy.api#documentation": "

The filters to apply to the search.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#SearchDataSetsResponse": { + "type": "structure", + "members": { + "DataSetSummaries": { + "target": "com.amazonaws.quicksight#DataSetSummaryList", + "traits": { + "smithy.api#documentation": "

A DataSetSummaries object that returns a summary of a dataset.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#SearchDataSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#SearchDataSourcesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#SearchDataSourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Use the SearchDataSources operation to search for data sources that belong to an account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/search/data-sources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DataSourceSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#SearchDataSourcesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.quicksight#DataSourceSearchFilterList", + "traits": { + "smithy.api#documentation": "

The filters to apply to the search.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#SearchDataSourcesResponse": { + "type": "structure", + "members": { + "DataSourceSummaries": { + "target": "com.amazonaws.quicksight#DataSourceSummaryList", + "traits": { + "smithy.api#documentation": "

A DataSourceSummaries object that returns a summary of a data source.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#SearchFolders": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#SearchFoldersRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#SearchFoldersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#InvalidRequestException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Searches the subfolders in a folder.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/search/folders", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FolderSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#SearchFoldersRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.quicksight#FolderSearchFilterList", + "traits": { + "smithy.api#documentation": "

The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, \"Filters\": [ { \"Name\": \"PARENT_FOLDER_ARN\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:folder/folderId\" } ].

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#SearchFoldersResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "FolderSummaryList": { + "target": "com.amazonaws.quicksight#FolderSummaryList", + "traits": { + "smithy.api#documentation": "

A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#SearchGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#SearchGroupsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#SearchGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups-search", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "GroupList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#SearchGroupsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n Amazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return from this request.

", + "smithy.api#httpQuery": "max-results" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that you want to search.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.quicksight#GroupSearchFilterList", + "traits": { + "smithy.api#documentation": "

The structure for the search filters that you want to apply to your search.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#SearchGroupsResponse": { + "type": "structure", + "members": { + "GroupList": { + "target": "com.amazonaws.quicksight#GroupList", + "traits": { + "smithy.api#documentation": "

A list of groups in a specified namespace that match the filters you set in your SearchGroups request.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#Seasonality": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 180 + } + } + }, + "com.amazonaws.quicksight#SecondaryValueOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines the visibility of the secondary value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the secondary value of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#SecretArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[-a-z0-9]*:secretsmanager:[-a-z0-9]*:[0-9]{12}:secret:.+$" + } + }, + "com.amazonaws.quicksight#SectionAfterPageBreak": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#SectionPageBreakStatus", + "traits": { + "smithy.api#documentation": "

The option that enables or disables a page break at the end of a section.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a page break after a section.

" + } + }, + "com.amazonaws.quicksight#SectionBasedLayoutCanvasSizeOptions": { + "type": "structure", + "members": { + "PaperCanvasSizeOptions": { + "target": "com.amazonaws.quicksight#SectionBasedLayoutPaperCanvasSizeOptions", + "traits": { + "smithy.api#documentation": "

The options for a paper canvas of a section-based layout.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for the canvas of a section-based layout.

" + } + }, + "com.amazonaws.quicksight#SectionBasedLayoutConfiguration": { + "type": "structure", + "members": { + "HeaderSections": { + "target": "com.amazonaws.quicksight#HeaderFooterSectionConfigurationList", + "traits": { + "smithy.api#documentation": "

A list of header section configurations.

", + "smithy.api#required": {} + } + }, + "BodySections": { + "target": "com.amazonaws.quicksight#BodySectionConfigurationList", + "traits": { + "smithy.api#documentation": "

A list of body section configurations.

", + "smithy.api#required": {} + } + }, + "FooterSections": { + "target": "com.amazonaws.quicksight#HeaderFooterSectionConfigurationList", + "traits": { + "smithy.api#documentation": "

A list of footer section configurations.

", + "smithy.api#required": {} + } + }, + "CanvasSizeOptions": { + "target": "com.amazonaws.quicksight#SectionBasedLayoutCanvasSizeOptions", + "traits": { + "smithy.api#documentation": "

The options for the canvas of a section-based layout.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a\n section-based layout.

" + } + }, + "com.amazonaws.quicksight#SectionBasedLayoutPaperCanvasSizeOptions": { + "type": "structure", + "members": { + "PaperSize": { + "target": "com.amazonaws.quicksight#PaperSize", + "traits": { + "smithy.api#documentation": "

The paper size that is used to define canvas dimensions.

" + } + }, + "PaperOrientation": { + "target": "com.amazonaws.quicksight#PaperOrientation", + "traits": { + "smithy.api#documentation": "

The paper orientation that\n is used to define canvas dimensions. Choose one of the following\n options:

\n " + } + }, + "PaperMargin": { + "target": "com.amazonaws.quicksight#Spacing", + "traits": { + "smithy.api#documentation": "

Defines the spacing between the canvas content and the top, bottom, left, and right edges.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for a paper canvas of a section-based layout.

" + } + }, + "com.amazonaws.quicksight#SectionLayoutConfiguration": { + "type": "structure", + "members": { + "FreeFormLayout": { + "target": "com.amazonaws.quicksight#FreeFormSectionLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

The free-form layout configuration of a section.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The layout configuration of a section.

" + } + }, + "com.amazonaws.quicksight#SectionPageBreakConfiguration": { + "type": "structure", + "members": { + "After": { + "target": "com.amazonaws.quicksight#SectionAfterPageBreak", + "traits": { + "smithy.api#documentation": "

The configuration of a page break after a section.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a page break for a section.

" + } + }, + "com.amazonaws.quicksight#SectionPageBreakStatus": { + "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.quicksight#SectionStyle": { + "type": "structure", + "members": { + "Height": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The height of a section.

\n

Heights can only be defined for header and footer sections. The default height margin is 0.5 inches.

" + } + }, + "Padding": { + "target": "com.amazonaws.quicksight#Spacing", + "traits": { + "smithy.api#documentation": "

The spacing between section content and its top, bottom, left, and right edges.

\n

There is no padding by default.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that style a section.

" + } + }, + "com.amazonaws.quicksight#SecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^sg-[0-9a-z]*$" + } + }, + "com.amazonaws.quicksight#SecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.quicksight#SelectAllValueOptions": { + "type": "enum", + "members": { + "ALL_VALUES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_VALUES" + } + } + } + }, + "com.amazonaws.quicksight#SelectedFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FieldId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#SelectedFieldOptions": { + "type": "enum", + "members": { + "ALL_FIELDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_FIELDS" + } + } + } + }, + "com.amazonaws.quicksight#SelectedSheetsFilterScopeConfiguration": { + "type": "structure", + "members": { + "SheetVisualScopingConfigurations": { + "target": "com.amazonaws.quicksight#SheetVisualScopingConfigurations", + "traits": { + "smithy.api#documentation": "

The sheet ID and visual IDs of the sheet and visuals that the filter is applied to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for applying a filter to specific sheets or visuals. You can apply this filter to multiple visuals that are on one sheet or to all visuals on a sheet.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#SelectedTooltipType": { + "type": "enum", + "members": { + "BASIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASIC" + } + }, + "DETAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DETAILED" + } + } + } + }, + "com.amazonaws.quicksight#SemanticEntityType": { + "type": "structure", + "members": { + "TypeName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The semantic entity type name.

" + } + }, + "SubTypeName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The semantic entity sub type name.

" + } + }, + "TypeParameters": { + "target": "com.amazonaws.quicksight#TypeParameters", + "traits": { + "smithy.api#documentation": "

The semantic entity type parameters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a semantic entity type.

" + } + }, + "com.amazonaws.quicksight#SemanticType": { + "type": "structure", + "members": { + "TypeName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The semantic type name.

" + } + }, + "SubTypeName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The semantic type sub type name.

" + } + }, + "TypeParameters": { + "target": "com.amazonaws.quicksight#TypeParameters", + "traits": { + "smithy.api#documentation": "

The semantic type parameters.

" + } + }, + "TruthyCellValue": { + "target": "com.amazonaws.quicksight#SensitiveString", + "traits": { + "smithy.api#documentation": "

The semantic type truthy cell value.

" + } + }, + "TruthyCellValueSynonyms": { + "target": "com.amazonaws.quicksight#SensitiveStringList", + "traits": { + "smithy.api#documentation": "

The other names or aliases for the true cell value.

" + } + }, + "FalseyCellValue": { + "target": "com.amazonaws.quicksight#SensitiveString", + "traits": { + "smithy.api#documentation": "

The semantic type falsey cell value.

" + } + }, + "FalseyCellValueSynonyms": { + "target": "com.amazonaws.quicksight#SensitiveStringList", + "traits": { + "smithy.api#documentation": "

The other names or aliases for the false cell value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a semantic type.

" + } + }, + "com.amazonaws.quicksight#SensitiveDouble": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#SensitiveDoubleList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SensitiveDouble" + } + }, + "com.amazonaws.quicksight#SensitiveDoubleObject": { + "type": "double", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#SensitiveLong": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#SensitiveLongList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SensitiveLong" + } + }, + "com.amazonaws.quicksight#SensitiveLongObject": { + "type": "long", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#SensitiveS3Uri": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(https|s3)://([^/]+)/?(.*)$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#SensitiveStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SensitiveString" + } + }, + "com.amazonaws.quicksight#SensitiveStringObject": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#SensitiveTimestamp": { + "type": "timestamp", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#SensitiveTimestampList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SensitiveTimestamp" + } + }, + "com.amazonaws.quicksight#SeriesItem": { + "type": "structure", + "members": { + "FieldSeriesItem": { + "target": "com.amazonaws.quicksight#FieldSeriesItem", + "traits": { + "smithy.api#documentation": "

The field series item configuration of a line chart.

" + } + }, + "DataFieldSeriesItem": { + "target": "com.amazonaws.quicksight#DataFieldSeriesItem", + "traits": { + "smithy.api#documentation": "

The data field series item configuration of a line chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The series item configuration of a line chart.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#SeriesItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SeriesItem" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.quicksight#ServiceNowParameters": { + "type": "structure", + "members": { + "SiteBaseUrl": { + "target": "com.amazonaws.quicksight#SiteBaseUrl", + "traits": { + "smithy.api#documentation": "

URL of the base site.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for ServiceNow.

" + } + }, + "com.amazonaws.quicksight#ServiceType": { + "type": "enum", + "members": { + "REDSHIFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REDSHIFT" + } + } + } + }, + "com.amazonaws.quicksight#SessionLifetimeInMinutes": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 15, + "max": 600 + } + } + }, + "com.amazonaws.quicksight#SessionLifetimeInMinutesInvalidException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The number of minutes specified for the lifetime of a session isn't valid. The session\n\t\t\tlifetime must be 15-600 minutes.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.quicksight#SessionTag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.quicksight#SessionTagKey", + "traits": { + "smithy.api#documentation": "

The key for the tag.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#SessionTagValue", + "traits": { + "smithy.api#documentation": "

The value that you want to assign the tag.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The key-value pair used for the row-level security tags feature.

" + } + }, + "com.amazonaws.quicksight#SessionTagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.quicksight#SessionTagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SessionTagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#SessionTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SessionTag" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#SessionTagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#SetParameterValueConfiguration": { + "type": "structure", + "members": { + "DestinationParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The destination parameter name of the SetParameterValueConfiguration.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#DestinationParameterValueConfiguration", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of adding parameters in action.

" + } + }, + "com.amazonaws.quicksight#SetParameterValueConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SetParameterValueConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#ShapeConditionalFormat": { + "type": "structure", + "members": { + "BackgroundColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting for the shape background color of a filled map visual.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The shape conditional formatting of a filled map visual.

" + } + }, + "com.amazonaws.quicksight#SharedViewConfigurations": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The shared view settings of an embedded dashboard.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The shared view settings of an embedded dashboard.

" + } + }, + "com.amazonaws.quicksight#SharingModel": { + "type": "enum", + "members": { + "ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT" + } + }, + "NAMESPACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAMESPACE" + } + } + } + }, + "com.amazonaws.quicksight#Sheet": { + "type": "structure", + "members": { + "SheetId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier associated with a sheet.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#SheetName", + "traits": { + "smithy.api#documentation": "

The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A sheet, which is an object that contains a set of visuals that\n are viewed together on one page in Amazon QuickSight. Every analysis and dashboard\n contains at least one sheet. Each sheet contains at least one visualization widget, for\n example a chart, pivot table, or narrative insight. Sheets can be associated with other\n components, such as controls, filters, and so on.

" + } + }, + "com.amazonaws.quicksight#SheetContentType": { + "type": "enum", + "members": { + "PAGINATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAGINATED" + } + }, + "INTERACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERACTIVE" + } + } + } + }, + "com.amazonaws.quicksight#SheetControlDateTimePickerType": { + "type": "enum", + "members": { + "SINGLE_VALUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_VALUED" + } + }, + "DATE_RANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE_RANGE" + } + } + } + }, + "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility configuration of info icon label options.

" + } + }, + "InfoIconText": { + "target": "com.amazonaws.quicksight#SheetControlInfoIconText", + "traits": { + "smithy.api#documentation": "

The text content of info icon.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control to display info icons for filters and parameters.

" + } + }, + "com.amazonaws.quicksight#SheetControlInfoIconText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#SheetControlLayout": { + "type": "structure", + "members": { + "Configuration": { + "target": "com.amazonaws.quicksight#SheetControlLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that determines the elements and canvas size options of sheet control.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A grid layout to define the placement of sheet control.

" + } + }, + "com.amazonaws.quicksight#SheetControlLayoutConfiguration": { + "type": "structure", + "members": { + "GridLayout": { + "target": "com.amazonaws.quicksight#GridLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that determines the elements and canvas size options of sheet control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration that determines the elements and canvas size options of sheet control.

" + } + }, + "com.amazonaws.quicksight#SheetControlLayoutList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SheetControlLayout" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#SheetControlListType": { + "type": "enum", + "members": { + "MULTI_SELECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTI_SELECT" + } + }, + "SINGLE_SELECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_SELECT" + } + } + } + }, + "com.amazonaws.quicksight#SheetControlSliderType": { + "type": "enum", + "members": { + "SINGLE_POINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_POINT" + } + }, + "RANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RANGE" + } + } + } + }, + "com.amazonaws.quicksight#SheetControlTitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#SheetControlsOption": { + "type": "structure", + "members": { + "VisibilityState": { + "target": "com.amazonaws.quicksight#DashboardUIState", + "traits": { + "smithy.api#documentation": "

Visibility state.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Sheet controls option.

" + } + }, + "com.amazonaws.quicksight#SheetDefinition": { + "type": "structure", + "members": { + "SheetId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a sheet.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetTitle", + "traits": { + "smithy.api#documentation": "

The title of the sheet.

" + } + }, + "Description": { + "target": "com.amazonaws.quicksight#SheetDescription", + "traits": { + "smithy.api#documentation": "

A description of the sheet.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#SheetName", + "traits": { + "smithy.api#documentation": "

The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.

" + } + }, + "ParameterControls": { + "target": "com.amazonaws.quicksight#ParameterControlList", + "traits": { + "smithy.api#documentation": "

The list of parameter controls that are on a sheet.

\n

For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.

" + } + }, + "FilterControls": { + "target": "com.amazonaws.quicksight#FilterControlList", + "traits": { + "smithy.api#documentation": "

The list of filter controls that are on a sheet.

\n

For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide.

" + } + }, + "Visuals": { + "target": "com.amazonaws.quicksight#VisualList", + "traits": { + "smithy.api#documentation": "

A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

" + } + }, + "TextBoxes": { + "target": "com.amazonaws.quicksight#SheetTextBoxList", + "traits": { + "smithy.api#documentation": "

The text boxes that are on a sheet.

" + } + }, + "Layouts": { + "target": "com.amazonaws.quicksight#LayoutList", + "traits": { + "smithy.api#documentation": "

Layouts define how the components of a sheet are arranged.

\n

For more information, see Types of layout in the Amazon QuickSight User Guide.

" + } + }, + "SheetControlLayouts": { + "target": "com.amazonaws.quicksight#SheetControlLayoutList", + "traits": { + "smithy.api#documentation": "

The control layouts of the sheet.

" + } + }, + "ContentType": { + "target": "com.amazonaws.quicksight#SheetContentType", + "traits": { + "smithy.api#documentation": "

The layout content type of the sheet. Choose one of the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A sheet is an object that contains a set of visuals that\n are viewed together on one page in a paginated report. Every analysis and dashboard must contain at least one sheet.

" + } + }, + "com.amazonaws.quicksight#SheetDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SheetDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#SheetDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.quicksight#SheetElementConfigurationOverrides": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines whether or not the overrides are visible. Choose one of the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The override configuration of the rendering rules of a sheet.

" + } + }, + "com.amazonaws.quicksight#SheetElementRenderingRule": { + "type": "structure", + "members": { + "Expression": { + "target": "com.amazonaws.quicksight#Expression", + "traits": { + "smithy.api#documentation": "

The expression of the rendering rules of a sheet.

", + "smithy.api#required": {} + } + }, + "ConfigurationOverrides": { + "target": "com.amazonaws.quicksight#SheetElementConfigurationOverrides", + "traits": { + "smithy.api#documentation": "

The override configuration of the rendering rules of a sheet.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The rendering rules of a sheet that uses a free-form layout.

" + } + }, + "com.amazonaws.quicksight#SheetElementRenderingRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SheetElementRenderingRule" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10000 + } + } + }, + "com.amazonaws.quicksight#SheetLayoutElementMaximizationOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

The status of the sheet layout maximization options of a dashbaord.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sheet layout maximization options of a dashbaord.

" + } + }, + "com.amazonaws.quicksight#SheetList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Sheet" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#SheetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#SheetStyle": { + "type": "structure", + "members": { + "Tile": { + "target": "com.amazonaws.quicksight#TileStyle", + "traits": { + "smithy.api#documentation": "

The display options for tiles.

" + } + }, + "TileLayout": { + "target": "com.amazonaws.quicksight#TileLayoutStyle", + "traits": { + "smithy.api#documentation": "

The layout options for tiles.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The theme display options for sheets.

" + } + }, + "com.amazonaws.quicksight#SheetTextBox": { + "type": "structure", + "members": { + "SheetTextBoxId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier for a text box. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have text boxes that share identifiers.

", + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.quicksight#SheetTextBoxContent", + "traits": { + "smithy.api#documentation": "

The content that is displayed in the text box.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A text box.

" + } + }, + "com.amazonaws.quicksight#SheetTextBoxContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 150000 + } + } + }, + "com.amazonaws.quicksight#SheetTextBoxList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SheetTextBox" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#SheetTitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.quicksight#SheetVisualScopingConfiguration": { + "type": "structure", + "members": { + "SheetId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The selected sheet that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.quicksight#FilterVisualScope", + "traits": { + "smithy.api#documentation": "

The scope of the applied entities. Choose one of the following options:

\n ", + "smithy.api#required": {} + } + }, + "VisualIds": { + "target": "com.amazonaws.quicksight#FilteredVisualsList", + "traits": { + "smithy.api#documentation": "

The selected visuals that the filter is applied to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The filter that is applied to the options.

" + } + }, + "com.amazonaws.quicksight#SheetVisualScopingConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SheetVisualScopingConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#ShortFormatText": { + "type": "structure", + "members": { + "PlainText": { + "target": "com.amazonaws.quicksight#ShortPlainText", + "traits": { + "smithy.api#documentation": "

Plain text format.

" + } + }, + "RichText": { + "target": "com.amazonaws.quicksight#ShortRichText", + "traits": { + "smithy.api#documentation": "

Rich text. Examples of rich text include bold, underline, and italics.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The text format for the title.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#ShortPlainText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.quicksight#ShortRestrictiveResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[\\w\\-]+$" + } + }, + "com.amazonaws.quicksight#ShortRichText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.quicksight#SignupResponse": { + "type": "structure", + "members": { + "IAMUser": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean that is TRUE if the Amazon QuickSight uses IAM as an\n authentication method.

" + } + }, + "userLoginName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The user login name for your Amazon QuickSight account.

" + } + }, + "accountName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of your Amazon QuickSight account.

" + } + }, + "directoryType": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The type of Active Directory that is being used to authenticate the Amazon QuickSight\n account. Valid values are SIMPLE_AD, AD_CONNECTOR, and\n MICROSOFT_AD.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A SignupResponse object that contains a summary of a newly created account.

" + } + }, + "com.amazonaws.quicksight#SimpleAttributeAggregationFunction": { + "type": "enum", + "members": { + "UNIQUE_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNIQUE_VALUE" + } + } + } + }, + "com.amazonaws.quicksight#SimpleClusterMarker": { + "type": "structure", + "members": { + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color of the simple cluster marker.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The simple cluster marker of the cluster marker.

" + } + }, + "com.amazonaws.quicksight#SimpleNumericalAggregationFunction": { + "type": "enum", + "members": { + "SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM" + } + }, + "AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVERAGE" + } + }, + "MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIN" + } + }, + "MAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX" + } + }, + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "DISTINCT_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTINCT_COUNT" + } + }, + "VAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VAR" + } + }, + "VARP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARP" + } + }, + "STDEV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEV" + } + }, + "STDEVP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEVP" + } + }, + "MEDIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIAN" + } + } + } + }, + "com.amazonaws.quicksight#SimpleTotalAggregationFunction": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + }, + "SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM" + } + }, + "AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVERAGE" + } + }, + "MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIN" + } + }, + "MAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.quicksight#SingleAxisOptions": { + "type": "structure", + "members": { + "YAxisOptions": { + "target": "com.amazonaws.quicksight#YAxisOptions", + "traits": { + "smithy.api#documentation": "

The Y axis options of a single axis configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The settings of a chart's single axis configuration.

" + } + }, + "com.amazonaws.quicksight#SingleYAxisOption": { + "type": "enum", + "members": { + "PRIMARY_Y_AXIS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIMARY_Y_AXIS" + } + } + } + }, + "com.amazonaws.quicksight#SiteBaseUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.quicksight#SliderControlDisplayOptions": { + "type": "structure", + "members": { + "TitleOptions": { + "target": "com.amazonaws.quicksight#LabelOptions", + "traits": { + "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" + } + }, + "InfoIconLabelOptions": { + "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", + "traits": { + "smithy.api#documentation": "

The configuration of info icon label options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "com.amazonaws.quicksight#Slot": { + "type": "structure", + "members": { + "SlotId": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The slot ID of the slot.

" + } + }, + "VisualId": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The visual ID for the slot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for the slot.

" + } + }, + "com.amazonaws.quicksight#Slots": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Slot" + } + }, + "com.amazonaws.quicksight#SmallMultiplesAxisPlacement": { + "type": "enum", + "members": { + "OUTSIDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUTSIDE" + } + }, + "INSIDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSIDE" + } + } + } + }, + "com.amazonaws.quicksight#SmallMultiplesAxisProperties": { + "type": "structure", + "members": { + "Scale": { + "target": "com.amazonaws.quicksight#SmallMultiplesAxisScale", + "traits": { + "smithy.api#documentation": "

Determines whether scale of the axes are shared or independent. The default value is SHARED.

" + } + }, + "Placement": { + "target": "com.amazonaws.quicksight#SmallMultiplesAxisPlacement", + "traits": { + "smithy.api#documentation": "

Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures the properties of a chart's axes that are used by small multiples panels.

" + } + }, + "com.amazonaws.quicksight#SmallMultiplesAxisScale": { + "type": "enum", + "members": { + "SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED" + } + }, + "INDEPENDENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INDEPENDENT" + } + } + } + }, + "com.amazonaws.quicksight#SmallMultiplesDimensionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#SmallMultiplesOptions": { + "type": "structure", + "members": { + "MaxVisibleRows": { + "target": "com.amazonaws.quicksight#VisiblePanelRows", + "traits": { + "smithy.api#documentation": "

Sets the maximum number of visible rows to display in the grid of small multiples panels.

\n

The default value is Auto,\n which automatically adjusts the rows in the grid\n to fit the overall layout and size of the given chart.

" + } + }, + "MaxVisibleColumns": { + "target": "com.amazonaws.quicksight#VisiblePanelColumns", + "traits": { + "smithy.api#documentation": "

Sets the maximum number of visible columns to display in the grid of small multiples panels.

\n

The default is Auto, which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.

" + } + }, + "PanelConfiguration": { + "target": "com.amazonaws.quicksight#PanelConfiguration", + "traits": { + "smithy.api#documentation": "

Configures the display options for each small multiples panel.

" + } + }, + "XAxis": { + "target": "com.amazonaws.quicksight#SmallMultiplesAxisProperties", + "traits": { + "smithy.api#documentation": "

The properties of a small multiples X axis.

" + } + }, + "YAxis": { + "target": "com.amazonaws.quicksight#SmallMultiplesAxisProperties", + "traits": { + "smithy.api#documentation": "

The properties of a small multiples Y axis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options that determine the layout and display options of a chart's small multiples.

" + } + }, + "com.amazonaws.quicksight#SnapshotAnonymousUser": { + "type": "structure", + "members": { + "RowLevelPermissionTags": { + "target": "com.amazonaws.quicksight#SessionTagList", + "traits": { + "smithy.api#documentation": "

The tags to be used for row-level security (RLS). Make sure that the relevant datasets have RLS tags configured before you start a snapshot export job. You can configure the RLS tags of a dataset with a DataSet$RowLevelPermissionTagConfiguration API call.

\n

These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in Amazon QuickSight, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains information on the anonymous user configuration.

" + } + }, + "com.amazonaws.quicksight#SnapshotAnonymousUserList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SnapshotAnonymousUser" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#SnapshotAnonymousUserRedacted": { + "type": "structure", + "members": { + "RowLevelPermissionTagKeys": { + "target": "com.amazonaws.quicksight#SessionTagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys for the RowLevelPermissionTags.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Use this structure to redact sensitive information that you provide about an anonymous user from the snapshot.

" + } + }, + "com.amazonaws.quicksight#SnapshotAnonymousUserRedactedList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SnapshotAnonymousUserRedacted" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#SnapshotConfiguration": { + "type": "structure", + "members": { + "FileGroups": { + "target": "com.amazonaws.quicksight#SnapshotFileGroupList", + "traits": { + "smithy.api#documentation": "

A list of SnapshotJobResultFileGroup objects that contain information about the snapshot that is generated. This list can hold a maximum of 6 FileGroup configurations.

", + "smithy.api#required": {} + } + }, + "DestinationConfiguration": { + "target": "com.amazonaws.quicksight#SnapshotDestinationConfiguration", + "traits": { + "smithy.api#documentation": "

A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in.

" + } + }, + "Parameters": { + "target": "com.amazonaws.quicksight#Parameters" + } + }, + "traits": { + "smithy.api#documentation": "

Describes the configuration of the dashboard snapshot.

" + } + }, + "com.amazonaws.quicksight#SnapshotDestinationConfiguration": { + "type": "structure", + "members": { + "S3Destinations": { + "target": "com.amazonaws.quicksight#SnapshotS3DestinationConfigurationList", + "traits": { + "smithy.api#documentation": "

\n A list of SnapshotS3DestinationConfiguration objects that contain Amazon S3 destination configurations. This structure can hold a maximum of 1 S3DestinationConfiguration.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains information on the Amazon S3 destinations of the generated snapshot.

" + } + }, + "com.amazonaws.quicksight#SnapshotFile": { + "type": "structure", + "members": { + "SheetSelections": { + "target": "com.amazonaws.quicksight#SnapshotFileSheetSelectionList", + "traits": { + "smithy.api#documentation": "

A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF.

", + "smithy.api#required": {} + } + }, + "FormatType": { + "target": "com.amazonaws.quicksight#SnapshotFileFormatType", + "traits": { + "smithy.api#documentation": "

The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job.

" + } + }, + "com.amazonaws.quicksight#SnapshotFileFormatType": { + "type": "enum", + "members": { + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + }, + "PDF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PDF" + } + }, + "EXCEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXCEL" + } + } + } + }, + "com.amazonaws.quicksight#SnapshotFileGroup": { + "type": "structure", + "members": { + "Files": { + "target": "com.amazonaws.quicksight#SnapshotFileList", + "traits": { + "smithy.api#documentation": "

A list of SnapshotFile objects that contain the information on the snapshot files that need to be generated. This structure can hold 1 configuration at a time.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the information on the snapshot files.

" + } + }, + "com.amazonaws.quicksight#SnapshotFileGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SnapshotFileGroup" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 7 + } + } + }, + "com.amazonaws.quicksight#SnapshotFileList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SnapshotFile" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#SnapshotFileSheetSelection": { + "type": "structure", + "members": { + "SheetId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.

", + "smithy.api#required": {} + } + }, + "SelectionScope": { + "target": "com.amazonaws.quicksight#SnapshotFileSheetSelectionScope", + "traits": { + "smithy.api#documentation": "

The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.

\n ", + "smithy.api#required": {} + } + }, + "VisualIds": { + "target": "com.amazonaws.quicksight#SnapshotFileSheetSelectionVisualIdList", + "traits": { + "smithy.api#documentation": "

\n A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains information that identifies the snapshot that needs to be generated.

" + } + }, + "com.amazonaws.quicksight#SnapshotFileSheetSelectionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SnapshotFileSheetSelection" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.quicksight#SnapshotFileSheetSelectionScope": { + "type": "enum", + "members": { + "ALL_VISUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_VISUALS" + } + }, + "SELECTED_VISUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SELECTED_VISUALS" + } + } + } + }, + "com.amazonaws.quicksight#SnapshotFileSheetSelectionVisualIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.quicksight#SnapshotJobErrorInfo": { + "type": "structure", + "members": { + "ErrorMessage": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The error message.

" + } + }, + "ErrorType": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The error type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains information on the error that caused the snapshot job to fail.

" + } + }, + "com.amazonaws.quicksight#SnapshotJobResult": { + "type": "structure", + "members": { + "AnonymousUsers": { + "target": "com.amazonaws.quicksight#AnonymousUserSnapshotJobResultList", + "traits": { + "smithy.api#documentation": "

A list of AnonymousUserSnapshotJobResult objects that contain information on anonymous users and their user configurations. This data provided by you when you make a StartDashboardSnapshotJob API call.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that provides information on the result of a snapshot job. This object provides information about the job, the job status, and the location of the generated file.

" + } + }, + "com.amazonaws.quicksight#SnapshotJobResultErrorInfo": { + "type": "structure", + "members": { + "ErrorMessage": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The error message.

" + } + }, + "ErrorType": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The error type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information on the error that caused the snapshot job to fail.

" + } + }, + "com.amazonaws.quicksight#SnapshotJobResultErrorInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SnapshotJobResultErrorInfo" + } + }, + "com.amazonaws.quicksight#SnapshotJobResultFileGroup": { + "type": "structure", + "members": { + "Files": { + "target": "com.amazonaws.quicksight#SnapshotFileList", + "traits": { + "smithy.api#documentation": "

A list of SnapshotFile objects.

" + } + }, + "S3Results": { + "target": "com.amazonaws.quicksight#SnapshotJobS3ResultList", + "traits": { + "smithy.api#documentation": "

A list of SnapshotJobS3Result objects.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains information on the generated snapshot file groups.

" + } + }, + "com.amazonaws.quicksight#SnapshotJobResultFileGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SnapshotJobResultFileGroup" + } + }, + "com.amazonaws.quicksight#SnapshotJobS3Result": { + "type": "structure", + "members": { + "S3DestinationConfiguration": { + "target": "com.amazonaws.quicksight#SnapshotS3DestinationConfiguration", + "traits": { + "smithy.api#documentation": "

A list of Amazon S3 bucket configurations that are provided when you make a StartDashboardSnapshotJob API call.\n

" + } + }, + "S3Uri": { + "target": "com.amazonaws.quicksight#SensitiveS3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 Uri.

" + } + }, + "ErrorInfo": { + "target": "com.amazonaws.quicksight#SnapshotJobResultErrorInfoList", + "traits": { + "smithy.api#documentation": "

An array of error records that describe any failures that occur while the dashboard snapshot job runs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon S3 result from the snapshot job. The result includes the DestinationConfiguration and the Amazon S3 Uri. If an error occured during the job, the result returns information on the error.

" + } + }, + "com.amazonaws.quicksight#SnapshotJobS3ResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SnapshotJobS3Result" + } + }, + "com.amazonaws.quicksight#SnapshotJobStatus": { + "type": "enum", + "members": { + "QUEUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUED" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.quicksight#SnapshotS3DestinationConfiguration": { + "type": "structure", + "members": { + "BucketConfiguration": { + "target": "com.amazonaws.quicksight#S3BucketConfiguration", + "traits": { + "smithy.api#documentation": "

A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that describes the Amazon S3 settings to use to save the generated dashboard snapshot.

" + } + }, + "com.amazonaws.quicksight#SnapshotS3DestinationConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SnapshotS3DestinationConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#SnapshotUserConfiguration": { + "type": "structure", + "members": { + "AnonymousUsers": { + "target": "com.amazonaws.quicksight#SnapshotAnonymousUserList", + "traits": { + "smithy.api#documentation": "

An array of records that describe the anonymous users that the dashboard snapshot is generated for.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains information about the users that the dashboard snapshot is generated for.

" + } + }, + "com.amazonaws.quicksight#SnapshotUserConfigurationRedacted": { + "type": "structure", + "members": { + "AnonymousUsers": { + "target": "com.amazonaws.quicksight#SnapshotAnonymousUserRedactedList", + "traits": { + "smithy.api#documentation": "

\n An array of records that describe anonymous users that the dashboard snapshot is generated for. Sensitive user information is excluded.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains information about the users that the dashboard snapshot is generated for. Sensitive user information is excluded.\n

" + } + }, + "com.amazonaws.quicksight#SnowflakeParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

Host.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

Database.

", + "smithy.api#required": {} + } + }, + "Warehouse": { + "target": "com.amazonaws.quicksight#Warehouse", + "traits": { + "smithy.api#documentation": "

Warehouse.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for Snowflake.

" + } + }, + "com.amazonaws.quicksight#SortDirection": { + "type": "enum", + "members": { + "ASC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASC" + } + }, + "DESC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESC" + } + } + } + }, + "com.amazonaws.quicksight#Spacing": { + "type": "structure", + "members": { + "Top": { + "target": "com.amazonaws.quicksight#Length", + "traits": { + "smithy.api#documentation": "

Define the top spacing.

" + } + }, + "Bottom": { + "target": "com.amazonaws.quicksight#Length", + "traits": { + "smithy.api#documentation": "

Define the bottom spacing.

" + } + }, + "Left": { + "target": "com.amazonaws.quicksight#Length", + "traits": { + "smithy.api#documentation": "

Define the left spacing.

" + } + }, + "Right": { + "target": "com.amazonaws.quicksight#Length", + "traits": { + "smithy.api#documentation": "

Define the right spacing.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of spacing (often a margin or padding).

" + } + }, + "com.amazonaws.quicksight#SparkParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

Host.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

Port.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for Spark.

" + } + }, + "com.amazonaws.quicksight#SpecialValue": { + "type": "enum", + "members": { + "EMPTY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMPTY" + } + }, + "NULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NULL" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER" + } + } + } + }, + "com.amazonaws.quicksight#SqlEndpointPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.quicksight#SqlQuery": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 168000 + } + } + }, + "com.amazonaws.quicksight#SqlServerParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

Host.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

Port.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

Database.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for SQL Server.

" + } + }, + "com.amazonaws.quicksight#SslProperties": { + "type": "structure", + "members": { + "DisableSsl": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean option to control whether SSL should be disabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your\n underlying data source.

" + } + }, + "com.amazonaws.quicksight#StarburstParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

The host name of the Starburst data source.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

The port for the Starburst data source.

", + "smithy.api#required": {} + } + }, + "Catalog": { + "target": "com.amazonaws.quicksight#Catalog", + "traits": { + "smithy.api#documentation": "

The catalog name for the Starburst data source.

", + "smithy.api#required": {} + } + }, + "ProductType": { + "target": "com.amazonaws.quicksight#StarburstProductType", + "traits": { + "smithy.api#documentation": "

The product type for the Starburst data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters that are required to connect to a Starburst data source.

" + } + }, + "com.amazonaws.quicksight#StarburstProductType": { + "type": "enum", + "members": { + "GALAXY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GALAXY" + } + }, + "ENTERPRISE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENTERPRISE" + } + } + } + }, + "com.amazonaws.quicksight#StartAssetBundleExportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#StartAssetBundleExportJobRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#StartAssetBundleExportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an Asset Bundle export job.

\n

An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 5 export jobs concurrently.

\n

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/asset-bundle-export-jobs/export", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#StartAssetBundleExportJobRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account to export assets from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssetBundleExportJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

", + "smithy.api#required": {} + } + }, + "ResourceArns": { + "target": "com.amazonaws.quicksight#AssetBundleResourceArns", + "traits": { + "smithy.api#documentation": "

An array of resource ARNs to export. The following resources are supported.

\n \n

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

", + "smithy.api#required": {} + } + }, + "IncludeAllDependencies": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean that determines whether all dependencies of each resource ARN are recursively\n exported with the job. For example, say you provided a Dashboard ARN to the\n ResourceArns parameter. If you set IncludeAllDependencies to\n TRUE, any theme, dataset, and data source resource that is a dependency of the dashboard is also\n exported.

" + } + }, + "ExportFormat": { + "target": "com.amazonaws.quicksight#AssetBundleExportFormat", + "traits": { + "smithy.api#documentation": "

The export data format.

", + "smithy.api#required": {} + } + }, + "CloudFormationOverridePropertyConfiguration": { + "target": "com.amazonaws.quicksight#AssetBundleCloudFormationOverridePropertyConfiguration", + "traits": { + "smithy.api#documentation": "

An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.

\n

Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON.

" + } + }, + "IncludePermissions": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.\n

" + } + }, + "IncludeTags": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.

" + } + }, + "ValidationStrategy": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobValidationStrategy", + "traits": { + "smithy.api#documentation": "

An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#StartAssetBundleExportJobResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the export job.

" + } + }, + "AssetBundleExportJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services response ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the response.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#StartAssetBundleImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#StartAssetBundleImportJobRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#StartAssetBundleImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an Asset Bundle import job.

\n

An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently.

\n

The API caller must have the necessary \"create\", \"describe\", and \"update\" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/asset-bundle-import-jobs/import", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#StartAssetBundleImportJobRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account to import assets into.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssetBundleImportJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

", + "smithy.api#required": {} + } + }, + "AssetBundleImportSource": { + "target": "com.amazonaws.quicksight#AssetBundleImportSource", + "traits": { + "smithy.api#documentation": "

The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.\n

", + "smithy.api#required": {} + } + }, + "OverrideParameters": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideParameters", + "traits": { + "smithy.api#documentation": "

Optional overrides that are applied to the resource configuration before import.

" + } + }, + "FailureAction": { + "target": "com.amazonaws.quicksight#AssetBundleImportFailureAction", + "traits": { + "smithy.api#documentation": "

The failure action for the import job.

\n

If you choose ROLLBACK, failed import jobs will attempt to undo any asset changes caused by the failed job.

\n

If you choose DO_NOTHING, failed import jobs will not attempt to roll back\n any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.

" + } + }, + "OverridePermissions": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobOverridePermissions", + "traits": { + "smithy.api#documentation": "

Optional permission overrides that are applied to the resource configuration before import.

" + } + }, + "OverrideTags": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideTags", + "traits": { + "smithy.api#documentation": "

Optional tag overrides that are applied to the resource configuration before import.

" + } + }, + "OverrideValidationStrategy": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideValidationStrategy", + "traits": { + "smithy.api#documentation": "

An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#StartAssetBundleImportJobResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the import job.

" + } + }, + "AssetBundleImportJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services response ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the response.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#StartDashboardSnapshotJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#StartDashboardSnapshotJobRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#StartDashboardSnapshotJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedPricingPlanException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.

\n \n

The status of a submitted job can be polled with the DescribeDashboardSnapshotJob API. When you call the DescribeDashboardSnapshotJob API, check the JobStatus field in the response. Once the job reaches a COMPLETED or FAILED status, use the DescribeDashboardSnapshotJobResult API to obtain the URLs for the generated files. If the job fails, the DescribeDashboardSnapshotJobResult API returns detailed information about the error that occurred.

\n

\n StartDashboardSnapshotJob API throttling\n

\n

Amazon QuickSight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the StartDashboardSnapshotJob. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Amazon QuickSight throttles the API calls to maintin an optimal experience and reliability for all Amazon QuickSight users.

\n

\n Common throttling scenarios\n

\n

The following list provides information about the most commin throttling scenarios that can occur.

\n \n

If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account.

\n

\n Best practices to handle throttling\n

\n

If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Amazon QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example (12 minutes * 9 = 108 minutes). Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.

\n

The time that it takes to process a job can be impacted by the following factors:

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#StartDashboardSnapshotJobRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dashboard that you want to start a snapshot job for.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SnapshotJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.

", + "smithy.api#required": {} + } + }, + "UserConfiguration": { + "target": "com.amazonaws.quicksight#SnapshotUserConfiguration", + "traits": { + "smithy.api#documentation": "

\n A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.

", + "smithy.api#required": {} + } + }, + "SnapshotConfiguration": { + "target": "com.amazonaws.quicksight#SnapshotConfiguration", + "traits": { + "smithy.api#documentation": "

A structure that describes the configuration of the dashboard snapshot.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#StartDashboardSnapshotJobResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the dashboard snapshot job.

" + } + }, + "SnapshotJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services request ID for this operation.\n

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#StatePersistenceConfigurations": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The state perssitence configuration of an embedded dashboard.

" + } + }, + "com.amazonaws.quicksight#Status": { + "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.quicksight#StatusCode": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.quicksight#String": { + "type": "string" + }, + "com.amazonaws.quicksight#StringDatasetParameter": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.quicksight#DatasetParameterId", + "traits": { + "smithy.api#documentation": "

An identifier for the string parameter that is created in the dataset.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DatasetParameterName", + "traits": { + "smithy.api#documentation": "

The name of the string parameter that is created in the dataset.

", + "smithy.api#required": {} + } + }, + "ValueType": { + "target": "com.amazonaws.quicksight#DatasetParameterValueType", + "traits": { + "smithy.api#documentation": "

The value type of the dataset parameter. Valid values are single value or multi value.

", + "smithy.api#required": {} + } + }, + "DefaultValues": { + "target": "com.amazonaws.quicksight#StringDatasetParameterDefaultValues", + "traits": { + "smithy.api#documentation": "

A list of default values for a given string dataset parameter type. This structure only accepts static values.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A string parameter for a dataset.

" + } + }, + "com.amazonaws.quicksight#StringDatasetParameterDefaultValue": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The default value for the string parameter.

", + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "com.amazonaws.quicksight#StringDatasetParameterDefaultValues": { + "type": "structure", + "members": { + "StaticValues": { + "target": "com.amazonaws.quicksight#StringDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "

A list of static default values for a given string parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default values of a string parameter.

" + } + }, + "com.amazonaws.quicksight#StringDatasetParameterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#StringDatasetParameterDefaultValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.quicksight#StringDefaultValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SensitiveStringObject" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50000 + } + } + }, + "com.amazonaws.quicksight#StringDefaultValues": { + "type": "structure", + "members": { + "DynamicValue": { + "target": "com.amazonaws.quicksight#DynamicDefaultValue", + "traits": { + "smithy.api#documentation": "

The dynamic value of the StringDefaultValues. Different defaults displayed according to users, groups, and values mapping.

" + } + }, + "StaticValues": { + "target": "com.amazonaws.quicksight#StringDefaultValueList", + "traits": { + "smithy.api#documentation": "

The static values of the DecimalDefaultValues.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default values of the StringParameterDeclaration.

" + } + }, + "com.amazonaws.quicksight#StringFormatConfiguration": { + "type": "structure", + "members": { + "NullValueFormatConfiguration": { + "target": "com.amazonaws.quicksight#NullValueFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the null value format configuration.

" + } + }, + "NumericFormatConfiguration": { + "target": "com.amazonaws.quicksight#NumericFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The formatting configuration for numeric strings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Formatting configuration for string fields.

" + } + }, + "com.amazonaws.quicksight#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#String" + } + }, + "com.amazonaws.quicksight#StringParameter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A display name for a string parameter.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.quicksight#SensitiveStringList", + "traits": { + "smithy.api#documentation": "

The values of a string parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A string parameter.

" + } + }, + "com.amazonaws.quicksight#StringParameterDeclaration": { + "type": "structure", + "members": { + "ParameterValueType": { + "target": "com.amazonaws.quicksight#ParameterValueType", + "traits": { + "smithy.api#documentation": "

The value type determines whether the parameter is a single-value or multi-value parameter.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The name of the parameter that is being declared.

", + "smithy.api#required": {} + } + }, + "DefaultValues": { + "target": "com.amazonaws.quicksight#StringDefaultValues", + "traits": { + "smithy.api#documentation": "

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

" + } + }, + "ValueWhenUnset": { + "target": "com.amazonaws.quicksight#StringValueWhenUnsetConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that defines the default value of a String parameter when a value has not been set.

" + } + }, + "MappedDataSetParameters": { + "target": "com.amazonaws.quicksight#MappedDataSetParameters" + } + }, + "traits": { + "smithy.api#documentation": "

A parameter declaration for the String data type.

" + } + }, + "com.amazonaws.quicksight#StringParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#StringParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#StringValueWhenUnsetConfiguration": { + "type": "structure", + "members": { + "ValueWhenUnsetOption": { + "target": "com.amazonaws.quicksight#ValueWhenUnsetOption", + "traits": { + "smithy.api#documentation": "

The built-in options for default values. The value can be one of the following:

\n " + } + }, + "CustomValue": { + "target": "com.amazonaws.quicksight#SensitiveString", + "traits": { + "smithy.api#documentation": "

A custom value that's used when the value of a parameter isn't set.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration that defines the default value of a String parameter when a value has not been set.

" + } + }, + "com.amazonaws.quicksight#StyledCellType": { + "type": "enum", + "members": { + "TOTAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOTAL" + } + }, + "METRIC_HEADER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "METRIC_HEADER" + } + }, + "VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALUE" + } + } + } + }, + "com.amazonaws.quicksight#SubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^subnet-[0-9a-z]*$" + } + }, + "com.amazonaws.quicksight#SubnetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 15 + } + } + }, + "com.amazonaws.quicksight#SubtotalOptions": { + "type": "structure", + "members": { + "TotalsVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility configuration for the subtotal cells.

" + } + }, + "CustomLabel": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The custom label string for the subtotal cells.

" + } + }, + "FieldLevel": { + "target": "com.amazonaws.quicksight#PivotTableSubtotalLevel", + "traits": { + "smithy.api#documentation": "

The field level (all, custom, last) for the subtotal cells.

" + } + }, + "FieldLevelOptions": { + "target": "com.amazonaws.quicksight#PivotTableFieldSubtotalOptionsList", + "traits": { + "smithy.api#documentation": "

The optional configuration of subtotal cells.

" + } + }, + "TotalCellStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The cell styling options for the subtotal cells.

" + } + }, + "ValueCellStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The cell styling options for the subtotals of value cells.

" + } + }, + "MetricHeaderCellStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The cell styling options for the subtotals of header cells.

" + } + }, + "StyleTargets": { + "target": "com.amazonaws.quicksight#TableStyleTargetList", + "traits": { + "smithy.api#documentation": "

The style targets options for subtotals.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The subtotal options.

" + } + }, + "com.amazonaws.quicksight#SucceededTopicReviewedAnswer": { + "type": "structure", + "members": { + "AnswerId": { + "target": "com.amazonaws.quicksight#AnswerId", + "traits": { + "smithy.api#documentation": "

The answer ID for the SucceededTopicReviewedAnswer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a SucceededTopicReviewedAnswer.

" + } + }, + "com.amazonaws.quicksight#SucceededTopicReviewedAnswers": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SucceededTopicReviewedAnswer" + } + }, + "com.amazonaws.quicksight#SuccessfulKeyRegistrationEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SuccessfulKeyRegistrationEntry" + } + }, + "com.amazonaws.quicksight#SuccessfulKeyRegistrationEntry": { + "type": "structure", + "members": { + "KeyArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key that is associated with the SuccessfulKeyRegistrationEntry entry.

", + "smithy.api#required": {} + } + }, + "StatusCode": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of a SuccessfulKeyRegistrationEntry entry.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A success entry that occurs when a KeyRegistration job is successfully applied to the Amazon QuickSight account.

" + } + }, + "com.amazonaws.quicksight#Suffix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#Synonyms": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#LimitedString" + } + }, + "com.amazonaws.quicksight#TableAggregatedFieldWells": { + "type": "structure", + "members": { + "GroupBy": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The group by field well for a pivot table. Values are grouped by group by fields.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The values field well for a pivot table. Values are aggregated based on group by fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The aggregated field well for the table.

" + } + }, + "com.amazonaws.quicksight#TableBorderOptions": { + "type": "structure", + "members": { + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color of a table border.

" + } + }, + "Thickness": { + "target": "com.amazonaws.quicksight#TableBorderThickness", + "traits": { + "smithy.api#documentation": "

The thickness of a table border.

" + } + }, + "Style": { + "target": "com.amazonaws.quicksight#TableBorderStyle", + "traits": { + "smithy.api#documentation": "

The style (none, solid) of a table border.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The border options for a table border.

" + } + }, + "com.amazonaws.quicksight#TableBorderStyle": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "SOLID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOLID" + } + } + } + }, + "com.amazonaws.quicksight#TableBorderThickness": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 4 + } + } + }, + "com.amazonaws.quicksight#TableCellConditionalFormatting": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID of the cell for conditional formatting.

", + "smithy.api#required": {} + } + }, + "TextFormat": { + "target": "com.amazonaws.quicksight#TextConditionalFormat", + "traits": { + "smithy.api#documentation": "

The text format of the cell for conditional formatting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The cell conditional formatting option for a table.

" + } + }, + "com.amazonaws.quicksight#TableCellImageScalingConfiguration": { + "type": "enum", + "members": { + "FIT_TO_CELL_HEIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIT_TO_CELL_HEIGHT" + } + }, + "FIT_TO_CELL_WIDTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIT_TO_CELL_WIDTH" + } + }, + "DO_NOT_SCALE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DO_NOT_SCALE" + } + } + } + }, + "com.amazonaws.quicksight#TableCellImageSizingConfiguration": { + "type": "structure", + "members": { + "TableCellImageScalingConfiguration": { + "target": "com.amazonaws.quicksight#TableCellImageScalingConfiguration", + "traits": { + "smithy.api#documentation": "

The cell scaling configuration of the sizing options for the table image configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sizing options for the table image configuration.

" + } + }, + "com.amazonaws.quicksight#TableCellStyle": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the table cells.

" + } + }, + "FontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration", + "traits": { + "smithy.api#documentation": "

The font configuration of the table cells.

" + } + }, + "TextWrap": { + "target": "com.amazonaws.quicksight#TextWrap", + "traits": { + "smithy.api#documentation": "

The text wrap (none, wrap) for the table cells.

" + } + }, + "HorizontalTextAlignment": { + "target": "com.amazonaws.quicksight#HorizontalTextAlignment", + "traits": { + "smithy.api#documentation": "

The horizontal text alignment (left, center, right, auto) for the table cells.

" + } + }, + "VerticalTextAlignment": { + "target": "com.amazonaws.quicksight#VerticalTextAlignment", + "traits": { + "smithy.api#documentation": "

The vertical text alignment (top, middle, bottom) for the table cells.

" + } + }, + "BackgroundColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The background color for the table cells.

" + } + }, + "Height": { + "target": "com.amazonaws.quicksight#TableFieldHeight", + "traits": { + "smithy.api#documentation": "

The height color for the table cells.

" + } + }, + "Border": { + "target": "com.amazonaws.quicksight#GlobalTableBorderOptions", + "traits": { + "smithy.api#documentation": "

The borders for the table cells.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The table cell style for a cell in pivot table or table visual.

" + } + }, + "com.amazonaws.quicksight#TableConditionalFormatting": { + "type": "structure", + "members": { + "ConditionalFormattingOptions": { + "target": "com.amazonaws.quicksight#TableConditionalFormattingOptionList", + "traits": { + "smithy.api#documentation": "

Conditional formatting options for a PivotTableVisual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting for a PivotTableVisual.

" + } + }, + "com.amazonaws.quicksight#TableConditionalFormattingOption": { + "type": "structure", + "members": { + "Cell": { + "target": "com.amazonaws.quicksight#TableCellConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The cell conditional formatting option for a table.

" + } + }, + "Row": { + "target": "com.amazonaws.quicksight#TableRowConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The row conditional formatting option for a table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Conditional formatting options for a PivotTableVisual.

" + } + }, + "com.amazonaws.quicksight#TableConditionalFormattingOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TableConditionalFormattingOption" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.quicksight#TableConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#TableFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#TableSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration for a TableVisual.

" + } + }, + "TableOptions": { + "target": "com.amazonaws.quicksight#TableOptions", + "traits": { + "smithy.api#documentation": "

The table options for a table visual.

" + } + }, + "TotalOptions": { + "target": "com.amazonaws.quicksight#TotalOptions", + "traits": { + "smithy.api#documentation": "

The total options for a table visual.

" + } + }, + "FieldOptions": { + "target": "com.amazonaws.quicksight#TableFieldOptions", + "traits": { + "smithy.api#documentation": "

The field options for a table visual.

" + } + }, + "PaginatedReportOptions": { + "target": "com.amazonaws.quicksight#TablePaginatedReportOptions", + "traits": { + "smithy.api#documentation": "

The paginated report options for a table visual.

" + } + }, + "TableInlineVisualizations": { + "target": "com.amazonaws.quicksight#TableInlineVisualizationList", + "traits": { + "smithy.api#documentation": "

A collection of inline visualizations to display within a chart.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a TableVisual.

" + } + }, + "com.amazonaws.quicksight#TableFieldCustomIconContent": { + "type": "structure", + "members": { + "Icon": { + "target": "com.amazonaws.quicksight#TableFieldIconSetType", + "traits": { + "smithy.api#documentation": "

The icon set type (link) of the custom icon content for table URL link content.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The custom icon content for the table link content configuration.

" + } + }, + "com.amazonaws.quicksight#TableFieldCustomTextContent": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The string value of the custom text content for the table URL link content.

" + } + }, + "FontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration", + "traits": { + "smithy.api#documentation": "

The font configuration of the custom text content for the table URL link content.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The custom text content (value, font configuration) for the table link content configuration.

" + } + }, + "com.amazonaws.quicksight#TableFieldHeight": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 8, + "max": 500 + } + } + }, + "com.amazonaws.quicksight#TableFieldIconSetType": { + "type": "enum", + "members": { + "LINK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINK" + } + } + } + }, + "com.amazonaws.quicksight#TableFieldImageConfiguration": { + "type": "structure", + "members": { + "SizingOptions": { + "target": "com.amazonaws.quicksight#TableCellImageSizingConfiguration", + "traits": { + "smithy.api#documentation": "

The sizing options for the table image configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The image configuration of a table field URL.

" + } + }, + "com.amazonaws.quicksight#TableFieldLinkConfiguration": { + "type": "structure", + "members": { + "Target": { + "target": "com.amazonaws.quicksight#URLTargetConfiguration", + "traits": { + "smithy.api#documentation": "

The URL target (new tab, new window, same tab) for the table link configuration.

", + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.quicksight#TableFieldLinkContentConfiguration", + "traits": { + "smithy.api#documentation": "

The URL content (text, icon) for the table link configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The link configuration of a table field URL.

" + } + }, + "com.amazonaws.quicksight#TableFieldLinkContentConfiguration": { + "type": "structure", + "members": { + "CustomTextContent": { + "target": "com.amazonaws.quicksight#TableFieldCustomTextContent", + "traits": { + "smithy.api#documentation": "

The custom text content (value, font configuration) for the table link content configuration.

" + } + }, + "CustomIconContent": { + "target": "com.amazonaws.quicksight#TableFieldCustomIconContent", + "traits": { + "smithy.api#documentation": "

The custom icon content for the table link content configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The URL content (text, icon) for the table link configuration.

" + } + }, + "com.amazonaws.quicksight#TableFieldOption": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID for a table field.

", + "smithy.api#required": {} + } + }, + "Width": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The width for a table field.

" + } + }, + "CustomLabel": { + "target": "com.amazonaws.quicksight#CustomLabel", + "traits": { + "smithy.api#documentation": "

The custom label for a table field.

" + } + }, + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of a table field.

" + } + }, + "URLStyling": { + "target": "com.amazonaws.quicksight#TableFieldURLConfiguration", + "traits": { + "smithy.api#documentation": "

The URL configuration for a table field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for a table field.

" + } + }, + "com.amazonaws.quicksight#TableFieldOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TableFieldOption" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#TableFieldOptions": { + "type": "structure", + "members": { + "SelectedFieldOptions": { + "target": "com.amazonaws.quicksight#TableFieldOptionList", + "traits": { + "smithy.api#documentation": "

The field options to be configured to a table.

" + } + }, + "Order": { + "target": "com.amazonaws.quicksight#FieldOrderList", + "traits": { + "smithy.api#documentation": "

The order of the field IDs that are configured as field options for a table visual.

" + } + }, + "PinnedFieldOptions": { + "target": "com.amazonaws.quicksight#TablePinnedFieldOptions", + "traits": { + "smithy.api#documentation": "

The settings for the pinned columns of a table visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field options of a table visual.

" + } + }, + "com.amazonaws.quicksight#TableFieldOrderList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FieldId" + }, + "traits": { + "smithy.api#documentation": "

A list of table field IDs.

", + "smithy.api#length": { + "min": 0, + "max": 201 + } + } + }, + "com.amazonaws.quicksight#TableFieldURLConfiguration": { + "type": "structure", + "members": { + "LinkConfiguration": { + "target": "com.amazonaws.quicksight#TableFieldLinkConfiguration", + "traits": { + "smithy.api#documentation": "

The link configuration of a table field URL.

" + } + }, + "ImageConfiguration": { + "target": "com.amazonaws.quicksight#TableFieldImageConfiguration", + "traits": { + "smithy.api#documentation": "

The image configuration of a table field URL.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The URL configuration for a table field.

" + } + }, + "com.amazonaws.quicksight#TableFieldWells": { + "type": "structure", + "members": { + "TableAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#TableAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field well for the table.

" + } + }, + "TableUnaggregatedFieldWells": { + "target": "com.amazonaws.quicksight#TableUnaggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The unaggregated field well for the table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field wells for a table visual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#TableInlineVisualization": { + "type": "structure", + "members": { + "DataBars": { + "target": "com.amazonaws.quicksight#DataBarsOptions", + "traits": { + "smithy.api#documentation": "

The configuration of the inline visualization of the data bars within a chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The inline visualization of a specific type to display within a chart.

" + } + }, + "com.amazonaws.quicksight#TableInlineVisualizationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TableInlineVisualization" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#TableOptions": { + "type": "structure", + "members": { + "Orientation": { + "target": "com.amazonaws.quicksight#TableOrientation", + "traits": { + "smithy.api#documentation": "

The orientation (vertical, horizontal) for a table.

" + } + }, + "HeaderStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The table cell style of a table header.

" + } + }, + "CellStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The table cell style of table cells.

" + } + }, + "RowAlternateColorOptions": { + "target": "com.amazonaws.quicksight#RowAlternateColorOptions", + "traits": { + "smithy.api#documentation": "

The row alternate color options (widget status, row alternate colors) for a table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The table options for a table visual.

" + } + }, + "com.amazonaws.quicksight#TableOrientation": { + "type": "enum", + "members": { + "VERTICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERTICAL" + } + }, + "HORIZONTAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HORIZONTAL" + } + } + } + }, + "com.amazonaws.quicksight#TablePaginatedReportOptions": { + "type": "structure", + "members": { + "VerticalOverflowVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of printing table overflow across pages.

" + } + }, + "OverflowColumnHeaderVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of repeating header rows on each page.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The paginated report options for a table visual.

" + } + }, + "com.amazonaws.quicksight#TablePinnedFieldOptions": { + "type": "structure", + "members": { + "PinnedLeftFields": { + "target": "com.amazonaws.quicksight#TableFieldOrderList", + "traits": { + "smithy.api#documentation": "

A list of columns to be pinned to the left of a table visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The settings for the pinned columns of a table visual.

" + } + }, + "com.amazonaws.quicksight#TableRowConditionalFormatting": { + "type": "structure", + "members": { + "BackgroundColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting color (solid, gradient) of the background for a table row.

" + } + }, + "TextColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting color (solid, gradient) of the text for a table row.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting of a table row.

" + } + }, + "com.amazonaws.quicksight#TableSideBorderOptions": { + "type": "structure", + "members": { + "InnerVertical": { + "target": "com.amazonaws.quicksight#TableBorderOptions", + "traits": { + "smithy.api#documentation": "

The table border options of the inner vertical border.

" + } + }, + "InnerHorizontal": { + "target": "com.amazonaws.quicksight#TableBorderOptions", + "traits": { + "smithy.api#documentation": "

The table border options of the inner horizontal border.

" + } + }, + "Left": { + "target": "com.amazonaws.quicksight#TableBorderOptions", + "traits": { + "smithy.api#documentation": "

The table border options of the left border.

" + } + }, + "Right": { + "target": "com.amazonaws.quicksight#TableBorderOptions", + "traits": { + "smithy.api#documentation": "

The table border options of the right border.

" + } + }, + "Top": { + "target": "com.amazonaws.quicksight#TableBorderOptions", + "traits": { + "smithy.api#documentation": "

The table border options of the top border.

" + } + }, + "Bottom": { + "target": "com.amazonaws.quicksight#TableBorderOptions", + "traits": { + "smithy.api#documentation": "

The table border options of the bottom border.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The side border options for a table.

" + } + }, + "com.amazonaws.quicksight#TableSortConfiguration": { + "type": "structure", + "members": { + "RowSort": { + "target": "com.amazonaws.quicksight#RowSortList", + "traits": { + "smithy.api#documentation": "

The field sort options for rows in the table.

" + } + }, + "PaginationConfiguration": { + "target": "com.amazonaws.quicksight#PaginationConfiguration", + "traits": { + "smithy.api#documentation": "

The pagination configuration (page size, page number) for the table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration for a TableVisual.

" + } + }, + "com.amazonaws.quicksight#TableStyleTarget": { + "type": "structure", + "members": { + "CellType": { + "target": "com.amazonaws.quicksight#StyledCellType", + "traits": { + "smithy.api#documentation": "

The cell type of the table style target.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The table style target.

" + } + }, + "com.amazonaws.quicksight#TableStyleTargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TableStyleTarget" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.quicksight#TableTotalsPlacement": { + "type": "enum", + "members": { + "START": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "START" + } + }, + "END": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "END" + } + }, + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + } + } + }, + "com.amazonaws.quicksight#TableTotalsScrollStatus": { + "type": "enum", + "members": { + "PINNED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PINNED" + } + }, + "SCROLLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCROLLED" + } + } + } + }, + "com.amazonaws.quicksight#TableUnaggregatedFieldWells": { + "type": "structure", + "members": { + "Values": { + "target": "com.amazonaws.quicksight#UnaggregatedFieldList", + "traits": { + "smithy.api#documentation": "

The values field well for a pivot table. Values are unaggregated for an unaggregated table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The unaggregated field well for the table.

" + } + }, + "com.amazonaws.quicksight#TableVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#TableConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "ConditionalFormatting": { + "target": "com.amazonaws.quicksight#TableConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting for a PivotTableVisual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A table visual.

\n

For more information, see Using tables as visuals in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.quicksight#TagKey", + "traits": { + "smithy.api#documentation": "

Tag key.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#TagValue", + "traits": { + "smithy.api#documentation": "

Tag value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.

" + } + }, + "com.amazonaws.quicksight#TagColumnOperation": { + "type": "structure", + "members": { + "ColumnName": { + "target": "com.amazonaws.quicksight#ColumnName", + "traits": { + "smithy.api#documentation": "

The column that this operation acts on.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#ColumnTagList", + "traits": { + "smithy.api#documentation": "

The dataset column tag, currently only used for geospatial type tagging.

\n \n

This is not tags for the Amazon Web Services tagging feature.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A transform operation that tags a column with additional information.

" + } + }, + "com.amazonaws.quicksight#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.quicksight#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.

\n

Tags can help you organize and categorize your resources. You can also use them to\n\t\t\tscope user permissions, by granting a user permission to access or change only resources\n\t\t\twith certain tag values. You can use the TagResource operation with a\n\t\t\tresource that already has tags. If you specify a new tag key for the resource, this tag\n\t\t\tis appended to the list of tags associated with the resource. If you specify a tag key\n\t\t\tthat is already associated with the resource, the new tag value that you specify\n\t\t\treplaces the previous value for that tag.

\n

You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data\n\t\t\tset, data source, dashboard, template, topic, and user.

\n

Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for\n\t\t\tthe following:

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/resources/{ResourceArn}/tags", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to tag.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#TagResourceResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#TargetVisualList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#TargetVisualOptions": { + "type": "enum", + "members": { + "ALL_VISUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_VISUALS" + } + } + } + }, + "com.amazonaws.quicksight#Template": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#TemplateName", + "traits": { + "smithy.api#documentation": "

The display name of the template.

" + } + }, + "Version": { + "target": "com.amazonaws.quicksight#TemplateVersion", + "traits": { + "smithy.api#documentation": "

A structure describing the versions of the template.

" + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

Time when this was last updated.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

Time when this was created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A template object. A template is an entity in Amazon QuickSight that\n encapsulates the metadata required to create an analysis and that you can use to create\n a dashboard. A template adds a layer of abstraction by using placeholders to replace the\n dataset associated with an analysis. You can use templates to create dashboards by\n replacing dataset placeholders with datasets that follow the same schema that was used\n to create the source analysis and template.

\n

You can share templates across Amazon Web Services accounts by allowing users in other Amazon Web Services accounts to\n create a template or a dashboard from an existing template.

" + } + }, + "com.amazonaws.quicksight#TemplateAlias": { + "type": "structure", + "members": { + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The display name of the template alias.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template alias.

" + } + }, + "TemplateVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the template alias.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The template alias.

" + } + }, + "com.amazonaws.quicksight#TemplateAliasList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TemplateAlias" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#TemplateError": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#TemplateErrorType", + "traits": { + "smithy.api#documentation": "

Type of error.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Description of the error type.

" + } + }, + "ViolatedEntities": { + "target": "com.amazonaws.quicksight#EntityList", + "traits": { + "smithy.api#documentation": "

An error path that shows which entities caused the template error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

List of errors that occurred when the template version creation failed.

" + } + }, + "com.amazonaws.quicksight#TemplateErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TemplateError" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.quicksight#TemplateErrorType": { + "type": "enum", + "members": { + "SOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOURCE_NOT_FOUND" + } + }, + "DATA_SET_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SET_NOT_FOUND" + } + }, + "INTERNAL_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_FAILURE" + } + }, + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_DENIED" + } + } + } + }, + "com.amazonaws.quicksight#TemplateName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#TemplateSourceAnalysis": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#required": {} + } + }, + "DataSetReferences": { + "target": "com.amazonaws.quicksight#DataSetReferenceList", + "traits": { + "smithy.api#documentation": "

A structure containing information about the dataset references used as placeholders\n in the template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The source analysis of the template.

" + } + }, + "com.amazonaws.quicksight#TemplateSourceEntity": { + "type": "structure", + "members": { + "SourceAnalysis": { + "target": "com.amazonaws.quicksight#TemplateSourceAnalysis", + "traits": { + "smithy.api#documentation": "

The source analysis, if it is based on an analysis.

" + } + }, + "SourceTemplate": { + "target": "com.amazonaws.quicksight#TemplateSourceTemplate", + "traits": { + "smithy.api#documentation": "

The source template, if it is based on an template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The source entity of the template.

" + } + }, + "com.amazonaws.quicksight#TemplateSourceTemplate": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The source template of the template.

" + } + }, + "com.amazonaws.quicksight#TemplateSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

A summary of a template.

" + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the template. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#TemplateName", + "traits": { + "smithy.api#documentation": "

A display name for the template.

" + } + }, + "LatestVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

A structure containing a list of version numbers for the template summary.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that this template was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that this template was updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The template summary.

" + } + }, + "com.amazonaws.quicksight#TemplateSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TemplateSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#TemplateVersion": { + "type": "structure", + "members": { + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that this template version was created.

" + } + }, + "Errors": { + "target": "com.amazonaws.quicksight#TemplateErrorList", + "traits": { + "smithy.api#documentation": "

Errors associated with this template version.

" + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the template version.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The status that is associated with the template.

\n " + } + }, + "DataSetConfigurations": { + "target": "com.amazonaws.quicksight#DataSetConfigurationList", + "traits": { + "smithy.api#documentation": "

Schema of the dataset identified by the placeholder. Any dashboard created from this\n template should be bound to new datasets matching the same schema described through this\n API operation.

" + } + }, + "Description": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

The description of the template.

" + } + }, + "SourceEntityArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an analysis or template that was used to create this\n template.

" + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the theme associated with this version of the template.

" + } + }, + "Sheets": { + "target": "com.amazonaws.quicksight#SheetList", + "traits": { + "smithy.api#documentation": "

A list of the associated sheets with the unique identifier and name of each sheet.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A version of a template.

" + } + }, + "com.amazonaws.quicksight#TemplateVersionDefinition": { + "type": "structure", + "members": { + "DataSetConfigurations": { + "target": "com.amazonaws.quicksight#DataSetConfigurationList", + "traits": { + "smithy.api#documentation": "

An array of dataset configurations. These configurations define the required columns for each dataset used within a template.

", + "smithy.api#required": {} + } + }, + "Sheets": { + "target": "com.amazonaws.quicksight#SheetDefinitionList", + "traits": { + "smithy.api#documentation": "

An array of sheet definitions for a template.

" + } + }, + "CalculatedFields": { + "target": "com.amazonaws.quicksight#CalculatedFields", + "traits": { + "smithy.api#documentation": "

An array of calculated field definitions for the template.

" + } + }, + "ParameterDeclarations": { + "target": "com.amazonaws.quicksight#ParameterDeclarationList", + "traits": { + "smithy.api#documentation": "

An array of parameter declarations for a template.

\n

\n Parameters are named variables that can transfer a value for use by an action or an object.

\n

For more information, see Parameters in Amazon QuickSight in the\n Amazon QuickSight User Guide.\n

" + } + }, + "FilterGroups": { + "target": "com.amazonaws.quicksight#FilterGroupList", + "traits": { + "smithy.api#documentation": "

Filter definitions for a template.

\n

For more information, see Filtering Data in the Amazon QuickSight User Guide.\n

" + } + }, + "ColumnConfigurations": { + "target": "com.amazonaws.quicksight#ColumnConfigurationList", + "traits": { + "smithy.api#documentation": "

An array of template-level column\n configurations. Column configurations are used to set default formatting for a column that's used throughout a template.

" + } + }, + "AnalysisDefaults": { + "target": "com.amazonaws.quicksight#AnalysisDefaults" + }, + "Options": { + "target": "com.amazonaws.quicksight#AssetOptions", + "traits": { + "smithy.api#documentation": "

An array of option definitions for a template.

" + } + }, + "QueryExecutionOptions": { + "target": "com.amazonaws.quicksight#QueryExecutionOptions" + } + }, + "traits": { + "smithy.api#documentation": "

The detailed definition of a template.

" + } + }, + "com.amazonaws.quicksight#TemplateVersionSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template version.

" + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the template version.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that this template version was created.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The status of the template version.

" + } + }, + "Description": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

The description of the template version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The template version.

" + } + }, + "com.amazonaws.quicksight#TemplateVersionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TemplateVersionSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#TeradataParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

Host.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

Port.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

Database.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for Teradata.

" + } + }, + "com.amazonaws.quicksight#TextAreaControlDelimiter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#TextAreaControlDisplayOptions": { + "type": "structure", + "members": { + "TitleOptions": { + "target": "com.amazonaws.quicksight#LabelOptions", + "traits": { + "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" + } + }, + "PlaceholderOptions": { + "target": "com.amazonaws.quicksight#TextControlPlaceholderOptions", + "traits": { + "smithy.api#documentation": "

The configuration of the placeholder options in a text area control.

" + } + }, + "InfoIconLabelOptions": { + "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", + "traits": { + "smithy.api#documentation": "

The configuration of info icon label options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "com.amazonaws.quicksight#TextConditionalFormat": { + "type": "structure", + "members": { + "BackgroundColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting for the text background color.

" + } + }, + "TextColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting for the text color.

" + } + }, + "Icon": { + "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", + "traits": { + "smithy.api#documentation": "

The conditional formatting for the icon.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting for the text.

" + } + }, + "com.amazonaws.quicksight#TextControlPlaceholderOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility configuration of the placeholder options in a text control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of the placeholder options in a text control.

" + } + }, + "com.amazonaws.quicksight#TextFieldControlDisplayOptions": { + "type": "structure", + "members": { + "TitleOptions": { + "target": "com.amazonaws.quicksight#LabelOptions", + "traits": { + "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" + } + }, + "PlaceholderOptions": { + "target": "com.amazonaws.quicksight#TextControlPlaceholderOptions", + "traits": { + "smithy.api#documentation": "

The configuration of the placeholder options in a text field control.

" + } + }, + "InfoIconLabelOptions": { + "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", + "traits": { + "smithy.api#documentation": "

The configuration of info icon label options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "com.amazonaws.quicksight#TextQualifier": { + "type": "enum", + "members": { + "DOUBLE_QUOTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOUBLE_QUOTE" + } + }, + "SINGLE_QUOTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_QUOTE" + } + } + } + }, + "com.amazonaws.quicksight#TextWrap": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "WRAP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WRAP" + } + } + } + }, + "com.amazonaws.quicksight#Theme": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ThemeName", + "traits": { + "smithy.api#documentation": "

The name that the user gives to the theme.

" + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The identifier that the user gives to the theme.

" + } + }, + "Version": { + "target": "com.amazonaws.quicksight#ThemeVersion" + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the theme was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the theme was last updated.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#ThemeType", + "traits": { + "smithy.api#documentation": "

The type of theme, based on how it was created. Valid values include:\n QUICKSIGHT and CUSTOM.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary information about a theme.

" + } + }, + "com.amazonaws.quicksight#ThemeAlias": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme alias.

" + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The display name of the theme alias.

" + } + }, + "ThemeVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the theme alias.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An alias for a theme.

" + } + }, + "com.amazonaws.quicksight#ThemeAliasList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ThemeAlias" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#ThemeConfiguration": { + "type": "structure", + "members": { + "DataColorPalette": { + "target": "com.amazonaws.quicksight#DataColorPalette", + "traits": { + "smithy.api#documentation": "

Color properties that apply to chart data colors.

" + } + }, + "UIColorPalette": { + "target": "com.amazonaws.quicksight#UIColorPalette", + "traits": { + "smithy.api#documentation": "

Color properties that apply to the UI and to charts, excluding the colors that apply\n to data.

" + } + }, + "Sheet": { + "target": "com.amazonaws.quicksight#SheetStyle", + "traits": { + "smithy.api#documentation": "

Display options related to sheets.

" + } + }, + "Typography": { + "target": "com.amazonaws.quicksight#Typography" + } + }, + "traits": { + "smithy.api#documentation": "

The theme configuration. This configuration contains all of the display properties for\n a theme.

" + } + }, + "com.amazonaws.quicksight#ThemeError": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#ThemeErrorType", + "traits": { + "smithy.api#documentation": "

The type of error.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The error message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Theme error.

" + } + }, + "com.amazonaws.quicksight#ThemeErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ThemeError" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.quicksight#ThemeErrorType": { + "type": "enum", + "members": { + "INTERNAL_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_FAILURE" + } + } + } + }, + "com.amazonaws.quicksight#ThemeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#ThemeSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ThemeName", + "traits": { + "smithy.api#documentation": "

the display name for the theme.

" + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "LatestVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The latest version number for the theme.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that this theme was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The last date and time that this theme was updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The theme summary.

" + } + }, + "com.amazonaws.quicksight#ThemeSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ThemeSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#ThemeType": { + "type": "enum", + "members": { + "QUICKSIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + } + }, + "com.amazonaws.quicksight#ThemeVersion": { + "type": "structure", + "members": { + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the theme.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "Description": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

The description of the theme.

" + } + }, + "BaseThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All\n themes initially inherit from a default Amazon QuickSight theme.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that this theme version was created.

" + } + }, + "Configuration": { + "target": "com.amazonaws.quicksight#ThemeConfiguration", + "traits": { + "smithy.api#documentation": "

The theme configuration, which contains all the theme display properties.

" + } + }, + "Errors": { + "target": "com.amazonaws.quicksight#ThemeErrorList", + "traits": { + "smithy.api#documentation": "

Errors associated with the theme.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The status of the theme version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A version of a theme.

" + } + }, + "com.amazonaws.quicksight#ThemeVersionSummary": { + "type": "structure", + "members": { + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the theme version.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme version.

" + } + }, + "Description": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

The description of the theme version.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that this theme version was created.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The status of the theme version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The theme version.

" + } + }, + "com.amazonaws.quicksight#ThemeVersionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ThemeVersionSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#ThousandSeparatorOptions": { + "type": "structure", + "members": { + "Symbol": { + "target": "com.amazonaws.quicksight#NumericSeparatorSymbol", + "traits": { + "smithy.api#documentation": "

Determines the thousands separator symbol.

" + } + }, + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines the visibility of the thousands separator.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the thousands separator configuration.

" + } + }, + "com.amazonaws.quicksight#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Access is throttled.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.quicksight#TileLayoutStyle": { + "type": "structure", + "members": { + "Gutter": { + "target": "com.amazonaws.quicksight#GutterStyle", + "traits": { + "smithy.api#documentation": "

The gutter settings that apply between tiles.

" + } + }, + "Margin": { + "target": "com.amazonaws.quicksight#MarginStyle", + "traits": { + "smithy.api#documentation": "

The margin settings that apply around the outside edge of sheets.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options for the layout of tiles on a sheet.

" + } + }, + "com.amazonaws.quicksight#TileStyle": { + "type": "structure", + "members": { + "Border": { + "target": "com.amazonaws.quicksight#BorderStyle", + "traits": { + "smithy.api#documentation": "

The border around a tile.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Display options related to tiles on a sheet.

" + } + }, + "com.amazonaws.quicksight#TimeBasedForecastProperties": { + "type": "structure", + "members": { + "PeriodsForward": { + "target": "com.amazonaws.quicksight#PeriodsForward", + "traits": { + "smithy.api#documentation": "

The periods forward setup of a forecast computation.

" + } + }, + "PeriodsBackward": { + "target": "com.amazonaws.quicksight#PeriodsBackward", + "traits": { + "smithy.api#documentation": "

The periods backward setup of a forecast computation.

" + } + }, + "UpperBoundary": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The upper boundary setup of a forecast computation.

" + } + }, + "LowerBoundary": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The lower boundary setup of a forecast computation.

" + } + }, + "PredictionInterval": { + "target": "com.amazonaws.quicksight#PredictionInterval", + "traits": { + "smithy.api#documentation": "

The prediction interval setup of a forecast computation.

" + } + }, + "Seasonality": { + "target": "com.amazonaws.quicksight#Seasonality", + "traits": { + "smithy.api#documentation": "

The seasonality setup of a forecast computation. Choose one of the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The forecast properties setup of a forecast in the line chart.

" + } + }, + "com.amazonaws.quicksight#TimeEqualityFilter": { + "type": "structure", + "members": { + "FilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The value of a TimeEquality filter.

\n

This field is mutually exclusive to RollingDate and ParameterName.

" + } + }, + "ParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The parameter whose value should be used for the filter value.

\n

This field is mutually exclusive to Value and RollingDate.

" + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" + } + }, + "RollingDate": { + "target": "com.amazonaws.quicksight#RollingDateConfiguration", + "traits": { + "smithy.api#documentation": "

The rolling date input for the TimeEquality filter.

\n

This field is mutually exclusive to Value and ParameterName.

" + } + }, + "DefaultFilterControlConfiguration": { + "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", + "traits": { + "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A TimeEqualityFilter filters values that are equal to a given value.

" + } + }, + "com.amazonaws.quicksight#TimeGranularity": { + "type": "enum", + "members": { + "YEAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YEAR" + } + }, + "QUARTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUARTER" + } + }, + "MONTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTH" + } + }, + "WEEK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEEK" + } + }, + "DAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAY" + } + }, + "HOUR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOUR" + } + }, + "MINUTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MINUTE" + } + }, + "SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECOND" + } + }, + "MILLISECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MILLISECOND" + } + } + } + }, + "com.amazonaws.quicksight#TimeRangeDrillDownFilter": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "RangeMinimum": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The minimum value for the filter value range.

", + "smithy.api#required": {} + } + }, + "RangeMaximum": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The maximum value for the filter value range.

", + "smithy.api#required": {} + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The time range drill down filter.

" + } + }, + "com.amazonaws.quicksight#TimeRangeFilter": { + "type": "structure", + "members": { + "FilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "IncludeMinimum": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Determines whether the minimum value in the filter value range should be included in the filtered results.

" + } + }, + "IncludeMaximum": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Determines whether the maximum value in the filter value range should be included in the filtered results.

" + } + }, + "RangeMinimumValue": { + "target": "com.amazonaws.quicksight#TimeRangeFilterValue", + "traits": { + "smithy.api#documentation": "

The minimum value for the filter value range.

" + } + }, + "RangeMaximumValue": { + "target": "com.amazonaws.quicksight#TimeRangeFilterValue", + "traits": { + "smithy.api#documentation": "

The maximum value for the filter value range.

" + } + }, + "NullOption": { + "target": "com.amazonaws.quicksight#FilterNullOption", + "traits": { + "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", + "smithy.api#required": {} + } + }, + "ExcludePeriodConfiguration": { + "target": "com.amazonaws.quicksight#ExcludePeriodConfiguration", + "traits": { + "smithy.api#documentation": "

The exclude period of the time range filter.

" + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" + } + }, + "DefaultFilterControlConfiguration": { + "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", + "traits": { + "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A TimeRangeFilter filters values that are between two specified values.

" + } + }, + "com.amazonaws.quicksight#TimeRangeFilterValue": { + "type": "structure", + "members": { + "StaticValue": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The static input value.

" + } + }, + "RollingDate": { + "target": "com.amazonaws.quicksight#RollingDateConfiguration", + "traits": { + "smithy.api#documentation": "

The rolling date input value.

" + } + }, + "Parameter": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The parameter type input value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The value of a time range filter.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.quicksight#TooltipItem": { + "type": "structure", + "members": { + "FieldTooltipItem": { + "target": "com.amazonaws.quicksight#FieldTooltipItem", + "traits": { + "smithy.api#documentation": "

The tooltip item for the fields.

" + } + }, + "ColumnTooltipItem": { + "target": "com.amazonaws.quicksight#ColumnTooltipItem", + "traits": { + "smithy.api#documentation": "

The tooltip item for the columns that are not part of a field well.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tooltip.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#TooltipItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TooltipItem" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#TooltipOptions": { + "type": "structure", + "members": { + "TooltipVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines whether or not the tooltip is visible.

" + } + }, + "SelectedTooltipType": { + "target": "com.amazonaws.quicksight#SelectedTooltipType", + "traits": { + "smithy.api#documentation": "

The selected type for the tooltip. Choose one of the following options:

\n " + } + }, + "FieldBasedTooltip": { + "target": "com.amazonaws.quicksight#FieldBasedTooltip", + "traits": { + "smithy.api#documentation": "

The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options for the visual tooltip.

" + } + }, + "com.amazonaws.quicksight#TooltipTarget": { + "type": "enum", + "members": { + "BOTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTH" + } + }, + "BAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BAR" + } + }, + "LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINE" + } + } + } + }, + "com.amazonaws.quicksight#TooltipTitleType": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "PRIMARY_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIMARY_VALUE" + } + } + } + }, + "com.amazonaws.quicksight#TopBottomComputationType": { + "type": "enum", + "members": { + "TOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOP" + } + }, + "BOTTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTTOM" + } + } + } + }, + "com.amazonaws.quicksight#TopBottomFilter": { + "type": "structure", + "members": { + "FilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "Limit": { + "target": "com.amazonaws.quicksight#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The number of items to include in the top bottom filter results.

" + } + }, + "AggregationSortConfigurations": { + "target": "com.amazonaws.quicksight#AggregationSortConfigurationList", + "traits": { + "smithy.api#documentation": "

The aggregation and sort configuration of the top bottom filter.

", + "smithy.api#required": {} + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" + } + }, + "ParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The parameter whose value should be used for the filter value.

" + } + }, + "DefaultFilterControlConfiguration": { + "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", + "traits": { + "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A TopBottomFilter filters values that are at the top or the bottom.

" + } + }, + "com.amazonaws.quicksight#TopBottomMoversComputation": { + "type": "structure", + "members": { + "ComputationId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for a computation.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of a computation.

" + } + }, + "Time": { + "target": "com.amazonaws.quicksight#DimensionField", + "traits": { + "smithy.api#documentation": "

The time field that is used in a computation.

" + } + }, + "Category": { + "target": "com.amazonaws.quicksight#DimensionField", + "traits": { + "smithy.api#documentation": "

The category field that is used in a computation.

" + } + }, + "Value": { + "target": "com.amazonaws.quicksight#MeasureField", + "traits": { + "smithy.api#documentation": "

The value field that is used in a computation.

" + } + }, + "MoverSize": { + "target": "com.amazonaws.quicksight#TopBottomMoversComputationMoverSize", + "traits": { + "smithy.api#documentation": "

The mover size setup of the top and bottom movers computation.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.quicksight#TopBottomSortOrder", + "traits": { + "smithy.api#documentation": "

The sort order setup of the top and bottom movers computation.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#TopBottomComputationType", + "traits": { + "smithy.api#documentation": "

The computation type. Choose from the following options:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The top movers and bottom movers computation setup.

" + } + }, + "com.amazonaws.quicksight#TopBottomMoversComputationMoverSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#TopBottomRankedComputation": { + "type": "structure", + "members": { + "ComputationId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for a computation.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of a computation.

" + } + }, + "Category": { + "target": "com.amazonaws.quicksight#DimensionField", + "traits": { + "smithy.api#documentation": "

The category field that is used in a computation.

" + } + }, + "Value": { + "target": "com.amazonaws.quicksight#MeasureField", + "traits": { + "smithy.api#documentation": "

The value field that is used in a computation.

" + } + }, + "ResultSize": { + "target": "com.amazonaws.quicksight#TopBottomRankedComputationResultSize", + "traits": { + "smithy.api#documentation": "

The result size of a top and bottom ranked computation.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#TopBottomComputationType", + "traits": { + "smithy.api#documentation": "

The computation type. Choose one of the following options:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The top ranked and bottom ranked computation configuration.

" + } + }, + "com.amazonaws.quicksight#TopBottomRankedComputationResultSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#TopBottomSortOrder": { + "type": "enum", + "members": { + "PERCENT_DIFFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENT_DIFFERENCE" + } + }, + "ABSOLUTE_DIFFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABSOLUTE_DIFFERENCE" + } + } + } + }, + "com.amazonaws.quicksight#TopicCalculatedField": { + "type": "structure", + "members": { + "CalculatedFieldName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The calculated field name.

", + "smithy.api#required": {} + } + }, + "CalculatedFieldDescription": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The calculated field description.

" + } + }, + "Expression": { + "target": "com.amazonaws.quicksight#Expression", + "traits": { + "smithy.api#documentation": "

The calculated field expression.

", + "smithy.api#required": {} + } + }, + "CalculatedFieldSynonyms": { + "target": "com.amazonaws.quicksight#Synonyms", + "traits": { + "smithy.api#documentation": "

The other names or aliases for the calculated field.

" + } + }, + "IsIncludedInTopic": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A boolean value that indicates if a calculated field is included in the topic.

" + } + }, + "DisableIndexing": { + "target": "com.amazonaws.quicksight#NullableBoolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates if a calculated field is visible in the autocomplete.

" + } + }, + "ColumnDataRole": { + "target": "com.amazonaws.quicksight#ColumnDataRole", + "traits": { + "smithy.api#documentation": "

The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.

" + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TopicTimeGranularity", + "traits": { + "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" + } + }, + "DefaultFormatting": { + "target": "com.amazonaws.quicksight#DefaultFormatting", + "traits": { + "smithy.api#documentation": "

The default formatting definition.

" + } + }, + "Aggregation": { + "target": "com.amazonaws.quicksight#DefaultAggregation", + "traits": { + "smithy.api#documentation": "

The default aggregation. Valid values for this structure are SUM,\n MAX, MIN, COUNT,\n DISTINCT_COUNT,\n and AVERAGE.

" + } + }, + "ComparativeOrder": { + "target": "com.amazonaws.quicksight#ComparativeOrder", + "traits": { + "smithy.api#documentation": "

The order in which data is displayed for the calculated field when\n it's used in a comparative context.

" + } + }, + "SemanticType": { + "target": "com.amazonaws.quicksight#SemanticType", + "traits": { + "smithy.api#documentation": "

The semantic type.

" + } + }, + "AllowedAggregations": { + "target": "com.amazonaws.quicksight#AuthorSpecifiedAggregations", + "traits": { + "smithy.api#documentation": "

The list of aggregation types that are allowed for the calculated field. Valid values\n for this structure are COUNT, DISTINCT_COUNT, MIN,\n MAX, MEDIAN, SUM, AVERAGE,\n STDEV, STDEVP, VAR,\n VARP, and PERCENTILE.

" + } + }, + "NotAllowedAggregations": { + "target": "com.amazonaws.quicksight#AuthorSpecifiedAggregations", + "traits": { + "smithy.api#documentation": "

The list of aggregation types that are not allowed for the calculated field. Valid\n values for this structure are COUNT, DISTINCT_COUNT,\n MIN, MAX, MEDIAN, SUM,\n AVERAGE, STDEV, STDEVP, VAR,\n VARP, and PERCENTILE.

" + } + }, + "NeverAggregateInFilter": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that indicates whether to never aggregate calculated field in filters.

" + } + }, + "CellValueSynonyms": { + "target": "com.amazonaws.quicksight#CellValueSynonyms", + "traits": { + "smithy.api#documentation": "

The other\n names or aliases for the calculated field cell value.

" + } + }, + "NonAdditive": { + "target": "com.amazonaws.quicksight#NullableBoolean", + "traits": { + "smithy.api#documentation": "

The non additive for the table style target.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a calculated field.

" + } + }, + "com.amazonaws.quicksight#TopicCalculatedFields": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicCalculatedField" + } + }, + "com.amazonaws.quicksight#TopicCategoryFilter": { + "type": "structure", + "members": { + "CategoryFilterFunction": { + "target": "com.amazonaws.quicksight#CategoryFilterFunction", + "traits": { + "smithy.api#documentation": "

The category filter function. Valid values for this structure are EXACT and CONTAINS.

" + } + }, + "CategoryFilterType": { + "target": "com.amazonaws.quicksight#CategoryFilterType", + "traits": { + "smithy.api#documentation": "

The category filter type. This element is used to specify whether a filter is a simple category filter or an inverse category filter.

" + } + }, + "Constant": { + "target": "com.amazonaws.quicksight#TopicCategoryFilterConstant", + "traits": { + "smithy.api#documentation": "

The constant used in a category filter.

" + } + }, + "Inverse": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that indicates if the filter is inverse.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a category filter.

" + } + }, + "com.amazonaws.quicksight#TopicCategoryFilterConstant": { + "type": "structure", + "members": { + "ConstantType": { + "target": "com.amazonaws.quicksight#ConstantType", + "traits": { + "smithy.api#documentation": "

The type of category filter constant. This element is used to specify whether a constant is a singular or collective. Valid values are SINGULAR and COLLECTIVE.

" + } + }, + "SingularConstant": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

A singular constant used in a category filter. This element is used to specify a single value for the constant.

" + } + }, + "CollectiveConstant": { + "target": "com.amazonaws.quicksight#CollectiveConstant", + "traits": { + "smithy.api#documentation": "

A collective constant used in a category filter. This element is used to specify a list of values for the constant.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A constant used in a category filter.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#TopicColumn": { + "type": "structure", + "members": { + "ColumnName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The name of the column.

", + "smithy.api#required": {} + } + }, + "ColumnFriendlyName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

A user-friendly name for the column.

" + } + }, + "ColumnDescription": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

A description of the column and its contents.

" + } + }, + "ColumnSynonyms": { + "target": "com.amazonaws.quicksight#Synonyms", + "traits": { + "smithy.api#documentation": "

The other names or aliases for the column.

" + } + }, + "ColumnDataRole": { + "target": "com.amazonaws.quicksight#ColumnDataRole", + "traits": { + "smithy.api#documentation": "

The role of the column in the data. Valid values are DIMENSION and MEASURE.

" + } + }, + "Aggregation": { + "target": "com.amazonaws.quicksight#DefaultAggregation", + "traits": { + "smithy.api#documentation": "

The type of aggregation that is performed on the column data when\n it's queried.

" + } + }, + "IsIncludedInTopic": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that indicates whether the column is included in the query results.

" + } + }, + "DisableIndexing": { + "target": "com.amazonaws.quicksight#NullableBoolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether the column shows in the autocomplete functionality.

" + } + }, + "ComparativeOrder": { + "target": "com.amazonaws.quicksight#ComparativeOrder", + "traits": { + "smithy.api#documentation": "

The order in which data is displayed for the column when\n it's used in a comparative context.

" + } + }, + "SemanticType": { + "target": "com.amazonaws.quicksight#SemanticType", + "traits": { + "smithy.api#documentation": "

The semantic type of data contained in the column.

" + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TopicTimeGranularity", + "traits": { + "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" + } + }, + "AllowedAggregations": { + "target": "com.amazonaws.quicksight#AuthorSpecifiedAggregations", + "traits": { + "smithy.api#documentation": "

The list of aggregation types that are allowed for the column. Valid values for this\n structure are COUNT, DISTINCT_COUNT, MIN,\n MAX, MEDIAN, SUM, AVERAGE,\n STDEV, STDEVP, VAR,\n VARP,\n and PERCENTILE.

" + } + }, + "NotAllowedAggregations": { + "target": "com.amazonaws.quicksight#AuthorSpecifiedAggregations", + "traits": { + "smithy.api#documentation": "

The list of aggregation types that are not allowed for the column. Valid values for this\n structure are COUNT, DISTINCT_COUNT, MIN,\n MAX, MEDIAN, SUM, AVERAGE,\n STDEV, STDEVP, VAR,\n VARP,\n and PERCENTILE.

" + } + }, + "DefaultFormatting": { + "target": "com.amazonaws.quicksight#DefaultFormatting", + "traits": { + "smithy.api#documentation": "

The default formatting used for values in the column.

" + } + }, + "NeverAggregateInFilter": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean\n value that indicates whether to aggregate the column data when\n it's used in a filter context.

" + } + }, + "CellValueSynonyms": { + "target": "com.amazonaws.quicksight#CellValueSynonyms", + "traits": { + "smithy.api#documentation": "

The other names or aliases for the column cell value.

" + } + }, + "NonAdditive": { + "target": "com.amazonaws.quicksight#NullableBoolean", + "traits": { + "smithy.api#documentation": "

The non additive value for the column.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a column in a dataset.

" + } + }, + "com.amazonaws.quicksight#TopicColumns": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicColumn" + } + }, + "com.amazonaws.quicksight#TopicConstantValue": { + "type": "structure", + "members": { + "ConstantType": { + "target": "com.amazonaws.quicksight#ConstantType", + "traits": { + "smithy.api#documentation": "

The constant type of a TopicConstantValue.

" + } + }, + "Value": { + "target": "com.amazonaws.quicksight#ConstantValueString", + "traits": { + "smithy.api#documentation": "

The value of the TopicConstantValue.

" + } + }, + "Minimum": { + "target": "com.amazonaws.quicksight#ConstantValueString", + "traits": { + "smithy.api#documentation": "

The minimum for the TopicConstantValue.

" + } + }, + "Maximum": { + "target": "com.amazonaws.quicksight#ConstantValueString", + "traits": { + "smithy.api#documentation": "

The maximum for the TopicConstantValue.

" + } + }, + "ValueList": { + "target": "com.amazonaws.quicksight#CollectiveConstantEntryList", + "traits": { + "smithy.api#documentation": "

The value list of the TopicConstantValue.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a TopicConstantValue.

" + } + }, + "com.amazonaws.quicksight#TopicDateRangeFilter": { + "type": "structure", + "members": { + "Inclusive": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that indicates whether the date range filter should include the boundary values. If\n set to true, the filter includes the start and end dates. If set to false, the filter\n excludes them.

" + } + }, + "Constant": { + "target": "com.amazonaws.quicksight#TopicRangeFilterConstant", + "traits": { + "smithy.api#documentation": "

The constant used in a date range filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter used to restrict data based on a range of dates or times.

" + } + }, + "com.amazonaws.quicksight#TopicDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the topic.

" + } + }, + "Description": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The description of the topic.

" + } + }, + "UserExperienceVersion": { + "target": "com.amazonaws.quicksight#TopicUserExperienceVersion", + "traits": { + "smithy.api#documentation": "

The user experience version of a topic.

" + } + }, + "DataSets": { + "target": "com.amazonaws.quicksight#Datasets", + "traits": { + "smithy.api#documentation": "

The data sets that the topic is associated with.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that describes the details of a topic, such as its name, description, and associated data sets.

" + } + }, + "com.amazonaws.quicksight#TopicFilter": { + "type": "structure", + "members": { + "FilterDescription": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

A description of the filter used to select items for a topic.

" + } + }, + "FilterClass": { + "target": "com.amazonaws.quicksight#FilterClass", + "traits": { + "smithy.api#documentation": "

The class of the filter. Valid values for this structure are\n ENFORCED_VALUE_FILTER,\n CONDITIONAL_VALUE_FILTER,\n and NAMED_VALUE_FILTER.

" + } + }, + "FilterName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The name of the filter.

", + "smithy.api#required": {} + } + }, + "FilterSynonyms": { + "target": "com.amazonaws.quicksight#Synonyms", + "traits": { + "smithy.api#documentation": "

The other names or aliases for the filter.

" + } + }, + "OperandFieldName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The name of the field that the filter operates on.

", + "smithy.api#required": {} + } + }, + "FilterType": { + "target": "com.amazonaws.quicksight#NamedFilterType", + "traits": { + "smithy.api#documentation": "

The type of the filter. Valid values for this structure are\n CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER,\n NUMERIC_RANGE_FILTER,\n DATE_RANGE_FILTER,\n and RELATIVE_DATE_FILTER.

" + } + }, + "CategoryFilter": { + "target": "com.amazonaws.quicksight#TopicCategoryFilter", + "traits": { + "smithy.api#documentation": "

The category filter that is associated with this filter.

" + } + }, + "NumericEqualityFilter": { + "target": "com.amazonaws.quicksight#TopicNumericEqualityFilter", + "traits": { + "smithy.api#documentation": "

The numeric equality filter.

" + } + }, + "NumericRangeFilter": { + "target": "com.amazonaws.quicksight#TopicNumericRangeFilter", + "traits": { + "smithy.api#documentation": "

The numeric range filter.

" + } + }, + "DateRangeFilter": { + "target": "com.amazonaws.quicksight#TopicDateRangeFilter", + "traits": { + "smithy.api#documentation": "

The date range filter.

" + } + }, + "RelativeDateFilter": { + "target": "com.amazonaws.quicksight#TopicRelativeDateFilter", + "traits": { + "smithy.api#documentation": "

The relative date filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a filter used to select items for a topic.

" + } + }, + "com.amazonaws.quicksight#TopicFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicFilter" + } + }, + "com.amazonaws.quicksight#TopicIR": { + "type": "structure", + "members": { + "Metrics": { + "target": "com.amazonaws.quicksight#TopicIRMetricList", + "traits": { + "smithy.api#documentation": "

The metrics for the TopicIR.

" + } + }, + "GroupByList": { + "target": "com.amazonaws.quicksight#TopicIRGroupByList", + "traits": { + "smithy.api#documentation": "

The GroupBy list for the TopicIR.

" + } + }, + "Filters": { + "target": "com.amazonaws.quicksight#TopicIRFilterList", + "traits": { + "smithy.api#documentation": "

The filters for the TopicIR.

" + } + }, + "Sort": { + "target": "com.amazonaws.quicksight#TopicSortClause", + "traits": { + "smithy.api#documentation": "

The sort for the TopicIR.

" + } + }, + "ContributionAnalysis": { + "target": "com.amazonaws.quicksight#TopicIRContributionAnalysis", + "traits": { + "smithy.api#documentation": "

The contribution analysis for the TopicIR.

" + } + }, + "Visual": { + "target": "com.amazonaws.quicksight#VisualOptions", + "traits": { + "smithy.api#documentation": "

The visual for the TopicIR.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a TopicIR.

" + } + }, + "com.amazonaws.quicksight#TopicIRComparisonMethod": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#ComparisonMethodType", + "traits": { + "smithy.api#documentation": "

The type for the TopicIRComparisonMethod.

" + } + }, + "Period": { + "target": "com.amazonaws.quicksight#TopicTimeGranularity", + "traits": { + "smithy.api#documentation": "

The period for the TopicIRComparisonMethod.

" + } + }, + "WindowSize": { + "target": "com.amazonaws.quicksight#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The window size for the TopicIRComparisonMethod.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition of a TopicIRComparisonMethod.

" + } + }, + "com.amazonaws.quicksight#TopicIRContributionAnalysis": { + "type": "structure", + "members": { + "Factors": { + "target": "com.amazonaws.quicksight#ContributionAnalysisFactorsList", + "traits": { + "smithy.api#documentation": "

The factors for a TopicIRContributionAnalysis.

" + } + }, + "TimeRanges": { + "target": "com.amazonaws.quicksight#ContributionAnalysisTimeRanges", + "traits": { + "smithy.api#documentation": "

The time ranges for the TopicIRContributionAnalysis.

" + } + }, + "Direction": { + "target": "com.amazonaws.quicksight#ContributionAnalysisDirection", + "traits": { + "smithy.api#documentation": "

The direction for the TopicIRContributionAnalysis.

" + } + }, + "SortType": { + "target": "com.amazonaws.quicksight#ContributionAnalysisSortType", + "traits": { + "smithy.api#documentation": "

The sort type for the TopicIRContributionAnalysis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a TopicIRContributionAnalysis.

" + } + }, + "com.amazonaws.quicksight#TopicIRFilterEntry": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicIRFilterOption" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.quicksight#TopicIRFilterFunction": { + "type": "enum", + "members": { + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS" + } + }, + "EXACT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXACT" + } + }, + "STARTS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTS_WITH" + } + }, + "ENDS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENDS_WITH" + } + }, + "CONTAINS_STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS_STRING" + } + }, + "PREVIOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREVIOUS" + } + }, + "THIS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THIS" + } + }, + "LAST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST" + } + }, + "NEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEXT" + } + }, + "NOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOW" + } + } + } + }, + "com.amazonaws.quicksight#TopicIRFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicIRFilterEntry" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.quicksight#TopicIRFilterOption": { + "type": "structure", + "members": { + "FilterType": { + "target": "com.amazonaws.quicksight#TopicIRFilterType", + "traits": { + "smithy.api#documentation": "

The filter type for the TopicIRFilterOption.

" + } + }, + "FilterClass": { + "target": "com.amazonaws.quicksight#FilterClass", + "traits": { + "smithy.api#documentation": "

The filter class for the TopicIRFilterOption.

" + } + }, + "OperandField": { + "target": "com.amazonaws.quicksight#Identifier", + "traits": { + "smithy.api#documentation": "

The operand field for the TopicIRFilterOption.

" + } + }, + "Function": { + "target": "com.amazonaws.quicksight#TopicIRFilterFunction", + "traits": { + "smithy.api#documentation": "

The function for the TopicIRFilterOption.

" + } + }, + "Constant": { + "target": "com.amazonaws.quicksight#TopicConstantValue", + "traits": { + "smithy.api#documentation": "

The constant for the TopicIRFilterOption.

" + } + }, + "Inverse": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The inverse for the TopicIRFilterOption.

" + } + }, + "NullFilter": { + "target": "com.amazonaws.quicksight#NullFilterOption", + "traits": { + "smithy.api#documentation": "

The null filter for the TopicIRFilterOption.

" + } + }, + "Aggregation": { + "target": "com.amazonaws.quicksight#AggType", + "traits": { + "smithy.api#documentation": "

The aggregation for the TopicIRFilterOption.

" + } + }, + "AggregationFunctionParameters": { + "target": "com.amazonaws.quicksight#AggFunctionParamMap", + "traits": { + "smithy.api#documentation": "

The aggregation function parameters for the TopicIRFilterOption.

" + } + }, + "AggregationPartitionBy": { + "target": "com.amazonaws.quicksight#AggregationPartitionByList", + "traits": { + "smithy.api#documentation": "

The AggregationPartitionBy for the TopicIRFilterOption.

" + } + }, + "Range": { + "target": "com.amazonaws.quicksight#TopicConstantValue", + "traits": { + "smithy.api#documentation": "

The range for the TopicIRFilterOption.

" + } + }, + "Inclusive": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The inclusive for the TopicIRFilterOption.

" + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The time granularity for the TopicIRFilterOption.

" + } + }, + "LastNextOffset": { + "target": "com.amazonaws.quicksight#TopicConstantValue", + "traits": { + "smithy.api#documentation": "

The last next offset for the TopicIRFilterOption.

" + } + }, + "AggMetrics": { + "target": "com.amazonaws.quicksight#FilterAggMetricsList", + "traits": { + "smithy.api#documentation": "

The agg metrics for the TopicIRFilterOption.

" + } + }, + "TopBottomLimit": { + "target": "com.amazonaws.quicksight#TopicConstantValue", + "traits": { + "smithy.api#documentation": "

The TopBottomLimit for the TopicIRFilterOption.

" + } + }, + "SortDirection": { + "target": "com.amazonaws.quicksight#TopicSortDirection", + "traits": { + "smithy.api#documentation": "

The sort direction for the TopicIRFilterOption.

" + } + }, + "Anchor": { + "target": "com.amazonaws.quicksight#Anchor", + "traits": { + "smithy.api#documentation": "

The anchor for the TopicIRFilterOption.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a TopicIRFilterOption.

" + } + }, + "com.amazonaws.quicksight#TopicIRFilterType": { + "type": "enum", + "members": { + "CATEGORY_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CATEGORY_FILTER" + } + }, + "NUMERIC_EQUALITY_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMERIC_EQUALITY_FILTER" + } + }, + "NUMERIC_RANGE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMERIC_RANGE_FILTER" + } + }, + "DATE_RANGE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE_RANGE_FILTER" + } + }, + "RELATIVE_DATE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RELATIVE_DATE_FILTER" + } + }, + "TOP_BOTTOM_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOP_BOTTOM_FILTER" + } + }, + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + }, + "RANK_LIMIT_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RANK_LIMIT_FILTER" + } + }, + "ACCEPT_ALL_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCEPT_ALL_FILTER" + } + } + } + }, + "com.amazonaws.quicksight#TopicIRGroupBy": { + "type": "structure", + "members": { + "FieldName": { + "target": "com.amazonaws.quicksight#Identifier", + "traits": { + "smithy.api#documentation": "

The field name for the TopicIRGroupBy.

" + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TopicTimeGranularity", + "traits": { + "smithy.api#documentation": "

The time granularity for the TopicIRGroupBy.

" + } + }, + "Sort": { + "target": "com.amazonaws.quicksight#TopicSortClause", + "traits": { + "smithy.api#documentation": "

The sort for the TopicIRGroupBy.

" + } + }, + "DisplayFormat": { + "target": "com.amazonaws.quicksight#DisplayFormat", + "traits": { + "smithy.api#documentation": "

The display format for the TopicIRGroupBy.

" + } + }, + "DisplayFormatOptions": { + "target": "com.amazonaws.quicksight#DisplayFormatOptions" + }, + "NamedEntity": { + "target": "com.amazonaws.quicksight#NamedEntityRef", + "traits": { + "smithy.api#documentation": "

The named entity for the TopicIRGroupBy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a TopicIRGroupBy.

" + } + }, + "com.amazonaws.quicksight#TopicIRGroupByList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicIRGroupBy" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.quicksight#TopicIRMetric": { + "type": "structure", + "members": { + "MetricId": { + "target": "com.amazonaws.quicksight#Identifier", + "traits": { + "smithy.api#documentation": "

The metric ID for the TopicIRMetric.

" + } + }, + "Function": { + "target": "com.amazonaws.quicksight#AggFunction", + "traits": { + "smithy.api#documentation": "

The function for the TopicIRMetric.

" + } + }, + "Operands": { + "target": "com.amazonaws.quicksight#OperandList", + "traits": { + "smithy.api#documentation": "

The operands for the TopicIRMetric.

" + } + }, + "ComparisonMethod": { + "target": "com.amazonaws.quicksight#TopicIRComparisonMethod", + "traits": { + "smithy.api#documentation": "

The comparison method for the TopicIRMetric.

" + } + }, + "Expression": { + "target": "com.amazonaws.quicksight#Expression", + "traits": { + "smithy.api#documentation": "

The expression for the TopicIRMetric.

" + } + }, + "CalculatedFieldReferences": { + "target": "com.amazonaws.quicksight#CalculatedFieldReferenceList", + "traits": { + "smithy.api#documentation": "

The calculated field references for the TopicIRMetric.

" + } + }, + "DisplayFormat": { + "target": "com.amazonaws.quicksight#DisplayFormat", + "traits": { + "smithy.api#documentation": "

The display format for the TopicIRMetric.

" + } + }, + "DisplayFormatOptions": { + "target": "com.amazonaws.quicksight#DisplayFormatOptions" + }, + "NamedEntity": { + "target": "com.amazonaws.quicksight#NamedEntityRef", + "traits": { + "smithy.api#documentation": "

The named entity for the TopicIRMetric.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a TopicIRMetric.

" + } + }, + "com.amazonaws.quicksight#TopicIRMetricList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicIRMetric" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.quicksight#TopicId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9-_.\\\\+]*$" + } + }, + "com.amazonaws.quicksight#TopicNamedEntities": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicNamedEntity" + } + }, + "com.amazonaws.quicksight#TopicNamedEntity": { + "type": "structure", + "members": { + "EntityName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The name of the named entity.

", + "smithy.api#required": {} + } + }, + "EntityDescription": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The description of the named entity.

" + } + }, + "EntitySynonyms": { + "target": "com.amazonaws.quicksight#Synonyms", + "traits": { + "smithy.api#documentation": "

The other\n names or aliases for the named entity.

" + } + }, + "SemanticEntityType": { + "target": "com.amazonaws.quicksight#SemanticEntityType", + "traits": { + "smithy.api#documentation": "

The type of named entity that a topic represents.

" + } + }, + "Definition": { + "target": "com.amazonaws.quicksight#NamedEntityDefinitions", + "traits": { + "smithy.api#documentation": "

The definition of a named entity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a named entity.

" + } + }, + "com.amazonaws.quicksight#TopicNumericEqualityFilter": { + "type": "structure", + "members": { + "Constant": { + "target": "com.amazonaws.quicksight#TopicSingularFilterConstant", + "traits": { + "smithy.api#documentation": "

The constant used in a numeric equality filter.

" + } + }, + "Aggregation": { + "target": "com.amazonaws.quicksight#NamedFilterAggType", + "traits": { + "smithy.api#documentation": "

An aggregation function that specifies how to calculate the value of a numeric field for\n a topic. Valid values for this structure are NO_AGGREGATION, SUM,\n AVERAGE, COUNT, DISTINCT_COUNT, MAX,\n MEDIAN, MIN, STDEV, STDEVP,\n VAR,\n and VARP.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value matches the specified value.

" + } + }, + "com.amazonaws.quicksight#TopicNumericRangeFilter": { + "type": "structure", + "members": { + "Inclusive": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that indicates whether the endpoints of the numeric range are included in the filter.\n If set to true, topics whose numeric field value is equal to the endpoint values will be\n included in the filter. If set to false, topics whose numeric field value is equal to the\n endpoint values will be excluded from the filter.

" + } + }, + "Constant": { + "target": "com.amazonaws.quicksight#TopicRangeFilterConstant", + "traits": { + "smithy.api#documentation": "

The constant used in a\n numeric range filter.

" + } + }, + "Aggregation": { + "target": "com.amazonaws.quicksight#NamedFilterAggType", + "traits": { + "smithy.api#documentation": "

An aggregation function that specifies how to calculate the value of a numeric field for\n a topic, Valid values for this structure are NO_AGGREGATION, SUM,\n AVERAGE, COUNT, DISTINCT_COUNT, MAX,\n MEDIAN, MIN, STDEV, STDEVP,\n VAR,\n and VARP.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value falls within the specified range.

" + } + }, + "com.amazonaws.quicksight#TopicNumericSeparatorSymbol": { + "type": "enum", + "members": { + "COMMA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMMA" + } + }, + "DOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOT" + } + } + } + }, + "com.amazonaws.quicksight#TopicRangeFilterConstant": { + "type": "structure", + "members": { + "ConstantType": { + "target": "com.amazonaws.quicksight#ConstantType", + "traits": { + "smithy.api#documentation": "

The data type of the constant value that is used in a range filter. Valid values for this structure are RANGE.

" + } + }, + "RangeConstant": { + "target": "com.amazonaws.quicksight#RangeConstant", + "traits": { + "smithy.api#documentation": "

The value of the constant that is used to specify the endpoints of a range filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A constant value that is used in a range filter to specify the endpoints of the range.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#TopicRefreshDetails": { + "type": "structure", + "members": { + "RefreshArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic refresh.

" + } + }, + "RefreshId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the refresh, which occurs as a result of topic creation or topic update.

" + } + }, + "RefreshStatus": { + "target": "com.amazonaws.quicksight#TopicRefreshStatus", + "traits": { + "smithy.api#documentation": "

The status of the refresh job that indicates whether the job is still running, completed successfully, or failed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details about the refresh of a topic.

" + } + }, + "com.amazonaws.quicksight#TopicRefreshSchedule": { + "type": "structure", + "members": { + "IsEnabled": { + "target": "com.amazonaws.quicksight#NullableBoolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that controls whether to schedule is enabled.

", + "smithy.api#required": {} + } + }, + "BasedOnSpiceSchedule": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that controls whether to schedule runs at the same schedule that is specified in\n SPICE dataset.

", + "smithy.api#required": {} + } + }, + "StartingAt": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The starting date and time for the refresh schedule.

" + } + }, + "Timezone": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The timezone that you want the refresh schedule to use.

" + } + }, + "RepeatAt": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The time of day when the refresh should run, for\n example, Monday-Sunday.

" + } + }, + "TopicScheduleType": { + "target": "com.amazonaws.quicksight#TopicScheduleType", + "traits": { + "smithy.api#documentation": "

The type of refresh schedule. Valid values for this structure are HOURLY,\n DAILY,\n WEEKLY,\n and MONTHLY.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a topic refresh schedule.

" + } + }, + "com.amazonaws.quicksight#TopicRefreshScheduleSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicRefreshScheduleSummary" + } + }, + "com.amazonaws.quicksight#TopicRefreshScheduleSummary": { + "type": "structure", + "members": { + "DatasetId": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

" + } + }, + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "DatasetName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The name of the dataset.

" + } + }, + "RefreshSchedule": { + "target": "com.amazonaws.quicksight#TopicRefreshSchedule", + "traits": { + "smithy.api#documentation": "

The definition of a refresh schedule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the refresh schedule details for a dataset.

" + } + }, + "com.amazonaws.quicksight#TopicRefreshStatus": { + "type": "enum", + "members": { + "INITIALIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIALIZED" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + } + } + }, + "com.amazonaws.quicksight#TopicRelativeDateFilter": { + "type": "structure", + "members": { + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TopicTimeGranularity", + "traits": { + "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" + } + }, + "RelativeDateFilterFunction": { + "target": "com.amazonaws.quicksight#TopicRelativeDateFilterFunction", + "traits": { + "smithy.api#documentation": "

The function to be used in a relative date filter to determine the range of dates to include in the results. Valid values for this structure are BEFORE, AFTER, and BETWEEN.

" + } + }, + "Constant": { + "target": "com.amazonaws.quicksight#TopicSingularFilterConstant", + "traits": { + "smithy.api#documentation": "

The constant used in a\n relative date filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a relative date filter.

" + } + }, + "com.amazonaws.quicksight#TopicRelativeDateFilterFunction": { + "type": "enum", + "members": { + "PREVIOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREVIOUS" + } + }, + "THIS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THIS" + } + }, + "LAST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST" + } + }, + "NEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEXT" + } + }, + "NOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOW" + } + } + } + }, + "com.amazonaws.quicksight#TopicReviewedAnswer": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the reviewed answer.

" + } + }, + "AnswerId": { + "target": "com.amazonaws.quicksight#AnswerId", + "traits": { + "smithy.api#documentation": "

The answer ID of the reviewed answer.

", + "smithy.api#required": {} + } + }, + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Dataset ARN for the TopicReviewedAnswer.

", + "smithy.api#required": {} + } + }, + "Question": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The question for the TopicReviewedAnswer.

", + "smithy.api#required": {} + } + }, + "Mir": { + "target": "com.amazonaws.quicksight#TopicIR", + "traits": { + "smithy.api#documentation": "

The mir for the TopicReviewedAnswer.

" + } + }, + "PrimaryVisual": { + "target": "com.amazonaws.quicksight#TopicVisual", + "traits": { + "smithy.api#documentation": "

The primary visual for the TopicReviewedAnswer.

" + } + }, + "Template": { + "target": "com.amazonaws.quicksight#TopicTemplate", + "traits": { + "smithy.api#documentation": "

The template for the TopicReviewedAnswer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The deinition for a TopicReviewedAnswer.

" + } + }, + "com.amazonaws.quicksight#TopicReviewedAnswers": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicReviewedAnswer" + } + }, + "com.amazonaws.quicksight#TopicScheduleType": { + "type": "enum", + "members": { + "HOURLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOURLY" + } + }, + "DAILY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAILY" + } + }, + "WEEKLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEEKLY" + } + }, + "MONTHLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTHLY" + } + } + } + }, + "com.amazonaws.quicksight#TopicSingularFilterConstant": { + "type": "structure", + "members": { + "ConstantType": { + "target": "com.amazonaws.quicksight#ConstantType", + "traits": { + "smithy.api#documentation": "

The type of the singular filter constant. Valid values for this structure are SINGULAR.

" + } + }, + "SingularConstant": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The value of the singular filter constant.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a singular filter constant, used in filters to specify a single value to match against.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#TopicSortClause": { + "type": "structure", + "members": { + "Operand": { + "target": "com.amazonaws.quicksight#Identifier", + "traits": { + "smithy.api#documentation": "

The operand for a TopicSortClause.

" + } + }, + "SortDirection": { + "target": "com.amazonaws.quicksight#TopicSortDirection", + "traits": { + "smithy.api#documentation": "

The sort direction for the TopicSortClause.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a TopicSortClause.

" + } + }, + "com.amazonaws.quicksight#TopicSortDirection": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASCENDING" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESCENDING" + } + } + } + }, + "com.amazonaws.quicksight#TopicSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicSummary" + } + }, + "com.amazonaws.quicksight#TopicSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID for the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the topic.

" + } + }, + "UserExperienceVersion": { + "target": "com.amazonaws.quicksight#TopicUserExperienceVersion", + "traits": { + "smithy.api#documentation": "

The user experience version of the topic.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A topic summary.

" + } + }, + "com.amazonaws.quicksight#TopicTemplate": { + "type": "structure", + "members": { + "TemplateType": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The template type for the TopicTemplate.

" + } + }, + "Slots": { + "target": "com.amazonaws.quicksight#Slots", + "traits": { + "smithy.api#documentation": "

The slots for the TopicTemplate.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a TopicTemplate.

" + } + }, + "com.amazonaws.quicksight#TopicTimeGranularity": { + "type": "enum", + "members": { + "SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECOND" + } + }, + "MINUTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MINUTE" + } + }, + "HOUR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOUR" + } + }, + "DAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAY" + } + }, + "WEEK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEEK" + } + }, + "MONTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTH" + } + }, + "QUARTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUARTER" + } + }, + "YEAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YEAR" + } + } + } + }, + "com.amazonaws.quicksight#TopicUserExperienceVersion": { + "type": "enum", + "members": { + "LEGACY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEGACY" + } + }, + "NEW_READER_EXPERIENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW_READER_EXPERIENCE" + } + } + } + }, + "com.amazonaws.quicksight#TopicVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The visual ID for the TopicVisual.

" + } + }, + "Role": { + "target": "com.amazonaws.quicksight#VisualRole", + "traits": { + "smithy.api#documentation": "

The role for the TopicVisual.

" + } + }, + "Ir": { + "target": "com.amazonaws.quicksight#TopicIR", + "traits": { + "smithy.api#documentation": "

The ir for the TopicVisual.

" + } + }, + "SupportingVisuals": { + "target": "com.amazonaws.quicksight#TopicVisuals", + "traits": { + "smithy.api#documentation": "

The supporting visuals for the TopicVisual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a TopicVisual.

" + } + }, + "com.amazonaws.quicksight#TopicVisuals": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicVisual" + } + }, + "com.amazonaws.quicksight#TotalAggregationComputation": { + "type": "structure", + "members": { + "ComputationId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for a computation.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of a computation.

" + } + }, + "Value": { + "target": "com.amazonaws.quicksight#MeasureField", + "traits": { + "smithy.api#documentation": "

The value field that is used in a computation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The total aggregation computation configuration.

" + } + }, + "com.amazonaws.quicksight#TotalAggregationFunction": { + "type": "structure", + "members": { + "SimpleTotalAggregationFunction": { + "target": "com.amazonaws.quicksight#SimpleTotalAggregationFunction", + "traits": { + "smithy.api#documentation": "

A built in aggregation function for total values.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An aggregation function that aggregates the total values of a measure.

" + } + }, + "com.amazonaws.quicksight#TotalAggregationOption": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field id that's associated with the total aggregation option.

", + "smithy.api#required": {} + } + }, + "TotalAggregationFunction": { + "target": "com.amazonaws.quicksight#TotalAggregationFunction", + "traits": { + "smithy.api#documentation": "

The total aggregation function that you want to set for a specified field id.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The total aggregation settings map of a field id.

" + } + }, + "com.amazonaws.quicksight#TotalAggregationOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TotalAggregationOption" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#TotalOptions": { + "type": "structure", + "members": { + "TotalsVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility configuration for the total cells.

" + } + }, + "Placement": { + "target": "com.amazonaws.quicksight#TableTotalsPlacement", + "traits": { + "smithy.api#documentation": "

The placement (start, end) for the total cells.

" + } + }, + "ScrollStatus": { + "target": "com.amazonaws.quicksight#TableTotalsScrollStatus", + "traits": { + "smithy.api#documentation": "

The scroll status (pinned, scrolled) for the total cells.

" + } + }, + "CustomLabel": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The custom label string for the total cells.

" + } + }, + "TotalCellStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

Cell styling options for the total cells.

" + } + }, + "TotalAggregationOptions": { + "target": "com.amazonaws.quicksight#TotalAggregationOptionList", + "traits": { + "smithy.api#documentation": "

The total aggregation settings for each value field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The total options for a table visual.

" + } + }, + "com.amazonaws.quicksight#TransformOperation": { + "type": "union", + "members": { + "ProjectOperation": { + "target": "com.amazonaws.quicksight#ProjectOperation", + "traits": { + "smithy.api#documentation": "

An operation that projects columns. Operations that come after a projection can only\n refer to projected columns.

" + } + }, + "FilterOperation": { + "target": "com.amazonaws.quicksight#FilterOperation", + "traits": { + "smithy.api#documentation": "

An operation that filters rows based on some condition.

" + } + }, + "CreateColumnsOperation": { + "target": "com.amazonaws.quicksight#CreateColumnsOperation", + "traits": { + "smithy.api#documentation": "

An operation that creates calculated columns. Columns created in one such operation\n form a lexical closure.

" + } + }, + "RenameColumnOperation": { + "target": "com.amazonaws.quicksight#RenameColumnOperation", + "traits": { + "smithy.api#documentation": "

An operation that renames a column.

" + } + }, + "CastColumnTypeOperation": { + "target": "com.amazonaws.quicksight#CastColumnTypeOperation", + "traits": { + "smithy.api#documentation": "

A transform operation that casts a column to a different type.

" + } + }, + "TagColumnOperation": { + "target": "com.amazonaws.quicksight#TagColumnOperation", + "traits": { + "smithy.api#documentation": "

An operation that tags a column with additional information.

" + } + }, + "UntagColumnOperation": { + "target": "com.amazonaws.quicksight#UntagColumnOperation" + }, + "OverrideDatasetParameterOperation": { + "target": "com.amazonaws.quicksight#OverrideDatasetParameterOperation" + } + }, + "traits": { + "smithy.api#documentation": "

A data transformation on a logical table. This is a variant type structure. For this\n structure to be valid, only one of the attributes can be non-null.

" + } + }, + "com.amazonaws.quicksight#TransformOperationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TransformOperation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#TreeMapAggregatedFieldWells": { + "type": "structure", + "members": { + "Groups": { + "target": "com.amazonaws.quicksight#TreeMapDimensionFieldList", + "traits": { + "smithy.api#documentation": "

The group by field well of a tree map. Values are grouped based on group by fields.

" + } + }, + "Sizes": { + "target": "com.amazonaws.quicksight#TreeMapMeasureFieldList", + "traits": { + "smithy.api#documentation": "

The size field well of a tree map. Values are aggregated based on group by fields.

" + } + }, + "Colors": { + "target": "com.amazonaws.quicksight#TreeMapMeasureFieldList", + "traits": { + "smithy.api#documentation": "

The color field well of a tree map. Values are grouped by aggregations based on group by fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Aggregated field wells of a tree map.

" + } + }, + "com.amazonaws.quicksight#TreeMapConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#TreeMapFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#TreeMapSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a tree map.

" + } + }, + "GroupLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility) of the groups that are displayed in a tree map.

" + } + }, + "SizeLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility) of the sizes that are displayed in a tree map.

" + } + }, + "ColorLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility) for the colors displayed in a tree map.

" + } + }, + "ColorScale": { + "target": "com.amazonaws.quicksight#ColorScale", + "traits": { + "smithy.api#documentation": "

The color options (gradient color, point of divergence) of a tree map.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "

The legend display setup of the visual.

" + } + }, + "DataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The tooltip display setup of the visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a tree map.

" + } + }, + "com.amazonaws.quicksight#TreeMapDimensionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#TreeMapFieldWells": { + "type": "structure", + "members": { + "TreeMapAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#TreeMapAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a tree map.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field wells of a tree map.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#TreeMapMeasureFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MeasureField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#TreeMapSortConfiguration": { + "type": "structure", + "members": { + "TreeMapSort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of group by fields.

" + } + }, + "TreeMapGroupItemsLimitConfiguration": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of groups that are displayed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a tree map.

" + } + }, + "com.amazonaws.quicksight#TreeMapVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#TreeMapConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A tree map.

\n

For more information, see Using tree maps in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#TrendArrowOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the trend arrows.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of trend arrows in a KPI visual.

" + } + }, + "com.amazonaws.quicksight#TrinoParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

The host name of the Trino data source.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

The port for the Trino data source.

", + "smithy.api#required": {} + } + }, + "Catalog": { + "target": "com.amazonaws.quicksight#Catalog", + "traits": { + "smithy.api#documentation": "

The catalog name for the Trino data source.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters that are required to connect to a Trino data source.

" + } + }, + "com.amazonaws.quicksight#TwitterParameters": { + "type": "structure", + "members": { + "Query": { + "target": "com.amazonaws.quicksight#Query", + "traits": { + "smithy.api#documentation": "

Twitter query string.

", + "smithy.api#required": {} + } + }, + "MaxRows": { + "target": "com.amazonaws.quicksight#PositiveInteger", + "traits": { + "smithy.api#documentation": "

Maximum number of rows to query Twitter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for Twitter.

" + } + }, + "com.amazonaws.quicksight#TypeCastFormat": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + } + } + }, + "com.amazonaws.quicksight#TypeParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.quicksight#LimitedString" + }, + "value": { + "target": "com.amazonaws.quicksight#LimitedString" + } + }, + "com.amazonaws.quicksight#Typography": { + "type": "structure", + "members": { + "FontFamilies": { + "target": "com.amazonaws.quicksight#FontList", + "traits": { + "smithy.api#documentation": "

Determines the list of font families.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the typography options.

" + } + }, + "com.amazonaws.quicksight#UIColorPalette": { + "type": "structure", + "members": { + "PrimaryForeground": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color of text and other foreground elements that appear over the primary\n background regions, such as grid lines, borders, table banding, icons, and so on.

" + } + }, + "PrimaryBackground": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The background color that applies to visuals and other high emphasis UI.

" + } + }, + "SecondaryForeground": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The foreground color that applies to any sheet title, sheet control text, or UI that\n appears over the secondary background.

" + } + }, + "SecondaryBackground": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The background color that applies to the sheet background and sheet controls.

" + } + }, + "Accent": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

This color is that applies to selected states and buttons.

" + } + }, + "AccentForeground": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n accent color.

" + } + }, + "Danger": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color that applies to error messages.

" + } + }, + "DangerForeground": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n error color.

" + } + }, + "Warning": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

This color that applies to warning and informational messages.

" + } + }, + "WarningForeground": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n warning color.

" + } + }, + "Success": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color that applies to success messages, for example the check mark for a\n successful download.

" + } + }, + "SuccessForeground": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n success color.

" + } + }, + "Dimension": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color that applies to the names of fields that are identified as\n dimensions.

" + } + }, + "DimensionForeground": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n dimension color.

" + } + }, + "Measure": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color that applies to the names of fields that are identified as measures.

" + } + }, + "MeasureForeground": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n measure color.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The theme colors that apply to UI and to charts, excluding data colors. The colors\n description is a hexadecimal color code that consists of six alphanumerical characters,\n prefixed with #, for example #37BFF5. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User\n Guide.\n

" + } + }, + "com.amazonaws.quicksight#URLOperationTemplate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#URLTargetConfiguration": { + "type": "enum", + "members": { + "NEW_TAB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW_TAB" + } + }, + "NEW_WINDOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW_WINDOW" + } + }, + "SAME_TAB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAME_TAB" + } + } + } + }, + "com.amazonaws.quicksight#UnaggregatedField": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The custom field ID.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that is used in the UnaggregatedField.

", + "smithy.api#required": {} + } + }, + "FormatConfiguration": { + "target": "com.amazonaws.quicksight#FormatConfiguration", + "traits": { + "smithy.api#documentation": "

The format configuration of the field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The unaggregated field for a table.

" + } + }, + "com.amazonaws.quicksight#UnaggregatedFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#UnaggregatedField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#UndefinedSpecifiedValueType": { + "type": "enum", + "members": { + "LEAST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEAST" + } + }, + "MOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MOST" + } + } + } + }, + "com.amazonaws.quicksight#UnicodeIcon": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[^\\u0000-\\u00FF]$" + } + }, + "com.amazonaws.quicksight#UniqueValuesComputation": { + "type": "structure", + "members": { + "ComputationId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for a computation.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of a computation.

" + } + }, + "Category": { + "target": "com.amazonaws.quicksight#DimensionField", + "traits": { + "smithy.api#documentation": "

The category field that is used in a computation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The unique values computation configuration.

" + } + }, + "com.amazonaws.quicksight#UnlimitedPixelLength": { + "type": "string", + "traits": { + "smithy.api#documentation": "String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value" + } + }, + "com.amazonaws.quicksight#UnsupportedPricingPlanException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This error indicates that you are calling an embedding operation in Amazon QuickSight\n\t\t\twithout the required pricing plan on your Amazon Web Services account. Before you can use embedding \n\t\t\tfor anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You \n\t\t can do this on the Manage Amazon QuickSight page.

\n

After capacity pricing is added, you can use the \n \n GetDashboardEmbedUrl\n API operation with the \n --identity-type ANONYMOUS option.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.quicksight#UnsupportedUserEditionException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This error indicates that you are calling an operation on an Amazon QuickSight\n\t\t\tsubscription where the edition doesn't include support for that operation. Amazon\n\t\t\tAmazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and\n\t\t\tcapability is available in every edition.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.quicksight#UntagColumnOperation": { + "type": "structure", + "members": { + "ColumnName": { + "target": "com.amazonaws.quicksight#ColumnName", + "traits": { + "smithy.api#documentation": "

The column that this operation acts on.

", + "smithy.api#required": {} + } + }, + "TagNames": { + "target": "com.amazonaws.quicksight#ColumnTagNames", + "traits": { + "smithy.api#documentation": "

The column tags to remove from this column.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A transform operation that removes tags associated with a column.

" + } + }, + "com.amazonaws.quicksight#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a tag or tags from a resource.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/resources/{ResourceArn}/tags", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to untag.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.quicksight#TagKeyList", + "traits": { + "smithy.api#documentation": "

The keys of the key-value pairs for the resource tag or tags assigned to the resource.

", + "smithy.api#httpQuery": "keys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UntagResourceResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateAccountCustomization": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateAccountCustomizationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateAccountCustomizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.

\n

You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a\n Amazon QuickSight namespace instead. Customizations that apply to a namespace override\n customizations that apply to an Amazon Web Services account. To find out which customizations apply, use\n the DescribeAccountCustomization API operation.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/customizations", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateAccountCustomizationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations\n for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that you want to update Amazon QuickSight customizations for.

", + "smithy.api#httpQuery": "namespace" + } + }, + "AccountCustomization": { + "target": "com.amazonaws.quicksight#AccountCustomization", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateAccountCustomizationResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.

" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations\n for.

" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace associated with the customization that you're updating.

" + } + }, + "AccountCustomization": { + "target": "com.amazonaws.quicksight#AccountCustomization", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateAccountSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateAccountSettingsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateAccountSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the Amazon QuickSight settings in your Amazon Web Services account.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/settings", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateAccountSettingsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to\n list.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DefaultNamespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The default namespace for this Amazon Web Services account. Currently, the default is\n default. IAM users that\n register for the first time with Amazon QuickSight provide an email address that becomes\n associated with the default namespace.\n

", + "smithy.api#required": {} + } + }, + "NotificationEmail": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The email address that you want Amazon QuickSight to send notifications to regarding your\n Amazon Web Services account or Amazon QuickSight subscription.

" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription request. A False value will allow the account to be deleted.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateAccountSettingsResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateAnalysisResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an analysis in Amazon QuickSight

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateAnalysisPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateAnalysisPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateAnalysisPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the read and write permissions for an analysis.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateAnalysisPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis whose permissions you're\n updating. You must be using the Amazon Web Services account that the analysis is in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis whose permissions you're updating. The ID is part of the\n analysis URL.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GrantPermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A structure that describes the permissions to add and the principal to add them\n to.

" + } + }, + "RevokePermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A structure that describes the permissions to remove and the principal to remove them\n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateAnalysisPermissionsResponse": { + "type": "structure", + "members": { + "AnalysisArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the analysis that you updated.

" + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis that you updated permissions for.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A structure that describes the principals and the resource-level permissions on an\n analysis.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateAnalysisRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis that you're updating.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the analysis that you're updating. This ID displays in the URL of the\n analysis.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#AnalysisName", + "traits": { + "smithy.api#documentation": "

A descriptive name for the analysis that you're updating. This name displays for the\n analysis in the Amazon QuickSight console.

", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.quicksight#Parameters", + "traits": { + "smithy.api#documentation": "

The parameter names and override values that you want to use. An analysis can have \n any parameter type, and some parameters might accept multiple values.

" + } + }, + "SourceEntity": { + "target": "com.amazonaws.quicksight#AnalysisSourceEntity", + "traits": { + "smithy.api#documentation": "

A source entity to use for the analysis that you're updating. This metadata structure\n contains details that describe a source template and one or more datasets.

" + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're\n creating. To see the theme in the Amazon QuickSight console, make sure that you have access to\n it.

" + } + }, + "Definition": { + "target": "com.amazonaws.quicksight#AnalysisDefinition", + "traits": { + "smithy.api#documentation": "

The definition of an analysis.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" + } + }, + "ValidationStrategy": { + "target": "com.amazonaws.quicksight#ValidationStrategy", + "traits": { + "smithy.api#documentation": "

The option to relax the validation needed to update an analysis with definition objects. This skips the validation step for specific errors.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateAnalysisResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the analysis that you're updating.

" + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis.

" + } + }, + "UpdateStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The update status of the last update that was made to the analysis.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateDashboard": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateDashboardRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateDashboardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a dashboard in an Amazon Web Services account.

\n \n

Updating a Dashboard creates a new dashboard version but does not immediately publish\n the new version. You can update the published version of a dashboard by\n using the \n UpdateDashboardPublishedVersion\n API operation.

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateDashboardLinks": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateDashboardLinksRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateDashboardLinksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the linked analyses on a dashboard.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/linked-entities", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateDashboardLinksRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard whose links you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LinkEntities": { + "target": "com.amazonaws.quicksight#LinkEntityArnList", + "traits": { + "smithy.api#documentation": "

list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateDashboardLinksResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "DashboardArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dashboard.

" + } + }, + "LinkEntities": { + "target": "com.amazonaws.quicksight#LinkEntityArnList", + "traits": { + "smithy.api#documentation": "

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateDashboardPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateDashboardPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateDashboardPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates read and write permissions on a dashboard.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateDashboardPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard whose permissions you're\n updating.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GrantPermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "

The permissions that you want to grant on this resource.

" + } + }, + "RevokePermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "

The permissions that you want to revoke from this resource.

" + } + }, + "GrantLinkPermissions": { + "target": "com.amazonaws.quicksight#UpdateLinkPermissionList", + "traits": { + "smithy.api#documentation": "

Grants link permissions to all users in a defined namespace.

" + } + }, + "RevokeLinkPermissions": { + "target": "com.amazonaws.quicksight#UpdateLinkPermissionList", + "traits": { + "smithy.api#documentation": "

Revokes link permissions from all users in a defined namespace.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateDashboardPermissionsResponse": { + "type": "structure", + "members": { + "DashboardArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dashboard.

" + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

Information about the permissions on the dashboard.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "LinkSharingConfiguration": { + "target": "com.amazonaws.quicksight#LinkSharingConfiguration", + "traits": { + "smithy.api#documentation": "

Updates the permissions of a shared link to an Amazon QuickSight dashboard.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateDashboardPublishedVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateDashboardPublishedVersionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateDashboardPublishedVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the published version of a dashboard.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/versions/{VersionNumber}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateDashboardPublishedVersionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're\n updating.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the dashboard.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateDashboardPublishedVersionResponse": { + "type": "structure", + "members": { + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

" + } + }, + "DashboardArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dashboard.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateDashboardRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're\n updating.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DashboardName", + "traits": { + "smithy.api#documentation": "

The display name of the dashboard.

", + "smithy.api#required": {} + } + }, + "SourceEntity": { + "target": "com.amazonaws.quicksight#DashboardSourceEntity", + "traits": { + "smithy.api#documentation": "

The entity that you are using as a source when you update the dashboard. In\n SourceEntity, you specify the type of object you're using as source. You\n can only update a dashboard from a template, so you use a SourceTemplate\n entity. If you need to update a dashboard from an analysis, first convert the analysis\n to a template by using the \n CreateTemplate\n API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplate ARN can contain any Amazon Web Services account and any\n Amazon QuickSight-supported Amazon Web Services Region.

\n

Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.

" + } + }, + "Parameters": { + "target": "com.amazonaws.quicksight#Parameters", + "traits": { + "smithy.api#documentation": "

A structure that contains the parameters of the dashboard. These are parameter\n overrides for a dashboard. A dashboard can have any type of parameters, and some\n parameters might accept multiple values.

" + } + }, + "VersionDescription": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

A description for the first version of the dashboard being created.

" + } + }, + "DashboardPublishOptions": { + "target": "com.amazonaws.quicksight#DashboardPublishOptions", + "traits": { + "smithy.api#documentation": "

Options for publishing the dashboard when you create it:

\n " + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If\n you add a value for this field, it overrides the value that was originally associated\n with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the\n dashboard.

" + } + }, + "Definition": { + "target": "com.amazonaws.quicksight#DashboardVersionDefinition", + "traits": { + "smithy.api#documentation": "

The definition of a dashboard.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" + } + }, + "ValidationStrategy": { + "target": "com.amazonaws.quicksight#ValidationStrategy", + "traits": { + "smithy.api#documentation": "

The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateDashboardResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "VersionArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the dashboard, including the version number.

" + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The creation status of the request.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateDataSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateDataSetRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateDataSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateDataSetPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateDataSetPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateDataSetPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the permissions on a dataset.

\n

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateDataSetPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dataset whose permissions you want to update. This ID is unique per\n\t\t\tAmazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GrantPermissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

The resource permissions that you want to grant to the dataset.

" + } + }, + "RevokePermissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

The resource permissions that you want to revoke from the dataset.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateDataSetPermissionsResponse": { + "type": "structure", + "members": { + "DataSetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dataset whose permissions you want to update. This ID is unique per\n\t\t\tAmazon Web Services Region for each Amazon Web Services account.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateDataSetRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each\n\t\t\tAmazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

The display name for the dataset.

", + "smithy.api#required": {} + } + }, + "PhysicalTableMap": { + "target": "com.amazonaws.quicksight#PhysicalTableMap", + "traits": { + "smithy.api#documentation": "

Declares the physical tables that are available in the underlying data sources.

", + "smithy.api#required": {} + } + }, + "LogicalTableMap": { + "target": "com.amazonaws.quicksight#LogicalTableMap", + "traits": { + "smithy.api#documentation": "

Configures the combination and transformation of the data from the physical tables.

" + } + }, + "ImportMode": { + "target": "com.amazonaws.quicksight#DataSetImportMode", + "traits": { + "smithy.api#documentation": "

Indicates whether you want to import the data into SPICE.

", + "smithy.api#required": {} + } + }, + "ColumnGroups": { + "target": "com.amazonaws.quicksight#ColumnGroupList", + "traits": { + "smithy.api#documentation": "

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

" + } + }, + "FieldFolders": { + "target": "com.amazonaws.quicksight#FieldFolderMap", + "traits": { + "smithy.api#documentation": "

The folder that contains fields and nested subfolders for your dataset.

" + } + }, + "RowLevelPermissionDataSet": { + "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", + "traits": { + "smithy.api#documentation": "

The row-level security configuration for the data you want to create.

" + } + }, + "RowLevelPermissionTagConfiguration": { + "target": "com.amazonaws.quicksight#RowLevelPermissionTagConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

" + } + }, + "ColumnLevelPermissionRules": { + "target": "com.amazonaws.quicksight#ColumnLevelPermissionRuleList", + "traits": { + "smithy.api#documentation": "

A set of one or more definitions of a \n ColumnLevelPermissionRule\n .

" + } + }, + "DataSetUsageConfiguration": { + "target": "com.amazonaws.quicksight#DataSetUsageConfiguration" + }, + "DatasetParameters": { + "target": "com.amazonaws.quicksight#DatasetParameterList", + "traits": { + "smithy.api#documentation": "

The parameter declarations of the dataset.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateDataSetResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "IngestionArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the ingestion, which is triggered as a result of dataset creation if the import\n\t\t\tmode is SPICE.

" + } + }, + "IngestionId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the ingestion, which is triggered as a result of dataset creation if the import\n\t\t\tmode is SPICE.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#CustomerManagedKeyUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a data source.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateDataSourcePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateDataSourcePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateDataSourcePermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the permissions to a data source.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateDataSourcePermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GrantPermissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions that you want to grant on the data source.

" + } + }, + "RevokePermissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions that you want to revoke on the data source.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateDataSourcePermissionsResponse": { + "type": "structure", + "members": { + "DataSourceArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateDataSourceRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

A display name for the data source.

", + "smithy.api#required": {} + } + }, + "DataSourceParameters": { + "target": "com.amazonaws.quicksight#DataSourceParameters", + "traits": { + "smithy.api#documentation": "

The parameters that Amazon QuickSight uses to connect to your underlying source.

" + } + }, + "Credentials": { + "target": "com.amazonaws.quicksight#DataSourceCredentials", + "traits": { + "smithy.api#documentation": "

The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently,\n\t\t\tonly credentials based on user name and password are supported.

" + } + }, + "VpcConnectionProperties": { + "target": "com.amazonaws.quicksight#VpcConnectionProperties", + "traits": { + "smithy.api#documentation": "

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to\n\t\t\tyour underlying source.

" + } + }, + "SslProperties": { + "target": "com.amazonaws.quicksight#SslProperties", + "traits": { + "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying\n\t\t\tsource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateDataSourceResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "UpdateStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The update status of the data source's last update.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateFolder": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateFolderRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateFolderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the name of a folder.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateFolderPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateFolderPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateFolderPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates permissions of a folder.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateFolderPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GrantPermissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

The permissions that you want to grant on a resource. Namespace ARNs are not supported Principal values for folder permissions.

" + } + }, + "RevokePermissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

The permissions that you want to revoke from a resource. Namespace ARNs are not supported Principal values for folder permissions.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateFolderPermissionsResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the folder.

" + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

Information about the permissions for the folder.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateFolderRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#FolderName", + "traits": { + "smithy.api#documentation": "

The name of the folder.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateFolderResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the folder.

" + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateGroupRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Changes a group description.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateGroupRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.quicksight#GroupDescription", + "traits": { + "smithy.api#documentation": "

The description for the group that you want to update.

" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the group that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateGroupResponse": { + "type": "structure", + "members": { + "Group": { + "target": "com.amazonaws.quicksight#Group", + "traits": { + "smithy.api#documentation": "

The name of the group.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateIAMPolicyAssignment": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateIAMPolicyAssignmentRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateIAMPolicyAssignmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConcurrentUpdatingException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing IAM policy assignment. This operation updates only\n\t\t\tthe optional parameter or parameters that are specified in the request. This overwrites\n\t\t\tall of the users included in Identities.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/{AssignmentName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateIAMPolicyAssignmentRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the IAM policy\n\t\t\tassignment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "traits": { + "smithy.api#documentation": "

The name of the assignment, also called a rule.\n\t\t\tThe\n\t\t\tname must be unique within the\n\t\t\tAmazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the assignment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", + "traits": { + "smithy.api#documentation": "

The status of the assignment. Possible values are as follows:

\n " + } + }, + "PolicyArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM policy to apply to the Amazon QuickSight users and\n\t\t\tgroups specified in this assignment.

" + } + }, + "Identities": { + "target": "com.amazonaws.quicksight#IdentityMap", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight users, groups, or both that you want to assign the policy\n\t\t\tto.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateIAMPolicyAssignmentResponse": { + "type": "structure", + "members": { + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "traits": { + "smithy.api#documentation": "

The name of the assignment or rule.

" + } + }, + "AssignmentId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the assignment.

" + } + }, + "PolicyArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM policy applied to the Amazon QuickSight users and\n\t\t\tgroups specified in this assignment.

" + } + }, + "Identities": { + "target": "com.amazonaws.quicksight#IdentityMap", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight users, groups, or both that the IAM policy is\n\t\t\tassigned to.

" + } + }, + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", + "traits": { + "smithy.api#documentation": "

The status of the assignment. Possible values are as follows:

\n " + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateIdentityPropagationConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateIdentityPropagationConfigRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateIdentityPropagationConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.

\n

This operation is only supported for Amazon QuickSight accounts using IAM Identity Center

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/identity-propagation-config/{Service}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateIdentityPropagationConfigRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the identity propagation configuration that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Service": { + "target": "com.amazonaws.quicksight#ServiceType", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Web Services service that contains the authorized targets that you want to add or update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AuthorizedTargets": { + "target": "com.amazonaws.quicksight#AuthorizedTargetsList", + "traits": { + "smithy.api#documentation": "

Specifies a list of application ARNs that represent the authorized targets for a service.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateIdentityPropagationConfigResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateIpRestriction": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateIpRestrictionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateIpRestrictionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the IpRestrictionRule, VpcIdRestrictionRule, or VpcEndpointIdRestrictionRule. To use this operation, you must provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/ip-restriction", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateIpRestrictionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the IP rules.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IpRestrictionRuleMap": { + "target": "com.amazonaws.quicksight#IpRestrictionRuleMap", + "traits": { + "smithy.api#documentation": "

A map that describes the updated IP rules with CIDR ranges and descriptions.

" + } + }, + "VpcIdRestrictionRuleMap": { + "target": "com.amazonaws.quicksight#VpcIdRestrictionRuleMap", + "traits": { + "smithy.api#documentation": "

A map of VPC IDs and their corresponding rules. When you configure this parameter, traffic from all VPC endpoints that are present in the specified VPC is allowed.

" + } + }, + "VpcEndpointIdRestrictionRuleMap": { + "target": "com.amazonaws.quicksight#VpcEndpointIdRestrictionRuleMap", + "traits": { + "smithy.api#documentation": "

A map of allowed VPC endpoint IDs and their corresponding rule descriptions.

" + } + }, + "Enabled": { + "target": "com.amazonaws.quicksight#NullableBoolean", + "traits": { + "smithy.api#documentation": "

A value that specifies whether IP rules are turned on.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateIpRestrictionResponse": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the IP rules.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateKeyRegistration": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateKeyRegistrationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateKeyRegistrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a customer managed key in a Amazon QuickSight account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/key-registration", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateKeyRegistrationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the customer managed key registration that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "KeyRegistration": { + "target": "com.amazonaws.quicksight#KeyRegistration", + "traits": { + "smithy.api#documentation": "

A list of RegisteredCustomerManagedKey objects to be updated to the Amazon QuickSight account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateKeyRegistrationResponse": { + "type": "structure", + "members": { + "FailedKeyRegistration": { + "target": "com.amazonaws.quicksight#FailedKeyRegistrationEntries", + "traits": { + "smithy.api#documentation": "

A list of all customer managed key registrations that failed to update.

" + } + }, + "SuccessfulKeyRegistration": { + "target": "com.amazonaws.quicksight#SuccessfulKeyRegistrationEntries", + "traits": { + "smithy.api#documentation": "

A list of all customer managed key registrations that were successfully updated.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateLinkPermissionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ResourcePermission" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#UpdatePublicSharingSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdatePublicSharingSettingsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdatePublicSharingSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedPricingPlanException" + } + ], + "traits": { + "smithy.api#documentation": "

Use the UpdatePublicSharingSettings operation to turn on or turn off the\n public sharing settings of an Amazon QuickSight dashboard.

\n

To use this operation, turn on session capacity pricing for your Amazon QuickSight\n account.

\n

Before you can turn on public sharing on your account, make sure to give public sharing\n permissions to an administrative user in the Identity and Access Management (IAM)\n console. For more information on using IAM with Amazon QuickSight, see\n Using Amazon QuickSight with IAM in the Amazon QuickSight\n User Guide.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/public-sharing-settings", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdatePublicSharingSettingsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with your Amazon QuickSight subscription.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PublicSharingEnabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdatePublicSharingSettingsResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a refresh schedule for a dataset.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateRefreshScheduleRequest": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Schedule": { + "target": "com.amazonaws.quicksight#RefreshSchedule", + "traits": { + "smithy.api#documentation": "

The refresh schedule.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateRefreshScheduleResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the refresh schedule.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the refresh schedule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateResourcePermissionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ResourcePermission" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#UpdateRoleCustomPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateRoleCustomPermissionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateRoleCustomPermissionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the custom permissions that are associated with a role.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateRoleCustomPermissionRequest": { + "type": "structure", + "members": { + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#RoleName", + "traits": { + "smithy.api#documentation": "

The name of the custom permission that you want to update the role with.

", + "smithy.api#required": {} + } + }, + "Role": { + "target": "com.amazonaws.quicksight#Role", + "traits": { + "smithy.api#documentation": "

The name of role tht you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that contains the role that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateRoleCustomPermissionResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateSPICECapacityConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateSPICECapacityConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateSPICECapacityConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the SPICE capacity configuration for a Amazon QuickSight account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/spice-capacity-configuration", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateSPICECapacityConfigurationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the SPICE configuration that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PurchaseMode": { + "target": "com.amazonaws.quicksight#PurchaseMode", + "traits": { + "smithy.api#documentation": "

Determines how SPICE capacity can be purchased. The following options are available.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateSPICECapacityConfigurationResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateTemplateRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a template from an existing Amazon QuickSight analysis or another template.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateTemplateAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateTemplateAliasRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateTemplateAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the template alias of a template.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateTemplateAliasRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template alias that you're updating.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The alias of the template that you want to update. If you name a specific alias, you update\n\t\t\tthe version that the alias points to. You can specify the latest version of the template\n\t\t\tby providing the keyword $LATEST in the AliasName parameter.\n\t\t\tThe keyword $PUBLISHED doesn't apply to templates.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateTemplateAliasResponse": { + "type": "structure", + "members": { + "TemplateAlias": { + "target": "com.amazonaws.quicksight#TemplateAlias", + "traits": { + "smithy.api#documentation": "

The template alias.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateTemplatePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateTemplatePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateTemplatePermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the resource permissions for a template.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateTemplatePermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GrantPermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions to be granted on the template.

" + } + }, + "RevokePermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions to be revoked from the template.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateTemplatePermissionsResponse": { + "type": "structure", + "members": { + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template.

" + } + }, + "TemplateArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions to be set on the template.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateTemplateRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template that you're updating.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SourceEntity": { + "target": "com.amazonaws.quicksight#TemplateSourceEntity", + "traits": { + "smithy.api#documentation": "

The entity that you are using as a source when you update the template. In\n\t\t\tSourceEntity, you specify the type of object you're using as source:\n\t\t\tSourceTemplate for a template or SourceAnalysis for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate, specify the ARN of the source template. For\n\t\t\tSourceAnalysis, specify the ARN of the source analysis. The SourceTemplate\n\t\t\tARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;.

\n

Use the DataSetReferences entity within SourceTemplate or\n\t\t\tSourceAnalysis to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.

" + } + }, + "VersionDescription": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

A description of the current template version that is being updated. Every time you call\n\t\t\t\tUpdateTemplate, you create a new version of the template. Each version\n\t\t\tof the template maintains a description of the version in the\n\t\t\t\tVersionDescription field.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#TemplateName", + "traits": { + "smithy.api#documentation": "

The name for the template.

" + } + }, + "Definition": { + "target": "com.amazonaws.quicksight#TemplateVersionDefinition", + "traits": { + "smithy.api#documentation": "

The definition of a template.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" + } + }, + "ValidationStrategy": { + "target": "com.amazonaws.quicksight#ValidationStrategy", + "traits": { + "smithy.api#documentation": "

The option to relax the validation needed to update a template with definition objects. This skips the validation step for specific errors.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateTemplateResponse": { + "type": "structure", + "members": { + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the template.

" + } + }, + "VersionArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the template, including the version information of the first version.

" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The creation status of the template.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateTheme": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateThemeRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateThemeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a theme.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateThemeAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateThemeAliasRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateThemeAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an alias of a theme.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateThemeAliasRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme alias that you're updating.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The name of the theme alias that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the theme that the alias should reference.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateThemeAliasResponse": { + "type": "structure", + "members": { + "ThemeAlias": { + "target": "com.amazonaws.quicksight#ThemeAlias", + "traits": { + "smithy.api#documentation": "

Information about the theme alias.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateThemePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateThemePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateThemePermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the resource permissions for a theme. Permissions apply to the action to grant or\n\t\t\trevoke permissions on, for example \"quicksight:DescribeTheme\".

\n

Theme permissions apply in groupings. Valid groupings include the following for the three\n\t\t\tlevels of permissions, which are user, owner, or no permissions:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateThemePermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GrantPermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions to be granted for the theme.

" + } + }, + "RevokePermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions to be revoked from the theme.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateThemePermissionsResponse": { + "type": "structure", + "members": { + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme.

" + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

The resulting list of resource permissions for the theme.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateThemeRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme that you're updating.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ThemeName", + "traits": { + "smithy.api#documentation": "

The name for the theme.

" + } + }, + "BaseThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The theme ID, defined by Amazon QuickSight, that a custom theme inherits from.\n\t\tAll themes initially inherit from a default Amazon QuickSight theme.

", + "smithy.api#required": {} + } + }, + "VersionDescription": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

A description of the theme version that you're updating Every time that you call\n\t\t\t\tUpdateTheme, you create a new version of the theme. Each version of the\n\t\t\ttheme maintains a description of the version in VersionDescription.

" + } + }, + "Configuration": { + "target": "com.amazonaws.quicksight#ThemeConfiguration", + "traits": { + "smithy.api#documentation": "

The theme configuration, which contains the theme display properties.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateThemeResponse": { + "type": "structure", + "members": { + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the theme.

" + } + }, + "VersionArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the new version of the theme.

" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The creation status of the theme.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateTopic": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateTopicRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateTopicResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a topic.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateTopicPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateTopicPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateTopicPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the permissions of a topic.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateTopicPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic that you want to update\n the permissions for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GrantPermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "

The resource permissions that you want to grant to the topic.

" + } + }, + "RevokePermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "

The resource permissions that you want to revoke from the topic.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateTopicPermissionsResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions on the topic.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateTopicRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateTopicRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateTopicRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a topic refresh schedule.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules/{DatasetId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateTopicRefreshScheduleRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic whose refresh schedule\n you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DatasetId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RefreshSchedule": { + "target": "com.amazonaws.quicksight#TopicRefreshSchedule", + "traits": { + "smithy.api#documentation": "

The definition of a refresh schedule.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateTopicRefreshScheduleResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateTopicRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic that you want to\n update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Topic": { + "target": "com.amazonaws.quicksight#TopicDetails", + "traits": { + "smithy.api#documentation": "

The definition of the topic that you want to update.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateTopicResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "RefreshArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic refresh.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateUserRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an Amazon QuickSight user.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateUserRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.quicksight#UserName", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight user name that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Email": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The email address of the user that you want to update.

", + "smithy.api#required": {} + } + }, + "Role": { + "target": "com.amazonaws.quicksight#UserRole", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight role of the user. The role can be one of the\n\t\t\tfollowing default security cohorts:

\n \n

The name of the Amazon QuickSight role is invisible to the user except for the console\n\t screens dealing with permissions.

", + "smithy.api#required": {} + } + }, + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#RoleName", + "traits": { + "smithy.api#documentation": "

(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:

\n \n

A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the Amazon QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a Amazon QuickSight user.

\n

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning Amazon QuickSight users to one of the\n default security cohorts in Amazon QuickSight (admin, author, reader).

\n

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

" + } + }, + "UnapplyCustomPermissions": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that you use to indicate that you want to remove all custom permissions\n from this user. Using this parameter resets the user to the state\n it was in before a custom permissions profile was applied. This parameter defaults to\n NULL and it doesn't accept any other value.

" + } + }, + "ExternalLoginFederationProviderType": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

\n " + } + }, + "CustomFederationProviderUrl": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate\n into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should\n only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

" + } + }, + "ExternalLoginId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The identity ID for a user in the external login provider.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateUserResponse": { + "type": "structure", + "members": { + "User": { + "target": "com.amazonaws.quicksight#User", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight user.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateVPCConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateVPCConnectionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateVPCConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a VPC connection.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateVPCConnectionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the account that contains the VPC connection that\n\t\t\tyou want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", + "traits": { + "smithy.api#documentation": "

The ID of the VPC connection that\n\t\t\tyou're updating. This ID is a unique identifier for each Amazon Web Services Region in an\n\t\t\t\tAmazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

The display name for the VPC connection.

", + "smithy.api#required": {} + } + }, + "SubnetIds": { + "target": "com.amazonaws.quicksight#SubnetIdList", + "traits": { + "smithy.api#documentation": "

A list of subnet IDs for the VPC connection.

", + "smithy.api#required": {} + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.quicksight#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of security group IDs for the VPC connection.

", + "smithy.api#required": {} + } + }, + "DnsResolvers": { + "target": "com.amazonaws.quicksight#DnsResolverList", + "traits": { + "smithy.api#documentation": "

A list of IP addresses of DNS resolver endpoints for the VPC connection.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.quicksight#RoleArn", + "traits": { + "smithy.api#documentation": "

An IAM role associated with the VPC connection.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateVPCConnectionResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC connection.

" + } + }, + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", + "traits": { + "smithy.api#documentation": "

The ID of the VPC connection that you are updating. This ID is a unique identifier for each Amazon Web Services Region in anAmazon Web Services account.

" + } + }, + "UpdateStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", + "traits": { + "smithy.api#documentation": "

The update status of the VPC connection's last update.

" + } + }, + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", + "traits": { + "smithy.api#documentation": "

The availability status of the VPC connection.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UploadSettings": { + "type": "structure", + "members": { + "Format": { + "target": "com.amazonaws.quicksight#FileFormat", + "traits": { + "smithy.api#documentation": "

File format.

" + } + }, + "StartFromRow": { + "target": "com.amazonaws.quicksight#PositiveInteger", + "traits": { + "smithy.api#documentation": "

A row number to start reading data from.

" + } + }, + "ContainsHeader": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Whether the file has a header row, or the files each have a header row.

" + } + }, + "TextQualifier": { + "target": "com.amazonaws.quicksight#TextQualifier", + "traits": { + "smithy.api#documentation": "

Text qualifier.

" + } + }, + "Delimiter": { + "target": "com.amazonaws.quicksight#Delimiter", + "traits": { + "smithy.api#documentation": "

The delimiter between values in the file.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the format for a source file or files.

" + } + }, + "com.amazonaws.quicksight#User": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the user.

" + } + }, + "UserName": { + "target": "com.amazonaws.quicksight#UserName", + "traits": { + "smithy.api#documentation": "

The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is\n N/A when the value for IdentityType is IAM\n and the corresponding IAM user is deleted.

" + } + }, + "Email": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The user's email address.

" + } + }, + "Role": { + "target": "com.amazonaws.quicksight#UserRole", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight role for the user. The user role can be one of the\n following:.

\n " + } + }, + "IdentityType": { + "target": "com.amazonaws.quicksight#IdentityType", + "traits": { + "smithy.api#documentation": "

The type of identity authentication used by the user.

" + } + }, + "Active": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a\n password.

" + } + }, + "PrincipalId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The principal ID of the user.

" + } + }, + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#RoleName", + "traits": { + "smithy.api#documentation": "

The custom permissions profile associated with this user.

" + } + }, + "ExternalLoginFederationProviderType": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The type of supported external login provider that provides identity to let the user\n federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.

\n " + } + }, + "ExternalLoginFederationProviderUrl": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The URL of the external login provider.

" + } + }, + "ExternalLoginId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The identity ID for the user in the external login provider.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A registered user of Amazon QuickSight.

" + } + }, + "com.amazonaws.quicksight#UserList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#User" + } + }, + "com.amazonaws.quicksight#UserName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.quicksight#UserRole": { + "type": "enum", + "members": { + "ADMIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADMIN" + } + }, + "AUTHOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHOR" + } + }, + "READER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READER" + } + }, + "RESTRICTED_AUTHOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESTRICTED_AUTHOR" + } + }, + "RESTRICTED_READER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESTRICTED_READER" + } + }, + "ADMIN_PRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADMIN_PRO" + } + }, + "AUTHOR_PRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHOR_PRO" + } + }, + "READER_PRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READER_PRO" + } + } + } + }, + "com.amazonaws.quicksight#VPCConnection": { + "type": "structure", + "members": { + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", + "traits": { + "smithy.api#documentation": "

The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an\n Amazon Web Services account.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC connection.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

The display name for the VPC connection.

" + } + }, + "VPCId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 VPC ID associated with the VPC connection.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.quicksight#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 security group IDs associated with the VPC connection.

" + } + }, + "DnsResolvers": { + "target": "com.amazonaws.quicksight#StringList", + "traits": { + "smithy.api#documentation": "

A list of IP addresses of DNS resolver endpoints for the VPC connection.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", + "traits": { + "smithy.api#documentation": "

The status of the VPC connection.

" + } + }, + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", + "traits": { + "smithy.api#documentation": "

The availability status of the VPC connection.

" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.quicksight#NetworkInterfaceList", + "traits": { + "smithy.api#documentation": "

A list of network interfaces.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ARN of the\n IAM role associated with the VPC\n connection.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the VPC connection was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the VPC connection was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The structure of a VPC connection.

" + } + }, + "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "UNAVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNAVAILABLE" + } + }, + "PARTIALLY_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARTIALLY_AVAILABLE" + } + } + } + }, + "com.amazonaws.quicksight#VPCConnectionResourceIdRestricted": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^[\\w\\-]+$" + } + }, + "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.quicksight#VPCConnectionResourceStatus": { + "type": "enum", + "members": { + "CREATION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_IN_PROGRESS" + } + }, + "CREATION_SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_SUCCESSFUL" + } + }, + "CREATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_FAILED" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" + } + }, + "UPDATE_SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_SUCCESSFUL" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETION_IN_PROGRESS" + } + }, + "DELETION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETION_FAILED" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.quicksight#VPCConnectionSummary": { + "type": "structure", + "members": { + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", + "traits": { + "smithy.api#documentation": "

The ID of the VPC connection that\n you're\n creating. This ID is a unique identifier for each Amazon Web Services Region in an\n Amazon Web Services account.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC connection.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

The display name for the VPC connection.

" + } + }, + "VPCId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 VPC ID associated with the VPC connection.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.quicksight#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 security group IDs associated with the VPC connection.

" + } + }, + "DnsResolvers": { + "target": "com.amazonaws.quicksight#StringList", + "traits": { + "smithy.api#documentation": "

A list of IP addresses of DNS resolver endpoints for the VPC connection.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", + "traits": { + "smithy.api#documentation": "

The status of the VPC connection.

" + } + }, + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", + "traits": { + "smithy.api#documentation": "

The availability status of the VPC connection.

" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.quicksight#NetworkInterfaceList", + "traits": { + "smithy.api#documentation": "

A list of network interfaces.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role associated\n with the VPC connection.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the VPC connection was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the VPC connection was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The summary metadata that describes a VPC connection.

" + } + }, + "com.amazonaws.quicksight#VPCConnectionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#VPCConnectionSummary" + } + }, + "com.amazonaws.quicksight#ValidationStrategy": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.quicksight#ValidationStrategyMode", + "traits": { + "smithy.api#documentation": "

The mode of validation for the asset to be created or updated. When you set this value to STRICT, strict validation for every error is enforced. When you set this value to LENIENT, validation is skipped for specific UI errors.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

" + } + }, + "com.amazonaws.quicksight#ValidationStrategyMode": { + "type": "enum", + "members": { + "STRICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRICT" + } + }, + "LENIENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LENIENT" + } + } + } + }, + "com.amazonaws.quicksight#ValueWhenUnsetOption": { + "type": "enum", + "members": { + "RECOMMENDED_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECOMMENDED_VALUE" + } + }, + "NULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NULL" + } + } + } + }, + "com.amazonaws.quicksight#VersionDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.quicksight#VersionNumber": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.quicksight#VerticalTextAlignment": { + "type": "enum", + "members": { + "TOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOP" + } + }, + "MIDDLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIDDLE" + } + }, + "BOTTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTTOM" + } + }, + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + } + } + }, + "com.amazonaws.quicksight#Visibility": { + "type": "enum", + "members": { + "HIDDEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIDDEN" + } + }, + "VISIBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VISIBLE" + } + } + } + }, + "com.amazonaws.quicksight#VisiblePanelColumns": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#VisiblePanelRows": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#VisibleRangeOptions": { + "type": "structure", + "members": { + "PercentRange": { + "target": "com.amazonaws.quicksight#PercentVisibleRange", + "traits": { + "smithy.api#documentation": "

The percent range in the visible range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The range options for the data zoom scroll bar.

" + } + }, + "com.amazonaws.quicksight#Visual": { + "type": "structure", + "members": { + "TableVisual": { + "target": "com.amazonaws.quicksight#TableVisual", + "traits": { + "smithy.api#documentation": "

A table visual.

\n

For more information, see Using tables as visuals in the Amazon QuickSight User Guide.

" + } + }, + "PivotTableVisual": { + "target": "com.amazonaws.quicksight#PivotTableVisual", + "traits": { + "smithy.api#documentation": "

A pivot table.

\n

For more information, see Using pivot tables in the Amazon QuickSight User Guide.

" + } + }, + "BarChartVisual": { + "target": "com.amazonaws.quicksight#BarChartVisual", + "traits": { + "smithy.api#documentation": "

A bar chart.

\n

For more information, see Using bar charts in the Amazon QuickSight User Guide.

" + } + }, + "KPIVisual": { + "target": "com.amazonaws.quicksight#KPIVisual", + "traits": { + "smithy.api#documentation": "

A key performance indicator (KPI).

\n

For more information, see Using KPIs in the Amazon QuickSight User Guide.

" + } + }, + "PieChartVisual": { + "target": "com.amazonaws.quicksight#PieChartVisual", + "traits": { + "smithy.api#documentation": "

A pie or donut chart.

\n

For more information, see Using pie charts in the Amazon QuickSight User Guide.

" + } + }, + "GaugeChartVisual": { + "target": "com.amazonaws.quicksight#GaugeChartVisual", + "traits": { + "smithy.api#documentation": "

A gauge chart.

\n

For more information, see Using gauge charts in the Amazon QuickSight User Guide.

" + } + }, + "LineChartVisual": { + "target": "com.amazonaws.quicksight#LineChartVisual", + "traits": { + "smithy.api#documentation": "

A line chart.

\n

For more information, see Using line charts in the Amazon QuickSight User Guide.

" + } + }, + "HeatMapVisual": { + "target": "com.amazonaws.quicksight#HeatMapVisual", + "traits": { + "smithy.api#documentation": "

A heat map.

\n

For more information, see Using heat maps in the Amazon QuickSight User Guide.

" + } + }, + "TreeMapVisual": { + "target": "com.amazonaws.quicksight#TreeMapVisual", + "traits": { + "smithy.api#documentation": "

A tree map.

\n

For more information, see Using tree maps in the Amazon QuickSight User Guide.

" + } + }, + "GeospatialMapVisual": { + "target": "com.amazonaws.quicksight#GeospatialMapVisual", + "traits": { + "smithy.api#documentation": "

A geospatial map or a points on map visual.

\n

For more information, see Creating point maps in the Amazon QuickSight User Guide.

" + } + }, + "FilledMapVisual": { + "target": "com.amazonaws.quicksight#FilledMapVisual", + "traits": { + "smithy.api#documentation": "

A filled map.

\n

For more information, see Creating filled maps in the Amazon QuickSight User Guide.

" + } + }, + "FunnelChartVisual": { + "target": "com.amazonaws.quicksight#FunnelChartVisual", + "traits": { + "smithy.api#documentation": "

A funnel chart.

\n

For more information, see Using funnel charts in the Amazon QuickSight User Guide.

" + } + }, + "ScatterPlotVisual": { + "target": "com.amazonaws.quicksight#ScatterPlotVisual", + "traits": { + "smithy.api#documentation": "

A scatter plot.

\n

For more information, see Using scatter plots in the Amazon QuickSight User Guide.

" + } + }, + "ComboChartVisual": { + "target": "com.amazonaws.quicksight#ComboChartVisual", + "traits": { + "smithy.api#documentation": "

A combo chart.

\n

For more information, see Using combo charts in the Amazon QuickSight User Guide.

" + } + }, + "BoxPlotVisual": { + "target": "com.amazonaws.quicksight#BoxPlotVisual", + "traits": { + "smithy.api#documentation": "

A box plot.

\n

For more information, see Using box plots in the Amazon QuickSight User Guide.

" + } + }, + "WaterfallVisual": { + "target": "com.amazonaws.quicksight#WaterfallVisual", + "traits": { + "smithy.api#documentation": "

A waterfall chart.

\n

For more information, see Using waterfall charts in the Amazon QuickSight User Guide.

" + } + }, + "HistogramVisual": { + "target": "com.amazonaws.quicksight#HistogramVisual", + "traits": { + "smithy.api#documentation": "

A histogram.

\n

For more information, see Using histograms in the Amazon QuickSight User Guide.

" + } + }, + "WordCloudVisual": { + "target": "com.amazonaws.quicksight#WordCloudVisual", + "traits": { + "smithy.api#documentation": "

A word cloud.

\n

For more information, see Using word clouds in the Amazon QuickSight User Guide.

" + } + }, + "InsightVisual": { + "target": "com.amazonaws.quicksight#InsightVisual", + "traits": { + "smithy.api#documentation": "

An insight visual.

\n

For more information, see Working with insights in the Amazon QuickSight User Guide.

" + } + }, + "SankeyDiagramVisual": { + "target": "com.amazonaws.quicksight#SankeyDiagramVisual", + "traits": { + "smithy.api#documentation": "

A sankey diagram.

\n

For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.

" + } + }, + "CustomContentVisual": { + "target": "com.amazonaws.quicksight#CustomContentVisual", + "traits": { + "smithy.api#documentation": "

A visual that contains custom content.

\n

For more information, see Using custom visual content in the Amazon QuickSight User Guide.

" + } + }, + "EmptyVisual": { + "target": "com.amazonaws.quicksight#EmptyVisual", + "traits": { + "smithy.api#documentation": "

An empty visual.

" + } + }, + "RadarChartVisual": { + "target": "com.amazonaws.quicksight#RadarChartVisual", + "traits": { + "smithy.api#documentation": "

A radar chart visual.

\n

For more information, see Using radar charts in the Amazon QuickSight User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A visual displayed on a sheet in an analysis, dashboard, or template.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#VisualAxisSortOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

The availaiblity status of a visual's axis sort options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The axis sort options for a visual.

" + } + }, + "com.amazonaws.quicksight#VisualCustomAction": { + "type": "structure", + "members": { + "CustomActionId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the VisualCustomAction.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#VisualCustomActionName", + "traits": { + "smithy.api#documentation": "

The name of the VisualCustomAction.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.quicksight#WidgetStatus", + "traits": { + "smithy.api#documentation": "

The status of the VisualCustomAction.

" + } + }, + "Trigger": { + "target": "com.amazonaws.quicksight#VisualCustomActionTrigger", + "traits": { + "smithy.api#documentation": "

The trigger of the VisualCustomAction.

\n

Valid values are defined as follows:

\n ", + "smithy.api#required": {} + } + }, + "ActionOperations": { + "target": "com.amazonaws.quicksight#VisualCustomActionOperationList", + "traits": { + "smithy.api#documentation": "

A list of VisualCustomActionOperations.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A custom action defined on a visual.

" + } + }, + "com.amazonaws.quicksight#VisualCustomActionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#VisualCustomAction" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#VisualCustomActionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#VisualCustomActionOperation": { + "type": "structure", + "members": { + "FilterOperation": { + "target": "com.amazonaws.quicksight#CustomActionFilterOperation", + "traits": { + "smithy.api#documentation": "

The filter operation that filters data included in a visual or in an entire sheet.

" + } + }, + "NavigationOperation": { + "target": "com.amazonaws.quicksight#CustomActionNavigationOperation", + "traits": { + "smithy.api#documentation": "

The navigation operation that navigates between different sheets in the same analysis.

" + } + }, + "URLOperation": { + "target": "com.amazonaws.quicksight#CustomActionURLOperation", + "traits": { + "smithy.api#documentation": "

The URL operation that opens a link to another webpage.

" + } + }, + "SetParametersOperation": { + "target": "com.amazonaws.quicksight#CustomActionSetParametersOperation", + "traits": { + "smithy.api#documentation": "

The set parameter operation that sets parameters in custom action.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The operation that is defined by the custom action.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#VisualCustomActionOperationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#VisualCustomActionOperation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.quicksight#VisualCustomActionTrigger": { + "type": "enum", + "members": { + "DATA_POINT_CLICK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_POINT_CLICK" + } + }, + "DATA_POINT_MENU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_POINT_MENU" + } + } + } + }, + "com.amazonaws.quicksight#VisualInteractionOptions": { + "type": "structure", + "members": { + "VisualMenuOption": { + "target": "com.amazonaws.quicksight#VisualMenuOption", + "traits": { + "smithy.api#documentation": "

The on-visual menu options for a visual.

" + } + }, + "ContextMenuOption": { + "target": "com.amazonaws.quicksight#ContextMenuOption", + "traits": { + "smithy.api#documentation": "

The context menu options for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for visual publish options

" + } + }, + "com.amazonaws.quicksight#VisualList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Visual" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#VisualMenuOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

The availaiblity status of a visual's menu options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The menu options for a visual.

" + } + }, + "com.amazonaws.quicksight#VisualOptions": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The type for a VisualOptions.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a VisualOptions.

" + } + }, + "com.amazonaws.quicksight#VisualPalette": { + "type": "structure", + "members": { + "ChartColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The chart color options for the visual palette.

" + } + }, + "ColorMap": { + "target": "com.amazonaws.quicksight#DataPathColorList", + "traits": { + "smithy.api#documentation": "

The color map options for the visual palette.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The visual display options for the visual palette.

" + } + }, + "com.amazonaws.quicksight#VisualRole": { + "type": "enum", + "members": { + "PRIMARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIMARY" + } + }, + "COMPLIMENTARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLIMENTARY" + } + }, + "MULTI_INTENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTI_INTENT" + } + }, + "FALLBACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FALLBACK" + } + }, + "FRAGMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FRAGMENT" + } + } + } + }, + "com.amazonaws.quicksight#VisualSubtitleLabelOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the subtitle label.

" + } + }, + "FormatText": { + "target": "com.amazonaws.quicksight#LongFormatText", + "traits": { + "smithy.api#documentation": "

The long text format of the subtitle label, such as plain text or rich text.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The subtitle label options for a visual.

" + } + }, + "com.amazonaws.quicksight#VisualTitleLabelOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the title label.

" + } + }, + "FormatText": { + "target": "com.amazonaws.quicksight#ShortFormatText", + "traits": { + "smithy.api#documentation": "

The short text format of the title label, such as plain text or rich text.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The title label options for a visual.

" + } + }, + "com.amazonaws.quicksight#VpcConnectionProperties": { + "type": "structure", + "members": { + "VpcConnectionArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the VPC connection.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

VPC connection properties.

" + } + }, + "com.amazonaws.quicksight#VpcEndpointId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^vpce-[0-9a-z]*$" + } + }, + "com.amazonaws.quicksight#VpcEndpointIdRestrictionRuleDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 150 + } + } + }, + "com.amazonaws.quicksight#VpcEndpointIdRestrictionRuleMap": { + "type": "map", + "key": { + "target": "com.amazonaws.quicksight#VpcEndpointId" + }, + "value": { + "target": "com.amazonaws.quicksight#VpcEndpointIdRestrictionRuleDescription" + } + }, + "com.amazonaws.quicksight#VpcId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^vpc-[0-9a-z]*$" + } + }, + "com.amazonaws.quicksight#VpcIdRestrictionRuleDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 150 + } + } + }, + "com.amazonaws.quicksight#VpcIdRestrictionRuleMap": { + "type": "map", + "key": { + "target": "com.amazonaws.quicksight#VpcId" + }, + "value": { + "target": "com.amazonaws.quicksight#VpcIdRestrictionRuleDescription" + } + }, + "com.amazonaws.quicksight#Warehouse": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.quicksight#WaterfallChartAggregatedFieldWells": { + "type": "structure", + "members": { + "Categories": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The category field wells of a waterfall visual.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The value field wells of a waterfall visual.

" + } + }, + "Breakdowns": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The breakdown field wells of a waterfall visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a waterfall visual.

" + } + }, + "com.amazonaws.quicksight#WaterfallChartColorConfiguration": { + "type": "structure", + "members": { + "GroupColorConfiguration": { + "target": "com.amazonaws.quicksight#WaterfallChartGroupColorConfiguration", + "traits": { + "smithy.api#documentation": "

The color configuration for individual groups within a waterfall visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The color configuration of a waterfall visual.

" + } + }, + "com.amazonaws.quicksight#WaterfallChartConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#WaterfallChartFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a waterfall visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#WaterfallChartSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a waterfall visual.

" + } + }, + "WaterfallChartOptions": { + "target": "com.amazonaws.quicksight#WaterfallChartOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of a waterfall visual.

" + } + }, + "CategoryAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the category axis label.

" + } + }, + "CategoryAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the category axis.

" + } + }, + "PrimaryYAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the y-axis label.

" + } + }, + "PrimaryYAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the y-axis.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "

The legend configuration of a waterfall visual.

" + } + }, + "DataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The data label configuration of a waterfall visual.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "

The visual palette configuration of a waterfall visual.

" + } + }, + "ColorConfiguration": { + "target": "com.amazonaws.quicksight#WaterfallChartColorConfiguration", + "traits": { + "smithy.api#documentation": "

The color configuration of a waterfall visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a waterfall visual.

" + } + }, + "com.amazonaws.quicksight#WaterfallChartFieldWells": { + "type": "structure", + "members": { + "WaterfallChartAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#WaterfallChartAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a waterfall visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a waterfall visual.

" + } + }, + "com.amazonaws.quicksight#WaterfallChartGroupColorConfiguration": { + "type": "structure", + "members": { + "PositiveBarColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

Defines the color for the positive bars of a waterfall chart.

" + } + }, + "NegativeBarColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

Defines the color for the negative bars of a waterfall chart.

" + } + }, + "TotalBarColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

Defines the color for the total bars of a waterfall chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The color configuration for individual groups within a waterfall visual.

" + } + }, + "com.amazonaws.quicksight#WaterfallChartOptions": { + "type": "structure", + "members": { + "TotalBarLabel": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

This option determines the total bar label of a waterfall visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of a waterfall visual.

" + } + }, + "com.amazonaws.quicksight#WaterfallChartSortConfiguration": { + "type": "structure", + "members": { + "CategorySort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the category fields.

" + } + }, + "BreakdownItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of bar groups that are displayed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a waterfall visual.

" + } + }, + "com.amazonaws.quicksight#WaterfallVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#WaterfallChartConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for a waterfall visual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A waterfall chart.

\n

For more information, see Using waterfall charts in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#WhatIfPointScenario": { + "type": "structure", + "members": { + "Date": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The date that you need the forecast results for.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The target value that you want to meet for the provided date.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides the forecast to meet the target for a particular date.

" + } + }, + "com.amazonaws.quicksight#WhatIfRangeScenario": { + "type": "structure", + "members": { + "StartDate": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The start date in the date range that you need the forecast results for.

", + "smithy.api#required": {} + } + }, + "EndDate": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The end date in the date range that you need the forecast results for.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The target value that you want to meet for the provided date range.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides the forecast to meet the target for a particular date range.

" + } + }, + "com.amazonaws.quicksight#WidgetStatus": { + "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.quicksight#WordCloudAggregatedFieldWells": { + "type": "structure", + "members": { + "GroupBy": { + "target": "com.amazonaws.quicksight#WordCloudDimensionFieldList", + "traits": { + "smithy.api#documentation": "

The group by field well of a word cloud. Values are grouped by group by fields.

" + } + }, + "Size": { + "target": "com.amazonaws.quicksight#WordCloudMeasureFieldList", + "traits": { + "smithy.api#documentation": "

The size field well of a word cloud. Values are aggregated based on group by fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a word cloud.

" + } + }, + "com.amazonaws.quicksight#WordCloudChartConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#WordCloudFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#WordCloudSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a word cloud visual.

" + } + }, + "CategoryLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) for the word cloud category.

" + } + }, + "WordCloudOptions": { + "target": "com.amazonaws.quicksight#WordCloudOptions", + "traits": { + "smithy.api#documentation": "

The options for a word cloud visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a word cloud visual.

" + } + }, + "com.amazonaws.quicksight#WordCloudCloudLayout": { + "type": "enum", + "members": { + "FLUID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLUID" + } + }, + "NORMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NORMAL" + } + } + } + }, + "com.amazonaws.quicksight#WordCloudDimensionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#WordCloudFieldWells": { + "type": "structure", + "members": { + "WordCloudAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#WordCloudAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a word cloud.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field wells of a word cloud visual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#WordCloudMaximumStringLength": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#WordCloudMeasureFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MeasureField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#WordCloudOptions": { + "type": "structure", + "members": { + "WordOrientation": { + "target": "com.amazonaws.quicksight#WordCloudWordOrientation", + "traits": { + "smithy.api#documentation": "

The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.

" + } + }, + "WordScaling": { + "target": "com.amazonaws.quicksight#WordCloudWordScaling", + "traits": { + "smithy.api#documentation": "

The word scaling options (emphasize, normal) for the words in a word cloud.

" + } + }, + "CloudLayout": { + "target": "com.amazonaws.quicksight#WordCloudCloudLayout", + "traits": { + "smithy.api#documentation": "

The cloud layout options (fluid, normal) of a word cloud.

" + } + }, + "WordCasing": { + "target": "com.amazonaws.quicksight#WordCloudWordCasing", + "traits": { + "smithy.api#documentation": "

The word casing options (lower_case, existing_case) for the words in a word cloud.

" + } + }, + "WordPadding": { + "target": "com.amazonaws.quicksight#WordCloudWordPadding", + "traits": { + "smithy.api#documentation": "

The word padding options (none, small, medium, large) for the words in a word cloud.

" + } + }, + "MaximumStringLength": { + "target": "com.amazonaws.quicksight#WordCloudMaximumStringLength", + "traits": { + "smithy.api#documentation": "

The length limit of each word from 1-100.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The word cloud options for a word cloud visual.

" + } + }, + "com.amazonaws.quicksight#WordCloudSortConfiguration": { + "type": "structure", + "members": { + "CategoryItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of groups that are displayed in a word cloud.

" + } + }, + "CategorySort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of group by fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a word cloud visual.

" + } + }, + "com.amazonaws.quicksight#WordCloudVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#WordCloudChartConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A word cloud.

\n

For more information, see Using word clouds in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#WordCloudWordCasing": { + "type": "enum", + "members": { + "LOWER_CASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOWER_CASE" + } + }, + "EXISTING_CASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXISTING_CASE" + } + } + } + }, + "com.amazonaws.quicksight#WordCloudWordOrientation": { + "type": "enum", + "members": { + "HORIZONTAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HORIZONTAL" + } + }, + "HORIZONTAL_AND_VERTICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HORIZONTAL_AND_VERTICAL" + } + } + } + }, + "com.amazonaws.quicksight#WordCloudWordPadding": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "SMALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMALL" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LARGE" + } + } + } + }, + "com.amazonaws.quicksight#WordCloudWordScaling": { + "type": "enum", + "members": { + "EMPHASIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMPHASIZE" + } + }, + "NORMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NORMAL" + } + } + } + }, + "com.amazonaws.quicksight#WorkGroup": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.quicksight#YAxisOptions": { + "type": "structure", + "members": { + "YAxis": { + "target": "com.amazonaws.quicksight#SingleYAxisOption", + "traits": { + "smithy.api#documentation": "

The Y axis type to be used in the chart.

\n

If you choose PRIMARY_Y_AXIS, the primary Y Axis is located on the leftmost vertical axis of the chart.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that are available for a single Y axis in a chart.

" + } } - }, - "traits": { - "smithy.api#documentation": "

The options that are available for a single Y axis in a chart.

" - } } - } } diff --git a/codegen/sdk-codegen/aws-models/route-53.json b/codegen/sdk-codegen/aws-models/route-53.json index 689203973d63..16b78b0838d0 100644 --- a/codegen/sdk-codegen/aws-models/route-53.json +++ b/codegen/sdk-codegen/aws-models/route-53.json @@ -1,12496 +1,12516 @@ { - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.route53#ARN": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.route53#AWSAccountID": { - "type": "string" + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] }, - "com.amazonaws.route53#AWSDnsV20130401": { - "type": "service", - "version": "2013-04-01", - "operations": [ - { - "target": "com.amazonaws.route53#ActivateKeySigningKey" - }, - { - "target": "com.amazonaws.route53#AssociateVPCWithHostedZone" - }, - { - "target": "com.amazonaws.route53#ChangeCidrCollection" - }, - { - "target": "com.amazonaws.route53#ChangeResourceRecordSets" - }, - { - "target": "com.amazonaws.route53#ChangeTagsForResource" - }, - { - "target": "com.amazonaws.route53#CreateCidrCollection" - }, - { - "target": "com.amazonaws.route53#CreateHealthCheck" - }, - { - "target": "com.amazonaws.route53#CreateHostedZone" - }, - { - "target": "com.amazonaws.route53#CreateKeySigningKey" - }, - { - "target": "com.amazonaws.route53#CreateQueryLoggingConfig" - }, - { - "target": "com.amazonaws.route53#CreateReusableDelegationSet" - }, - { - "target": "com.amazonaws.route53#CreateTrafficPolicy" - }, - { - "target": "com.amazonaws.route53#CreateTrafficPolicyInstance" - }, - { - "target": "com.amazonaws.route53#CreateTrafficPolicyVersion" - }, - { - "target": "com.amazonaws.route53#CreateVPCAssociationAuthorization" - }, - { - "target": "com.amazonaws.route53#DeactivateKeySigningKey" - }, - { - "target": "com.amazonaws.route53#DeleteCidrCollection" - }, - { - "target": "com.amazonaws.route53#DeleteHealthCheck" - }, - { - "target": "com.amazonaws.route53#DeleteHostedZone" - }, - { - "target": "com.amazonaws.route53#DeleteKeySigningKey" - }, - { - "target": "com.amazonaws.route53#DeleteQueryLoggingConfig" - }, - { - "target": "com.amazonaws.route53#DeleteReusableDelegationSet" - }, - { - "target": "com.amazonaws.route53#DeleteTrafficPolicy" - }, - { - "target": "com.amazonaws.route53#DeleteTrafficPolicyInstance" - }, - { - "target": "com.amazonaws.route53#DeleteVPCAssociationAuthorization" - }, - { - "target": "com.amazonaws.route53#DisableHostedZoneDNSSEC" - }, - { - "target": "com.amazonaws.route53#DisassociateVPCFromHostedZone" - }, - { - "target": "com.amazonaws.route53#EnableHostedZoneDNSSEC" - }, - { - "target": "com.amazonaws.route53#GetAccountLimit" - }, - { - "target": "com.amazonaws.route53#GetChange" - }, - { - "target": "com.amazonaws.route53#GetCheckerIpRanges" - }, - { - "target": "com.amazonaws.route53#GetDNSSEC" - }, - { - "target": "com.amazonaws.route53#GetGeoLocation" - }, - { - "target": "com.amazonaws.route53#GetHealthCheck" - }, - { - "target": "com.amazonaws.route53#GetHealthCheckCount" - }, - { - "target": "com.amazonaws.route53#GetHealthCheckLastFailureReason" - }, - { - "target": "com.amazonaws.route53#GetHealthCheckStatus" - }, - { - "target": "com.amazonaws.route53#GetHostedZone" - }, - { - "target": "com.amazonaws.route53#GetHostedZoneCount" - }, - { - "target": "com.amazonaws.route53#GetHostedZoneLimit" - }, - { - "target": "com.amazonaws.route53#GetQueryLoggingConfig" - }, - { - "target": "com.amazonaws.route53#GetReusableDelegationSet" - }, - { - "target": "com.amazonaws.route53#GetReusableDelegationSetLimit" - }, - { - "target": "com.amazonaws.route53#GetTrafficPolicy" - }, - { - "target": "com.amazonaws.route53#GetTrafficPolicyInstance" - }, - { - "target": "com.amazonaws.route53#GetTrafficPolicyInstanceCount" - }, - { - "target": "com.amazonaws.route53#ListCidrBlocks" - }, - { - "target": "com.amazonaws.route53#ListCidrCollections" - }, - { - "target": "com.amazonaws.route53#ListCidrLocations" - }, - { - "target": "com.amazonaws.route53#ListGeoLocations" - }, - { - "target": "com.amazonaws.route53#ListHealthChecks" - }, - { - "target": "com.amazonaws.route53#ListHostedZones" - }, - { - "target": "com.amazonaws.route53#ListHostedZonesByName" - }, - { - "target": "com.amazonaws.route53#ListHostedZonesByVPC" - }, - { - "target": "com.amazonaws.route53#ListQueryLoggingConfigs" - }, - { - "target": "com.amazonaws.route53#ListResourceRecordSets" - }, - { - "target": "com.amazonaws.route53#ListReusableDelegationSets" - }, - { - "target": "com.amazonaws.route53#ListTagsForResource" - }, - { - "target": "com.amazonaws.route53#ListTagsForResources" - }, - { - "target": "com.amazonaws.route53#ListTrafficPolicies" - }, - { - "target": "com.amazonaws.route53#ListTrafficPolicyInstances" - }, - { - "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZone" - }, - { - "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicy" - }, - { - "target": "com.amazonaws.route53#ListTrafficPolicyVersions" - }, - { - "target": "com.amazonaws.route53#ListVPCAssociationAuthorizations" - }, - { - "target": "com.amazonaws.route53#TestDNSAnswer" - }, - { - "target": "com.amazonaws.route53#UpdateHealthCheck" - }, - { - "target": "com.amazonaws.route53#UpdateHostedZoneComment" + "shapes": { + "com.amazonaws.route53#ARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "\\S" + } }, - { - "target": "com.amazonaws.route53#UpdateTrafficPolicyComment" + "com.amazonaws.route53#AWSAccountID": { + "type": "string" }, - { - "target": "com.amazonaws.route53#UpdateTrafficPolicyInstance" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "Route 53", - "arnNamespace": "route53", - "cloudFormationName": "Route53", - "cloudTrailEventSource": "route53.amazonaws.com", - "docId": "route53-2013-04-01", - "endpointPrefix": "route53" - }, - "aws.auth#sigv4": { - "name": "route53" - }, - "aws.protocols#restXml": {}, - "smithy.api#documentation": "

Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web\n\t\t\tservice.

\n

You can use Route 53 to:

\n ", - "smithy.api#title": "Amazon Route 53", - "smithy.api#xmlNamespace": { - "uri": "https://route53.amazonaws.com/doc/2013-04-01/" - }, - "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.route53#AWSDnsV20130401": { + "type": "service", + "version": "2013-04-01", + "operations": [ { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ + "target": "com.amazonaws.route53#ActivateKeySigningKey" + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" + "target": "com.amazonaws.route53#AssociateVPCWithHostedZone" }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "target": "com.amazonaws.route53#ChangeCidrCollection" }, { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ + "target": "com.amazonaws.route53#ChangeResourceRecordSets" + }, { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ + "target": "com.amazonaws.route53#ChangeTagsForResource" + }, { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" + "target": "com.amazonaws.route53#CreateCidrCollection" + }, + { + "target": "com.amazonaws.route53#CreateHealthCheck" + }, + { + "target": "com.amazonaws.route53#CreateHostedZone" + }, + { + "target": "com.amazonaws.route53#CreateKeySigningKey" + }, + { + "target": "com.amazonaws.route53#CreateQueryLoggingConfig" + }, + { + "target": "com.amazonaws.route53#CreateReusableDelegationSet" + }, + { + "target": "com.amazonaws.route53#CreateTrafficPolicy" + }, + { + "target": "com.amazonaws.route53#CreateTrafficPolicyInstance" + }, + { + "target": "com.amazonaws.route53#CreateTrafficPolicyVersion" + }, + { + "target": "com.amazonaws.route53#CreateVPCAssociationAuthorization" + }, + { + "target": "com.amazonaws.route53#DeactivateKeySigningKey" + }, + { + "target": "com.amazonaws.route53#DeleteCidrCollection" + }, + { + "target": "com.amazonaws.route53#DeleteHealthCheck" + }, + { + "target": "com.amazonaws.route53#DeleteHostedZone" + }, + { + "target": "com.amazonaws.route53#DeleteKeySigningKey" + }, + { + "target": "com.amazonaws.route53#DeleteQueryLoggingConfig" + }, + { + "target": "com.amazonaws.route53#DeleteReusableDelegationSet" + }, + { + "target": "com.amazonaws.route53#DeleteTrafficPolicy" + }, + { + "target": "com.amazonaws.route53#DeleteTrafficPolicyInstance" + }, + { + "target": "com.amazonaws.route53#DeleteVPCAssociationAuthorization" + }, + { + "target": "com.amazonaws.route53#DisableHostedZoneDNSSEC" + }, + { + "target": "com.amazonaws.route53#DisassociateVPCFromHostedZone" + }, + { + "target": "com.amazonaws.route53#EnableHostedZoneDNSSEC" + }, + { + "target": "com.amazonaws.route53#GetAccountLimit" + }, + { + "target": "com.amazonaws.route53#GetChange" + }, + { + "target": "com.amazonaws.route53#GetCheckerIpRanges" + }, + { + "target": "com.amazonaws.route53#GetDNSSEC" + }, + { + "target": "com.amazonaws.route53#GetGeoLocation" + }, + { + "target": "com.amazonaws.route53#GetHealthCheck" + }, + { + "target": "com.amazonaws.route53#GetHealthCheckCount" + }, + { + "target": "com.amazonaws.route53#GetHealthCheckLastFailureReason" + }, + { + "target": "com.amazonaws.route53#GetHealthCheckStatus" + }, + { + "target": "com.amazonaws.route53#GetHostedZone" + }, + { + "target": "com.amazonaws.route53#GetHostedZoneCount" + }, + { + "target": "com.amazonaws.route53#GetHostedZoneLimit" + }, + { + "target": "com.amazonaws.route53#GetQueryLoggingConfig" + }, + { + "target": "com.amazonaws.route53#GetReusableDelegationSet" + }, + { + "target": "com.amazonaws.route53#GetReusableDelegationSetLimit" + }, + { + "target": "com.amazonaws.route53#GetTrafficPolicy" + }, + { + "target": "com.amazonaws.route53#GetTrafficPolicyInstance" + }, + { + "target": "com.amazonaws.route53#GetTrafficPolicyInstanceCount" + }, + { + "target": "com.amazonaws.route53#ListCidrBlocks" + }, + { + "target": "com.amazonaws.route53#ListCidrCollections" + }, + { + "target": "com.amazonaws.route53#ListCidrLocations" + }, + { + "target": "com.amazonaws.route53#ListGeoLocations" + }, + { + "target": "com.amazonaws.route53#ListHealthChecks" + }, + { + "target": "com.amazonaws.route53#ListHostedZones" + }, + { + "target": "com.amazonaws.route53#ListHostedZonesByName" + }, + { + "target": "com.amazonaws.route53#ListHostedZonesByVPC" + }, + { + "target": "com.amazonaws.route53#ListQueryLoggingConfigs" + }, + { + "target": "com.amazonaws.route53#ListResourceRecordSets" + }, + { + "target": "com.amazonaws.route53#ListReusableDelegationSets" + }, + { + "target": "com.amazonaws.route53#ListTagsForResource" + }, + { + "target": "com.amazonaws.route53#ListTagsForResources" + }, + { + "target": "com.amazonaws.route53#ListTrafficPolicies" + }, + { + "target": "com.amazonaws.route53#ListTrafficPolicyInstances" + }, + { + "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZone" + }, + { + "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicy" + }, + { + "target": "com.amazonaws.route53#ListTrafficPolicyVersions" + }, + { + "target": "com.amazonaws.route53#ListVPCAssociationAuthorizations" + }, + { + "target": "com.amazonaws.route53#TestDNSAnswer" + }, + { + "target": "com.amazonaws.route53#UpdateHealthCheck" + }, + { + "target": "com.amazonaws.route53#UpdateHostedZoneComment" + }, + { + "target": "com.amazonaws.route53#UpdateTrafficPolicyComment" + }, + { + "target": "com.amazonaws.route53#UpdateTrafficPolicyInstance" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Route 53", + "arnNamespace": "route53", + "cloudFormationName": "Route53", + "cloudTrailEventSource": "route53.amazonaws.com", + "docId": "route53-2013-04-01", + "endpointPrefix": "route53" + }, + "aws.auth#sigv4": { + "name": "route53" + }, + "aws.protocols#restXml": {}, + "smithy.api#documentation": "

Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web\n\t\t\tservice.

\n

You can use Route 53 to:

\n ", + "smithy.api#title": "Amazon Route 53", + "smithy.api#xmlNamespace": { + "uri": "https://route53.amazonaws.com/doc/2013-04-01/" + }, + "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" } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ + }, + "rules": [ { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ + "conditions": [ { - "ref": "PartitionResult" + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" }, - "name" - ] - }, - "aws" - ] + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - false - ] + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://route53.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://route53-fips.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-cn" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://route53.amazonaws.com.cn", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "cn-northwest-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://route53.us-gov.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-gov-west-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://route53.us-gov.amazonaws.com", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-gov-west-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-iso" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://route53.c2s.ic.gov", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-iso-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-iso-b" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://route53.sc2s.sgov.gov", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-isob-east-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-iso-e" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://route53.cloud.adc-e.uk", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "eu-isoe-west-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-iso-f" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://route53.csp.hci.ic.gov", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-isof-south-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route53-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route53-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://route53.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://route53.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - false - ] + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } - ], - "endpoint": { - "url": "https://route53.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-east-1" + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region aws-global with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://route53.amazonaws.com" + } + }, + "params": { + "Region": "aws-global", + "UseFIPS": false, + "UseDualStack": false } - ] }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] + "documentation": "For region aws-global with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://route53-fips.amazonaws.com" + } }, - "aws" - ] + "params": { + "Region": "aws-global", + "UseFIPS": true, + "UseDualStack": false + } }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://route53-fips.us-east-1.api.aws" + } }, - true - ] + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://route53-fips.amazonaws.com" + } }, - false - ] - } - ], - "endpoint": { - "url": "https://route53-fips.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-east-1" + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false } - ] }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://route53.us-east-1.api.aws" + } }, - "aws-cn" - ] + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-east-1" + } + ] + }, + "url": "https://route53.amazonaws.com" + } }, - false - ] + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" + "documentation": "For region aws-cn-global with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "cn-northwest-1" + } + ] + }, + "url": "https://route53.amazonaws.com.cn" + } }, - false - ] - } - ], - "endpoint": { - "url": "https://route53.amazonaws.com.cn", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "cn-northwest-1" + "params": { + "Region": "aws-cn-global", + "UseFIPS": false, + "UseDualStack": false } - ] }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://route53-fips.cn-north-1.api.amazonwebservices.com.cn" + } }, - "aws-us-gov" - ] + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53-fips.cn-north-1.amazonaws.com.cn" + } }, - false - ] + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://route53.cn-north-1.api.amazonwebservices.com.cn" + } }, - false - ] - } - ], - "endpoint": { - "url": "https://route53.us-gov.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-gov-west-1" + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true } - ] }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "cn-northwest-1" + } + ] + }, + "url": "https://route53.amazonaws.com.cn" + } }, - "aws-us-gov" - ] + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "documentation": "For region aws-us-gov-global with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://route53.us-gov.amazonaws.com" + } }, - true - ] + "params": { + "Region": "aws-us-gov-global", + "UseFIPS": false, + "UseDualStack": false + } }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" + "documentation": "For region aws-us-gov-global with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://route53.us-gov.amazonaws.com" + } }, - false - ] - } - ], - "endpoint": { - "url": "https://route53.us-gov.amazonaws.com", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-gov-west-1" + "params": { + "Region": "aws-us-gov-global", + "UseFIPS": true, + "UseDualStack": false } - ] }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://route53-fips.us-gov-east-1.api.aws" + } }, - "aws-iso" - ] + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://route53.us-gov.amazonaws.com" + } }, - false - ] + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://route53.us-gov-east-1.api.aws" + } }, - false - ] - } - ], - "endpoint": { - "url": "https://route53.c2s.ic.gov", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-iso-east-1" + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true } - ] }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-gov-west-1" + } + ] + }, + "url": "https://route53.us-gov.amazonaws.com" + } }, - "aws-iso-b" - ] + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "documentation": "For region aws-iso-global with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-iso-east-1" + } + ] + }, + "url": "https://route53.c2s.ic.gov" + } }, - false - ] + "params": { + "Region": "aws-iso-global", + "UseFIPS": false, + "UseDualStack": false + } }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" + "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" }, - false - ] - } - ], - "endpoint": { - "url": "https://route53.sc2s.sgov.gov", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-isob-east-1" + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true } - ] }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53-fips.us-iso-east-1.c2s.ic.gov" + } }, - "aws-iso-e" - ] + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "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" }, - false - ] + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-iso-east-1" + } + ] + }, + "url": "https://route53.c2s.ic.gov" + } }, - false - ] - } - ], - "endpoint": { - "url": "https://route53.cloud.adc-e.uk", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "eu-isoe-west-1" + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false } - ] }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] + "documentation": "For region aws-iso-b-global with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-isob-east-1" + } + ] + }, + "url": "https://route53.sc2s.sgov.gov" + } }, - "aws-iso-f" - ] + "params": { + "Region": "aws-iso-b-global", + "UseFIPS": false, + "UseDualStack": false + } }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "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" }, - false - ] + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://route53-fips.us-isob-east-1.sc2s.sgov.gov" + } }, - false - ] - } - ], - "endpoint": { - "url": "https://route53.csp.hci.ic.gov", - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-isof-south-1" + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false } - ] }, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "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" }, - true - ] + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-isob-east-1" + } + ] + }, + "url": "https://route53.sc2s.sgov.gov" + } }, - true - ] - } - ], - "rules": [ + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "eu-isoe-west-1" + } + ] }, - "supportsFIPS" - ] + "url": "https://route53.cloud.adc-e.uk" } - ] }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "route53", + "signingRegion": "us-isof-south-1" + } + ] }, - "supportsDualStack" - ] + "url": "https://route53.csp.hci.ic.gov" } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://route53-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": false, + "UseDualStack": false } - ], - "type": "tree" }, { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://route53-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" } - ], - "type": "tree" }, { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } }, - true - ] - } - ], - "rules": [ + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] + "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" } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://route53.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" } - ], - "type": "tree" }, { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://route53.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" + ], + "version": "1.0" } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } - ] }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region aws-global with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-east-1" - } - ] - }, - "url": "https://route53.amazonaws.com" + "com.amazonaws.route53#AWSRegion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 } - }, - "params": { - "Region": "aws-global", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region aws-global with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-east-1" - } - ] - }, - "url": "https://route53-fips.amazonaws.com" + } + }, + "com.amazonaws.route53#AccountLimit": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.route53#AccountLimitType", + "traits": { + "smithy.api#documentation": "

The limit that you requested. Valid values include the following:

\n ", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.route53#LimitValue", + "traits": { + "smithy.api#documentation": "

The current value for the limit that is specified by Type.

", + "smithy.api#required": {} + } } - }, - "params": { - "Region": "aws-global", - "UseFIPS": true, - "UseDualStack": false - } }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://route53-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-east-1" - } - ] - }, - "url": "https://route53-fips.amazonaws.com" + "traits": { + "smithy.api#documentation": "

A complex type that contains the type of limit that you specified in the request and\n\t\t\tthe current value for that limit.

" + } + }, + "com.amazonaws.route53#AccountLimitType": { + "type": "enum", + "members": { + "MAX_HEALTH_CHECKS_BY_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_HEALTH_CHECKS_BY_OWNER" + } + }, + "MAX_HOSTED_ZONES_BY_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_HOSTED_ZONES_BY_OWNER" + } + }, + "MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER" + } + }, + "MAX_REUSABLE_DELEGATION_SETS_BY_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_REUSABLE_DELEGATION_SETS_BY_OWNER" + } + }, + "MAX_TRAFFIC_POLICIES_BY_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_TRAFFIC_POLICIES_BY_OWNER" + } } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } + } + }, + "com.amazonaws.route53#ActivateKeySigningKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ActivateKeySigningKeyRequest" }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://route53.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "output": { + "target": "com.amazonaws.route53#ActivateKeySigningKeyResponse" }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-east-1" - } - ] - }, - "url": "https://route53.amazonaws.com" + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + }, + { + "target": "com.amazonaws.route53#InvalidKMSArn" + }, + { + "target": "com.amazonaws.route53#InvalidSigningStatus" + }, + { + "target": "com.amazonaws.route53#NoSuchKeySigningKey" } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region aws-cn-global with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "cn-northwest-1" - } - ] - }, - "url": "https://route53.amazonaws.com.cn" + ], + "traits": { + "smithy.api#documentation": "

Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This\n\t\t\toperation changes the KSK status to ACTIVE.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/keysigningkey/{HostedZoneId}/{Name}/activate", + "code": 200 + } + } + }, + "com.amazonaws.route53#ActivateKeySigningKeyRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#SigningKeyName", + "traits": { + "smithy.api#documentation": "

A string used to identify a key-signing key (KSK). Name can include\n\t\t\tnumbers, letters, and underscores (_). Name must be unique for each\n\t\t\tkey-signing key in the same hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } - }, - "params": { - "Region": "aws-cn-global", - "UseFIPS": false, - "UseDualStack": false - } }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://route53-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ActivateKeySigningKeyResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#required": {} + } + } }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://route53-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://route53.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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "cn-northwest-1" - } - ] - }, - "url": "https://route53.amazonaws.com.cn" + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#AlarmIdentifier": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.route53#CloudWatchRegion", + "traits": { + "smithy.api#documentation": "

For the CloudWatch alarm that you want Route 53 health checkers to use to determine\n\t\t\twhether this health check is healthy, the region that the alarm was created in.

\n

For the current list of CloudWatch regions, see Amazon CloudWatch endpoints and\n\t\t\t\tquotas in the Amazon Web Services General\n\t\t\tReference.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#AlarmName", + "traits": { + "smithy.api#documentation": "

The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use\n\t\t\tto determine whether this health check is healthy.

\n \n

Route 53 supports CloudWatch alarms with the following features:

\n \n ", + "smithy.api#required": {} + } } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } }, - { - "documentation": "For region aws-us-gov-global with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-gov-west-1" - } - ] - }, - "url": "https://route53.us-gov.amazonaws.com" + "traits": { + "smithy.api#documentation": "

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53\n\t\t\thealth checkers to use to determine whether the specified health check is\n\t\t\thealthy.

" + } + }, + "com.amazonaws.route53#AlarmName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 } - }, - "params": { - "Region": "aws-us-gov-global", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region aws-us-gov-global with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-gov-west-1" - } - ] - }, - "url": "https://route53.us-gov.amazonaws.com" + } + }, + "com.amazonaws.route53#AliasHealthEnabled": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.route53#AliasTarget": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

\n Alias resource records sets only: The value used depends on where\n\t\t\tyou want to route traffic:

\n
\n
Amazon API Gateway custom regional APIs and edge-optimized APIs
\n
\n

Specify the hosted zone ID for your API. You can get the applicable value\n\t\t\t\t\t\tusing the CLI command get-domain-names:

\n
    \n
  • \n

    For regional APIs, specify the value of\n\t\t\t\t\t\t\t\t\tregionalHostedZoneId.

    \n
    • \n
  • \n

    For edge-optimized APIs, specify the value of\n\t\t\t\t\t\t\t\t\tdistributionHostedZoneId.

    \n
    • \n
\n
\n
Amazon Virtual Private Cloud interface VPC endpoint
\n
\n

Specify the hosted zone ID for your interface endpoint. You can get the\n\t\t\t\t\t\tvalue of HostedZoneId using the CLI command\n\t\t\t\t\t\t\tdescribe-vpc-endpoints.

\n
\n
CloudFront distribution
\n
\n

Specify Z2FDTNDATAQYW2.

\n \n

Alias resource record sets for CloudFront can't be created in a\n\t\t\t\t\t\t\tprivate zone.

\n \n
\n
Elastic Beanstalk environment
\n
\n

Specify the hosted zone ID for the region that you created the environment in. The\n\t\t\t\t\t\tenvironment must have a regionalized subdomain. For a list of regions and\n\t\t\t\t\t\tthe corresponding hosted zone IDs, see Elastic Beanstalk\n\t\t\t\t\t\t\tendpoints and quotas in the Amazon Web Services\n\t\t\t\t\t\t\tGeneral Reference.

\n
\n
ELB load balancer
\n
\n

Specify the value of the hosted zone ID for the load balancer. Use the\n\t\t\t\t\t\tfollowing methods to get the hosted zone ID:

\n
    \n
  • \n

    \n Elastic Load Balancing endpoints and quotas topic in\n\t\t\t\t\t\t\t\tthe Amazon Web Services General Reference: Use\n\t\t\t\t\t\t\t\tthe value that corresponds with the region that you created your\n\t\t\t\t\t\t\t\tload balancer in. Note that there are separate columns for\n\t\t\t\t\t\t\t\tApplication and Classic Load Balancers and for Network Load\n\t\t\t\t\t\t\t\tBalancers.

    \n
    • \n
  • \n

    \n Amazon Web Services Management Console: Go to the\n\t\t\t\t\t\t\t\tAmazon EC2 page, choose Load\n\t\t\t\t\t\t\t\t\tBalancers in the navigation pane, select the load\n\t\t\t\t\t\t\t\tbalancer, and get the value of the Hosted\n\t\t\t\t\t\t\t\t\tzone field on the Description tab.

    \n
    • \n
  • \n

    \n Elastic Load Balancing API: Use\n\t\t\t\t\t\t\t\t\tDescribeLoadBalancers to get the applicable value.\n\t\t\t\t\t\t\t\tFor more information, see the applicable guide:

    \n
      \n
    • \n

      Classic Load Balancers: Use DescribeLoadBalancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneNameId.

      \n
      • \n
    • \n

      Application and Network Load Balancers: Use DescribeLoadBalancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneId.

      \n
      • \n
    \n
    • \n
  • \n

    \n CLI: Use\n\t\t\t\t\t\t\t\t\tdescribe-load-balancers to get the applicable\n\t\t\t\t\t\t\t\tvalue. For more information, see the applicable guide:

    \n
      \n
    • \n

      Classic Load Balancers: Use describe-load-balancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneNameId.

      \n
      • \n
    • \n

      Application and Network Load Balancers: Use describe-load-balancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneId.

      \n
      • \n
    \n
    • \n
\n
\n
Global Accelerator accelerator
\n
\n

Specify Z2BJ6XQ5FK7U4H.

\n
\n
An Amazon S3 bucket configured as a static website
\n
\n

Specify the hosted zone ID for the region that you created the bucket in.\n\t\t\t\t\t\tFor more information about valid values, see the table Amazon S3\n\t\t\t\t\t\t\tWebsite Endpoints in the Amazon Web Services General\n\t\t\t\t\t\t\tReference.

\n
\n
Another Route 53 resource record set in your hosted zone
\n
\n

Specify the hosted zone ID of your hosted zone. (An alias resource record\n\t\t\t\t\t\tset can't reference a resource record set in a different hosted\n\t\t\t\t\t\tzone.)

\n
\n
", + "smithy.api#required": {} + } + }, + "DNSName": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

\n Alias resource record sets only: The value that you specify\n\t\t\tdepends on where you want to route queries:

\n
\n
Amazon API Gateway custom regional APIs and edge-optimized APIs
\n
\n

Specify the applicable domain name for your API. You can get the\n\t\t\t\t\t\tapplicable value using the CLI command get-domain-names:

\n
    \n
  • \n

    For regional APIs, specify the value of\n\t\t\t\t\t\t\t\t\tregionalDomainName.

    \n
    • \n
  • \n

    For edge-optimized APIs, specify the value of\n\t\t\t\t\t\t\t\t\tdistributionDomainName. This is the name of the\n\t\t\t\t\t\t\t\tassociated CloudFront distribution, such as\n\t\t\t\t\t\t\t\t\tda1b2c3d4e5.cloudfront.net.

    \n
    • \n
\n \n

The name of the record that you're creating must match a custom domain\n\t\t\t\t\t\t\tname for your API, such as api.example.com.

\n \n
\n
Amazon Virtual Private Cloud interface VPC endpoint
\n
\n

Enter the API endpoint for the interface endpoint, such as\n\t\t\t\t\t\t\tvpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com.\n\t\t\t\t\t\tFor edge-optimized APIs, this is the domain name for the corresponding\n\t\t\t\t\t\tCloudFront distribution. You can get the value of DnsName using\n\t\t\t\t\t\tthe CLI command describe-vpc-endpoints.

\n
\n
CloudFront distribution
\n
\n

Specify the domain name that CloudFront assigned when you created your\n\t\t\t\t\t\tdistribution.

\n

Your CloudFront distribution must include an alternate domain name that\n\t\t\t\t\t\tmatches the name of the resource record set. For example, if the name of the\n\t\t\t\t\t\tresource record set is acme.example.com, your\n\t\t\t\t\t\tCloudFront distribution must include acme.example.com\n\t\t\t\t\t\tas one of the alternate domain names. For more information, see Using Alternate\n\t\t\t\t\t\t\tDomain Names (CNAMEs) in the Amazon CloudFront\n\t\t\t\t\t\t\tDeveloper Guide.

\n

You can't create a resource record set in a private hosted zone to route\n\t\t\t\t\t\ttraffic to a CloudFront distribution.

\n \n

For failover alias records, you can't specify a CloudFront\n\t\t\t\t\t\t\tdistribution for both the primary and secondary records. A distribution\n\t\t\t\t\t\t\tmust include an alternate domain name that matches the name of the\n\t\t\t\t\t\t\trecord. However, the primary and secondary records have the same name,\n\t\t\t\t\t\t\tand you can't include the same alternate domain name in more than one\n\t\t\t\t\t\t\tdistribution.

\n \n
\n
Elastic Beanstalk environment
\n
\n

If the domain name for your Elastic Beanstalk environment includes the\n\t\t\t\t\t\tregion that you deployed the environment in, you can create an alias record\n\t\t\t\t\t\tthat routes traffic to the environment. For example, the domain name\n\t\t\t\t\t\t\t\tmy-environment.us-west-2.elasticbeanstalk.com\n\t\t\t\t\t\tis a regionalized domain name.

\n \n

For environments that were created before early 2016, the domain name\n\t\t\t\t\t\t\tdoesn't include the region. To route traffic to these environments, you\n\t\t\t\t\t\t\tmust create a CNAME record instead of an alias record. Note that you\n\t\t\t\t\t\t\tcan't create a CNAME record for the root domain name. For example, if\n\t\t\t\t\t\t\tyour domain name is example.com, you can create a record that routes\n\t\t\t\t\t\t\ttraffic for acme.example.com to your Elastic Beanstalk environment, but\n\t\t\t\t\t\t\tyou can't create a record that routes traffic for example.com to your\n\t\t\t\t\t\t\tElastic Beanstalk environment.

\n \n

For Elastic Beanstalk environments that have regionalized subdomains,\n\t\t\t\t\t\tspecify the CNAME attribute for the environment. You can use\n\t\t\t\t\t\tthe following methods to get the value of the CNAME attribute:

\n
    \n
  • \n

    \n Amazon Web Services Management Console: For information about\n\t\t\t\t\t\t\t\thow to get the value by using the console, see Using Custom\n\t\t\t\t\t\t\t\t\tDomains with Elastic Beanstalk in the\n\t\t\t\t\t\t\t\t\t\tElastic Beanstalk Developer\n\t\t\t\t\t\t\t\tGuide.

    \n
    • \n
  • \n

    \n Elastic Beanstalk API: Use the\n\t\t\t\t\t\t\t\t\tDescribeEnvironments action to get the value of the\n\t\t\t\t\t\t\t\t\tCNAME attribute. For more information, see DescribeEnvironments in the Elastic Beanstalk API Reference.

    \n
    • \n
  • \n

    \n CLI: Use the\n\t\t\t\t\t\t\t\t\tdescribe-environments command to get the value of\n\t\t\t\t\t\t\t\tthe CNAME attribute. For more information, see describe-environments in the CLI Command Reference.

    \n
    • \n
\n
\n
ELB load balancer
\n
\n

Specify the DNS name that is associated with the load balancer. Get the\n\t\t\t\t\t\tDNS name by using the Amazon Web Services Management Console, the ELB API, or the CLI.

\n
    \n
  • \n

    \n Amazon Web Services Management Console: Go to the\n\t\t\t\t\t\t\t\tEC2 page, choose Load Balancers in\n\t\t\t\t\t\t\t\tthe navigation pane, choose the load balancer, choose the Description tab, and get the value of the\n\t\t\t\t\t\t\t\t\tDNS name field.

    \n

    If you're routing traffic to a Classic Load Balancer, get the\n\t\t\t\t\t\t\t\tvalue that begins with dualstack.\n\t\t\t\t\t\t\t\tIf you're routing traffic to another type of load balancer, get the\n\t\t\t\t\t\t\t\tvalue that applies to the record type, A or AAAA.

    \n
    • \n
  • \n

    \n Elastic Load Balancing API: Use\n\t\t\t\t\t\t\t\t\tDescribeLoadBalancers to get the value of\n\t\t\t\t\t\t\t\t\tDNSName. For more information, see the applicable\n\t\t\t\t\t\t\t\tguide:

    \n \n
    • \n
  • \n

    \n CLI: Use\n\t\t\t\t\t\t\t\t\tdescribe-load-balancers to get the value of\n\t\t\t\t\t\t\t\t\tDNSName. For more information, see the applicable\n\t\t\t\t\t\t\t\tguide:

    \n \n
    • \n
\n
\n
Global Accelerator accelerator
\n
\n

Specify the DNS name for your accelerator:

\n \n
\n
Amazon S3 bucket that is configured as a static website
\n
\n

Specify the domain name of the Amazon S3 website endpoint that you created\n\t\t\t\t\t\tthe bucket in, for example, s3-website.us-east-2.amazonaws.com.\n\t\t\t\t\t\tFor more information about valid values, see the table Amazon S3\n\t\t\t\t\t\t\tWebsite Endpoints in the Amazon Web Services General\n\t\t\t\t\t\t\tReference. For more information about using S3 buckets for\n\t\t\t\t\t\twebsites, see Getting Started\n\t\t\t\t\t\t\twith Amazon Route 53 in the Amazon Route 53 Developer\n\t\t\t\t\t\t\tGuide.\n

\n
\n
Another Route 53 resource record set
\n
\n

Specify the value of the Name element for a resource record\n\t\t\t\t\t\tset in the current hosted zone.

\n \n

If you're creating an alias record that has the same name as the\n\t\t\t\t\t\t\thosted zone (known as the zone apex), you can't specify the domain name\n\t\t\t\t\t\t\tfor a record for which the value of Type is\n\t\t\t\t\t\t\t\tCNAME. This is because the alias record must have the\n\t\t\t\t\t\t\tsame type as the record that you're routing traffic to, and creating a\n\t\t\t\t\t\t\tCNAME record for the zone apex isn't supported even for an alias\n\t\t\t\t\t\t\trecord.

\n \n
\n
", + "smithy.api#required": {} + } + }, + "EvaluateTargetHealth": { + "target": "com.amazonaws.route53#AliasHealthEnabled", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

\n Applies only to alias, failover alias, geolocation alias, latency alias, and\n\t\t\t\tweighted alias resource record sets: When\n\t\t\t\tEvaluateTargetHealth is true, an alias resource record set\n\t\t\tinherits the health of the referenced Amazon Web Services resource, such as an ELB load\n\t\t\tbalancer or another resource record set in the hosted zone.

\n

Note the following:

\n
\n
CloudFront distributions
\n
\n

You can't set EvaluateTargetHealth to true when\n\t\t\t\t\t\tthe alias target is a CloudFront distribution.

\n
\n
Elastic Beanstalk environments that have regionalized subdomains
\n
\n

If you specify an Elastic Beanstalk environment in DNSName\n\t\t\t\t\t\tand the environment contains an ELB load balancer, Elastic Load Balancing\n\t\t\t\t\t\troutes queries only to the healthy Amazon EC2 instances that are registered\n\t\t\t\t\t\twith the load balancer. (An environment automatically contains an ELB load\n\t\t\t\t\t\tbalancer if it includes more than one Amazon EC2 instance.) If you set\n\t\t\t\t\t\t\tEvaluateTargetHealth to true and either no\n\t\t\t\t\t\tAmazon EC2 instances are healthy or the load balancer itself is unhealthy,\n\t\t\t\t\t\tRoute 53 routes queries to other available resources that are healthy, if\n\t\t\t\t\t\tany.

\n

If the environment contains a single Amazon EC2 instance, there are no\n\t\t\t\t\t\tspecial requirements.

\n
\n
ELB load balancers
\n
\n

Health checking behavior depends on the type of load balancer:

\n
    \n
  • \n

    \n Classic Load Balancers: If you\n\t\t\t\t\t\t\t\tspecify an ELB Classic Load Balancer in DNSName,\n\t\t\t\t\t\t\t\tElastic Load Balancing routes queries only to the healthy Amazon EC2\n\t\t\t\t\t\t\t\tinstances that are registered with the load balancer. If you set\n\t\t\t\t\t\t\t\t\tEvaluateTargetHealth to true and\n\t\t\t\t\t\t\t\teither no EC2 instances are healthy or the load balancer itself is\n\t\t\t\t\t\t\t\tunhealthy, Route 53 routes queries to other resources.

    \n
    • \n
  • \n

    \n Application and Network Load\n\t\t\t\t\t\t\t\t\tBalancers: If you specify an ELB Application or\n\t\t\t\t\t\t\t\tNetwork Load Balancer and you set EvaluateTargetHealth\n\t\t\t\t\t\t\t\tto true, Route 53 routes queries to the load balancer\n\t\t\t\t\t\t\t\tbased on the health of the target groups that are associated with\n\t\t\t\t\t\t\t\tthe load balancer:

    \n
      \n
    • \n

      For an Application or Network Load Balancer to be\n\t\t\t\t\t\t\t\t\t\tconsidered healthy, every target group that contains targets\n\t\t\t\t\t\t\t\t\t\tmust contain at least one healthy target. If any target\n\t\t\t\t\t\t\t\t\t\tgroup contains only unhealthy targets, the load balancer is\n\t\t\t\t\t\t\t\t\t\tconsidered unhealthy, and Route 53 routes queries to other\n\t\t\t\t\t\t\t\t\t\tresources.

      \n
      • \n
    • \n

      A target group that has no registered targets is\n\t\t\t\t\t\t\t\t\t\tconsidered unhealthy.

      \n
      • \n
    \n
    • \n
\n \n

When you create a load balancer, you configure settings for Elastic\n\t\t\t\t\t\t\tLoad Balancing health checks; they're not Route 53 health checks, but\n\t\t\t\t\t\t\tthey perform a similar function. Do not create Route 53 health checks\n\t\t\t\t\t\t\tfor the EC2 instances that you register with an ELB load balancer.\n\t\t\t\t\t\t

\n \n
\n
S3 buckets
\n
\n

There are no special requirements for setting\n\t\t\t\t\t\t\tEvaluateTargetHealth to true when the alias\n\t\t\t\t\t\ttarget is an S3 bucket.

\n
\n
Other records in the same hosted zone
\n
\n

If the Amazon Web Services resource that you specify in\n\t\t\t\t\t\t\tDNSName is a record or a group of records (for example, a\n\t\t\t\t\t\tgroup of weighted records) but is not another alias record, we recommend\n\t\t\t\t\t\tthat you associate a health check with all of the records in the alias\n\t\t\t\t\t\ttarget. For more information, see What Happens When You Omit Health Checks? in the\n\t\t\t\t\t\t\tAmazon Route 53 Developer Guide.

\n
\n
\n

For more information and examples, see Amazon Route 53 Health Checks\n\t\t\t\tand DNS Failover in the Amazon Route 53 Developer\n\t\t\tGuide.

", + "smithy.api#required": {} + } } - }, - "params": { - "Region": "aws-us-gov-global", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://route53-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-gov-west-1" - } - ] - }, - "url": "https://route53.us-gov.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#documentation": "

\n Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that\n\t\t\tyou want to route traffic to.

\n

When creating resource record sets for a private hosted zone, note the\n\t\t\tfollowing:

\n " + } + }, + "com.amazonaws.route53#AssociateVPCComment": { + "type": "string" + }, + "com.amazonaws.route53#AssociateVPCWithHostedZone": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#AssociateVPCWithHostedZoneRequest" }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://route53.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "output": { + "target": "com.amazonaws.route53#AssociateVPCWithHostedZoneResponse" }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-gov-west-1" - } - ] - }, - "url": "https://route53.us-gov.amazonaws.com" + "errors": [ + { + "target": "com.amazonaws.route53#ConflictingDomainExists" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidVPCId" + }, + { + "target": "com.amazonaws.route53#LimitsExceeded" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#NotAuthorizedException" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" + }, + { + "target": "com.amazonaws.route53#PublicZoneVPCAssociation" } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region aws-iso-global with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-iso-east-1" - } - ] - }, - "url": "https://route53.c2s.ic.gov" + ], + "traits": { + "smithy.api#documentation": "

Associates an Amazon VPC with a private hosted zone.

\n \n

To perform the association, the VPC and the private hosted zone must already\n\t\t\t\texist. You can't convert a public hosted zone into a private hosted zone.

\n \n \n

If you want to associate a VPC that was created by using one Amazon Web Services account with a private hosted zone that was created by using a\n\t\t\t\tdifferent account, the Amazon Web Services account that created the private hosted\n\t\t\t\tzone must first submit a CreateVPCAssociationAuthorization request.\n\t\t\t\tThen the account that created the VPC must submit an\n\t\t\t\t\tAssociateVPCWithHostedZone request.

\n \n \n

When granting access, the hosted zone and the Amazon VPC must belong to\n\t\t\t\tthe same partition. A partition is a group of Amazon Web Services Regions. Each\n\t\t\t\t\tAmazon Web Services account is scoped to one partition.

\n

The following are the supported partitions:

\n \n

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

\n ", + "smithy.api#examples": [ + { + "title": "To associate a VPC with a hosted zone", + "documentation": "The following example associates the VPC with ID vpc-1a2b3c4d with the hosted zone with ID Z3M3LMPEXAMPLE.", + "input": { + "HostedZoneId": "Z3M3LMPEXAMPLE", + "VPC": { + "VPCId": "vpc-1a2b3c4d", + "VPCRegion": "us-east-2" + }, + "Comment": "" + }, + "output": { + "ChangeInfo": { + "Status": "INSYNC", + "Comment": "", + "SubmittedAt": "2017-01-31T01:36:41.958Z", + "Id": "/change/C3HC6WDB2UANE2" + } + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/associatevpc", + "code": 200 } - }, - "params": { - "Region": "aws-iso-global", - "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://route53-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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-iso-east-1" - } - ] - }, - "url": "https://route53.c2s.ic.gov" + } + }, + "com.amazonaws.route53#AssociateVPCWithHostedZoneRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the private hosted zone that you want to associate an Amazon VPC\n\t\t\twith.

\n

Note that you can't associate a VPC with a hosted zone that doesn't have an existing\n\t\t\tVPC association.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPC": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the VPC that you want to associate with\n\t\t\ta private hosted zone.

", + "smithy.api#required": {} + } + }, + "Comment": { + "target": "com.amazonaws.route53#AssociateVPCComment", + "traits": { + "smithy.api#documentation": "

\n Optional: A comment about the association request.

" + } } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } }, - { - "documentation": "For region aws-iso-b-global with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-isob-east-1" - } - ] - }, - "url": "https://route53.sc2s.sgov.gov" + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the request to associate a VPC with a\n\t\t\tprivate hosted zone.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#AssociateVPCWithHostedZoneResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#documentation": "

A complex type that describes the changes made to your hosted zone.

", + "smithy.api#required": {} + } } - }, - "params": { - "Region": "aws-iso-b-global", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://route53-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "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": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-isob-east-1" - } - ] - }, - "url": "https://route53.sc2s.sgov.gov" + "traits": { + "smithy.api#documentation": "

A complex type that contains the response information for the\n\t\t\t\tAssociateVPCWithHostedZone request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#Bias": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": -99, + "max": 99 } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "eu-isoe-west-1" - } - ] - }, - "url": "https://route53.cloud.adc-e.uk" + } + }, + "com.amazonaws.route53#Change": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.route53#ChangeAction", + "traits": { + "smithy.api#documentation": "

The action to perform:

\n ", + "smithy.api#required": {} + } + }, + "ResourceRecordSet": { + "target": "com.amazonaws.route53#ResourceRecordSet", + "traits": { + "smithy.api#documentation": "

Information about the resource record set to create, delete, or update.

", + "smithy.api#required": {} + } } - }, - "params": { - "Region": "eu-isoe-west-1", - "UseFIPS": false, - "UseDualStack": false - } }, - { - "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-isof-south-1" - } - ] - }, - "url": "https://route53.csp.hci.ic.gov" + "traits": { + "smithy.api#documentation": "

The information for each resource record set that you want to change.

" + } + }, + "com.amazonaws.route53#ChangeAction": { + "type": "enum", + "members": { + "CREATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + }, + "UPSERT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPSERT" + } } - }, - "params": { - "Region": "us-isof-south-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.route53#AWSRegion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#AccountLimit": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.route53#AccountLimitType", - "traits": { - "smithy.api#documentation": "

The limit that you requested. Valid values include the following:

\n ", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.route53#LimitValue", - "traits": { - "smithy.api#documentation": "

The current value for the limit that is specified by Type.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the type of limit that you specified in the request and\n\t\t\tthe current value for that limit.

" - } - }, - "com.amazonaws.route53#AccountLimitType": { - "type": "enum", - "members": { - "MAX_HEALTH_CHECKS_BY_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_HEALTH_CHECKS_BY_OWNER" - } - }, - "MAX_HOSTED_ZONES_BY_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_HOSTED_ZONES_BY_OWNER" - } - }, - "MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER" - } - }, - "MAX_REUSABLE_DELEGATION_SETS_BY_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_REUSABLE_DELEGATION_SETS_BY_OWNER" - } - }, - "MAX_TRAFFIC_POLICIES_BY_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_TRAFFIC_POLICIES_BY_OWNER" - } - } - } - }, - "com.amazonaws.route53#ActivateKeySigningKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ActivateKeySigningKeyRequest" - }, - "output": { - "target": "com.amazonaws.route53#ActivateKeySigningKeyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" - }, - { - "target": "com.amazonaws.route53#InvalidKMSArn" - }, - { - "target": "com.amazonaws.route53#InvalidSigningStatus" - }, - { - "target": "com.amazonaws.route53#NoSuchKeySigningKey" - } - ], - "traits": { - "smithy.api#documentation": "

Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This\n\t\t\toperation changes the KSK status to ACTIVE.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/keysigningkey/{HostedZoneId}/{Name}/activate", - "code": 200 - } - } - }, - "com.amazonaws.route53#ActivateKeySigningKeyRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.route53#SigningKeyName", - "traits": { - "smithy.api#documentation": "

A string used to identify a key-signing key (KSK). Name can include\n\t\t\tnumbers, letters, and underscores (_). Name must be unique for each\n\t\t\tkey-signing key in the same hosted zone.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ActivateKeySigningKeyResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#AlarmIdentifier": { - "type": "structure", - "members": { - "Region": { - "target": "com.amazonaws.route53#CloudWatchRegion", - "traits": { - "smithy.api#documentation": "

For the CloudWatch alarm that you want Route 53 health checkers to use to determine\n\t\t\twhether this health check is healthy, the region that the alarm was created in.

\n

For the current list of CloudWatch regions, see Amazon CloudWatch endpoints and\n\t\t\t\tquotas in the Amazon Web Services General\n\t\t\tReference.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.route53#AlarmName", - "traits": { - "smithy.api#documentation": "

The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use\n\t\t\tto determine whether this health check is healthy.

\n \n

Route 53 supports CloudWatch alarms with the following features:

\n \n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53\n\t\t\thealth checkers to use to determine whether the specified health check is\n\t\t\thealthy.

" - } - }, - "com.amazonaws.route53#AlarmName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.route53#AliasHealthEnabled": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.route53#AliasTarget": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

\n Alias resource records sets only: The value used depends on where\n\t\t\tyou want to route traffic:

\n
\n
Amazon API Gateway custom regional APIs and edge-optimized APIs
\n
\n

Specify the hosted zone ID for your API. You can get the applicable value\n\t\t\t\t\t\tusing the CLI command get-domain-names:

\n
    \n
  • \n

    For regional APIs, specify the value of\n\t\t\t\t\t\t\t\t\tregionalHostedZoneId.

    \n
    • \n
  • \n

    For edge-optimized APIs, specify the value of\n\t\t\t\t\t\t\t\t\tdistributionHostedZoneId.

    \n
    • \n
\n
\n
Amazon Virtual Private Cloud interface VPC endpoint
\n
\n

Specify the hosted zone ID for your interface endpoint. You can get the\n\t\t\t\t\t\tvalue of HostedZoneId using the CLI command\n\t\t\t\t\t\t\tdescribe-vpc-endpoints.

\n
\n
CloudFront distribution
\n
\n

Specify Z2FDTNDATAQYW2.

\n \n

Alias resource record sets for CloudFront can't be created in a\n\t\t\t\t\t\t\tprivate zone.

\n \n
\n
Elastic Beanstalk environment
\n
\n

Specify the hosted zone ID for the region that you created the environment in. The\n\t\t\t\t\t\tenvironment must have a regionalized subdomain. For a list of regions and\n\t\t\t\t\t\tthe corresponding hosted zone IDs, see Elastic Beanstalk\n\t\t\t\t\t\t\tendpoints and quotas in the Amazon Web Services\n\t\t\t\t\t\t\tGeneral Reference.

\n
\n
ELB load balancer
\n
\n

Specify the value of the hosted zone ID for the load balancer. Use the\n\t\t\t\t\t\tfollowing methods to get the hosted zone ID:

\n
    \n
  • \n

    \n Elastic Load Balancing endpoints and quotas topic in\n\t\t\t\t\t\t\t\tthe Amazon Web Services General Reference: Use\n\t\t\t\t\t\t\t\tthe value that corresponds with the region that you created your\n\t\t\t\t\t\t\t\tload balancer in. Note that there are separate columns for\n\t\t\t\t\t\t\t\tApplication and Classic Load Balancers and for Network Load\n\t\t\t\t\t\t\t\tBalancers.

    \n
    • \n
  • \n

    \n Amazon Web Services Management Console: Go to the\n\t\t\t\t\t\t\t\tAmazon EC2 page, choose Load\n\t\t\t\t\t\t\t\t\tBalancers in the navigation pane, select the load\n\t\t\t\t\t\t\t\tbalancer, and get the value of the Hosted\n\t\t\t\t\t\t\t\t\tzone field on the Description tab.

    \n
    • \n
  • \n

    \n Elastic Load Balancing API: Use\n\t\t\t\t\t\t\t\t\tDescribeLoadBalancers to get the applicable value.\n\t\t\t\t\t\t\t\tFor more information, see the applicable guide:

    \n
      \n
    • \n

      Classic Load Balancers: Use DescribeLoadBalancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneNameId.

      \n
      • \n
    • \n

      Application and Network Load Balancers: Use DescribeLoadBalancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneId.

      \n
      • \n
    \n
    • \n
  • \n

    \n CLI: Use\n\t\t\t\t\t\t\t\t\tdescribe-load-balancers to get the applicable\n\t\t\t\t\t\t\t\tvalue. For more information, see the applicable guide:

    \n
      \n
    • \n

      Classic Load Balancers: Use describe-load-balancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneNameId.

      \n
      • \n
    • \n

      Application and Network Load Balancers: Use describe-load-balancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneId.

      \n
      • \n
    \n
    • \n
\n
\n
Global Accelerator accelerator
\n
\n

Specify Z2BJ6XQ5FK7U4H.

\n
\n
An Amazon S3 bucket configured as a static website
\n
\n

Specify the hosted zone ID for the region that you created the bucket in.\n\t\t\t\t\t\tFor more information about valid values, see the table Amazon S3\n\t\t\t\t\t\t\tWebsite Endpoints in the Amazon Web Services General\n\t\t\t\t\t\t\tReference.

\n
\n
Another Route 53 resource record set in your hosted zone
\n
\n

Specify the hosted zone ID of your hosted zone. (An alias resource record\n\t\t\t\t\t\tset can't reference a resource record set in a different hosted\n\t\t\t\t\t\tzone.)

\n
\n
", - "smithy.api#required": {} - } - }, - "DNSName": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

\n Alias resource record sets only: The value that you specify\n\t\t\tdepends on where you want to route queries:

\n
\n
Amazon API Gateway custom regional APIs and edge-optimized APIs
\n
\n

Specify the applicable domain name for your API. You can get the\n\t\t\t\t\t\tapplicable value using the CLI command get-domain-names:

\n
    \n
  • \n

    For regional APIs, specify the value of\n\t\t\t\t\t\t\t\t\tregionalDomainName.

    \n
    • \n
  • \n

    For edge-optimized APIs, specify the value of\n\t\t\t\t\t\t\t\t\tdistributionDomainName. This is the name of the\n\t\t\t\t\t\t\t\tassociated CloudFront distribution, such as\n\t\t\t\t\t\t\t\t\tda1b2c3d4e5.cloudfront.net.

    \n
    • \n
\n \n

The name of the record that you're creating must match a custom domain\n\t\t\t\t\t\t\tname for your API, such as api.example.com.

\n \n
\n
Amazon Virtual Private Cloud interface VPC endpoint
\n
\n

Enter the API endpoint for the interface endpoint, such as\n\t\t\t\t\t\t\tvpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com.\n\t\t\t\t\t\tFor edge-optimized APIs, this is the domain name for the corresponding\n\t\t\t\t\t\tCloudFront distribution. You can get the value of DnsName using\n\t\t\t\t\t\tthe CLI command describe-vpc-endpoints.

\n
\n
CloudFront distribution
\n
\n

Specify the domain name that CloudFront assigned when you created your\n\t\t\t\t\t\tdistribution.

\n

Your CloudFront distribution must include an alternate domain name that\n\t\t\t\t\t\tmatches the name of the resource record set. For example, if the name of the\n\t\t\t\t\t\tresource record set is acme.example.com, your\n\t\t\t\t\t\tCloudFront distribution must include acme.example.com\n\t\t\t\t\t\tas one of the alternate domain names. For more information, see Using Alternate\n\t\t\t\t\t\t\tDomain Names (CNAMEs) in the Amazon CloudFront\n\t\t\t\t\t\t\tDeveloper Guide.

\n

You can't create a resource record set in a private hosted zone to route\n\t\t\t\t\t\ttraffic to a CloudFront distribution.

\n \n

For failover alias records, you can't specify a CloudFront\n\t\t\t\t\t\t\tdistribution for both the primary and secondary records. A distribution\n\t\t\t\t\t\t\tmust include an alternate domain name that matches the name of the\n\t\t\t\t\t\t\trecord. However, the primary and secondary records have the same name,\n\t\t\t\t\t\t\tand you can't include the same alternate domain name in more than one\n\t\t\t\t\t\t\tdistribution.

\n \n
\n
Elastic Beanstalk environment
\n
\n

If the domain name for your Elastic Beanstalk environment includes the\n\t\t\t\t\t\tregion that you deployed the environment in, you can create an alias record\n\t\t\t\t\t\tthat routes traffic to the environment. For example, the domain name\n\t\t\t\t\t\t\t\tmy-environment.us-west-2.elasticbeanstalk.com\n\t\t\t\t\t\tis a regionalized domain name.

\n \n

For environments that were created before early 2016, the domain name\n\t\t\t\t\t\t\tdoesn't include the region. To route traffic to these environments, you\n\t\t\t\t\t\t\tmust create a CNAME record instead of an alias record. Note that you\n\t\t\t\t\t\t\tcan't create a CNAME record for the root domain name. For example, if\n\t\t\t\t\t\t\tyour domain name is example.com, you can create a record that routes\n\t\t\t\t\t\t\ttraffic for acme.example.com to your Elastic Beanstalk environment, but\n\t\t\t\t\t\t\tyou can't create a record that routes traffic for example.com to your\n\t\t\t\t\t\t\tElastic Beanstalk environment.

\n \n

For Elastic Beanstalk environments that have regionalized subdomains,\n\t\t\t\t\t\tspecify the CNAME attribute for the environment. You can use\n\t\t\t\t\t\tthe following methods to get the value of the CNAME attribute:

\n
    \n
  • \n

    \n Amazon Web Services Management Console: For information about\n\t\t\t\t\t\t\t\thow to get the value by using the console, see Using Custom\n\t\t\t\t\t\t\t\t\tDomains with Elastic Beanstalk in the\n\t\t\t\t\t\t\t\t\t\tElastic Beanstalk Developer\n\t\t\t\t\t\t\t\tGuide.

    \n
    • \n
  • \n

    \n Elastic Beanstalk API: Use the\n\t\t\t\t\t\t\t\t\tDescribeEnvironments action to get the value of the\n\t\t\t\t\t\t\t\t\tCNAME attribute. For more information, see DescribeEnvironments in the Elastic Beanstalk API Reference.

    \n
    • \n
  • \n

    \n CLI: Use the\n\t\t\t\t\t\t\t\t\tdescribe-environments command to get the value of\n\t\t\t\t\t\t\t\tthe CNAME attribute. For more information, see describe-environments in the CLI Command Reference.

    \n
    • \n
\n
\n
ELB load balancer
\n
\n

Specify the DNS name that is associated with the load balancer. Get the\n\t\t\t\t\t\tDNS name by using the Amazon Web Services Management Console, the ELB API, or the CLI.

\n
    \n
  • \n

    \n Amazon Web Services Management Console: Go to the\n\t\t\t\t\t\t\t\tEC2 page, choose Load Balancers in\n\t\t\t\t\t\t\t\tthe navigation pane, choose the load balancer, choose the Description tab, and get the value of the\n\t\t\t\t\t\t\t\t\tDNS name field.

    \n

    If you're routing traffic to a Classic Load Balancer, get the\n\t\t\t\t\t\t\t\tvalue that begins with dualstack.\n\t\t\t\t\t\t\t\tIf you're routing traffic to another type of load balancer, get the\n\t\t\t\t\t\t\t\tvalue that applies to the record type, A or AAAA.

    \n
    • \n
  • \n

    \n Elastic Load Balancing API: Use\n\t\t\t\t\t\t\t\t\tDescribeLoadBalancers to get the value of\n\t\t\t\t\t\t\t\t\tDNSName. For more information, see the applicable\n\t\t\t\t\t\t\t\tguide:

    \n \n
    • \n
  • \n

    \n CLI: Use\n\t\t\t\t\t\t\t\t\tdescribe-load-balancers to get the value of\n\t\t\t\t\t\t\t\t\tDNSName. For more information, see the applicable\n\t\t\t\t\t\t\t\tguide:

    \n \n
    • \n
\n
\n
Global Accelerator accelerator
\n
\n

Specify the DNS name for your accelerator:

\n \n
\n
Amazon S3 bucket that is configured as a static website
\n
\n

Specify the domain name of the Amazon S3 website endpoint that you created\n\t\t\t\t\t\tthe bucket in, for example, s3-website.us-east-2.amazonaws.com.\n\t\t\t\t\t\tFor more information about valid values, see the table Amazon S3\n\t\t\t\t\t\t\tWebsite Endpoints in the Amazon Web Services General\n\t\t\t\t\t\t\tReference. For more information about using S3 buckets for\n\t\t\t\t\t\twebsites, see Getting Started\n\t\t\t\t\t\t\twith Amazon Route 53 in the Amazon Route 53 Developer\n\t\t\t\t\t\t\tGuide.\n

\n
\n
Another Route 53 resource record set
\n
\n

Specify the value of the Name element for a resource record\n\t\t\t\t\t\tset in the current hosted zone.

\n \n

If you're creating an alias record that has the same name as the\n\t\t\t\t\t\t\thosted zone (known as the zone apex), you can't specify the domain name\n\t\t\t\t\t\t\tfor a record for which the value of Type is\n\t\t\t\t\t\t\t\tCNAME. This is because the alias record must have the\n\t\t\t\t\t\t\tsame type as the record that you're routing traffic to, and creating a\n\t\t\t\t\t\t\tCNAME record for the zone apex isn't supported even for an alias\n\t\t\t\t\t\t\trecord.

\n \n
\n
", - "smithy.api#required": {} - } - }, - "EvaluateTargetHealth": { - "target": "com.amazonaws.route53#AliasHealthEnabled", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n Applies only to alias, failover alias, geolocation alias, latency alias, and\n\t\t\t\tweighted alias resource record sets: When\n\t\t\t\tEvaluateTargetHealth is true, an alias resource record set\n\t\t\tinherits the health of the referenced Amazon Web Services resource, such as an ELB load\n\t\t\tbalancer or another resource record set in the hosted zone.

\n

Note the following:

\n
\n
CloudFront distributions
\n
\n

You can't set EvaluateTargetHealth to true when\n\t\t\t\t\t\tthe alias target is a CloudFront distribution.

\n
\n
Elastic Beanstalk environments that have regionalized subdomains
\n
\n

If you specify an Elastic Beanstalk environment in DNSName\n\t\t\t\t\t\tand the environment contains an ELB load balancer, Elastic Load Balancing\n\t\t\t\t\t\troutes queries only to the healthy Amazon EC2 instances that are registered\n\t\t\t\t\t\twith the load balancer. (An environment automatically contains an ELB load\n\t\t\t\t\t\tbalancer if it includes more than one Amazon EC2 instance.) If you set\n\t\t\t\t\t\t\tEvaluateTargetHealth to true and either no\n\t\t\t\t\t\tAmazon EC2 instances are healthy or the load balancer itself is unhealthy,\n\t\t\t\t\t\tRoute 53 routes queries to other available resources that are healthy, if\n\t\t\t\t\t\tany.

\n

If the environment contains a single Amazon EC2 instance, there are no\n\t\t\t\t\t\tspecial requirements.

\n
\n
ELB load balancers
\n
\n

Health checking behavior depends on the type of load balancer:

\n
    \n
  • \n

    \n Classic Load Balancers: If you\n\t\t\t\t\t\t\t\tspecify an ELB Classic Load Balancer in DNSName,\n\t\t\t\t\t\t\t\tElastic Load Balancing routes queries only to the healthy Amazon EC2\n\t\t\t\t\t\t\t\tinstances that are registered with the load balancer. If you set\n\t\t\t\t\t\t\t\t\tEvaluateTargetHealth to true and\n\t\t\t\t\t\t\t\teither no EC2 instances are healthy or the load balancer itself is\n\t\t\t\t\t\t\t\tunhealthy, Route 53 routes queries to other resources.

    \n
    • \n
  • \n

    \n Application and Network Load\n\t\t\t\t\t\t\t\t\tBalancers: If you specify an ELB Application or\n\t\t\t\t\t\t\t\tNetwork Load Balancer and you set EvaluateTargetHealth\n\t\t\t\t\t\t\t\tto true, Route 53 routes queries to the load balancer\n\t\t\t\t\t\t\t\tbased on the health of the target groups that are associated with\n\t\t\t\t\t\t\t\tthe load balancer:

    \n
      \n
    • \n

      For an Application or Network Load Balancer to be\n\t\t\t\t\t\t\t\t\t\tconsidered healthy, every target group that contains targets\n\t\t\t\t\t\t\t\t\t\tmust contain at least one healthy target. If any target\n\t\t\t\t\t\t\t\t\t\tgroup contains only unhealthy targets, the load balancer is\n\t\t\t\t\t\t\t\t\t\tconsidered unhealthy, and Route 53 routes queries to other\n\t\t\t\t\t\t\t\t\t\tresources.

      \n
      • \n
    • \n

      A target group that has no registered targets is\n\t\t\t\t\t\t\t\t\t\tconsidered unhealthy.

      \n
      • \n
    \n
    • \n
\n \n

When you create a load balancer, you configure settings for Elastic\n\t\t\t\t\t\t\tLoad Balancing health checks; they're not Route 53 health checks, but\n\t\t\t\t\t\t\tthey perform a similar function. Do not create Route 53 health checks\n\t\t\t\t\t\t\tfor the EC2 instances that you register with an ELB load balancer.\n\t\t\t\t\t\t

\n \n
\n
S3 buckets
\n
\n

There are no special requirements for setting\n\t\t\t\t\t\t\tEvaluateTargetHealth to true when the alias\n\t\t\t\t\t\ttarget is an S3 bucket.

\n
\n
Other records in the same hosted zone
\n
\n

If the Amazon Web Services resource that you specify in\n\t\t\t\t\t\t\tDNSName is a record or a group of records (for example, a\n\t\t\t\t\t\tgroup of weighted records) but is not another alias record, we recommend\n\t\t\t\t\t\tthat you associate a health check with all of the records in the alias\n\t\t\t\t\t\ttarget. For more information, see What Happens When You Omit Health Checks? in the\n\t\t\t\t\t\t\tAmazon Route 53 Developer Guide.

\n
\n
\n

For more information and examples, see Amazon Route 53 Health Checks\n\t\t\t\tand DNS Failover in the Amazon Route 53 Developer\n\t\t\tGuide.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that\n\t\t\tyou want to route traffic to.

\n

When creating resource record sets for a private hosted zone, note the\n\t\t\tfollowing:

\n " - } - }, - "com.amazonaws.route53#AssociateVPCComment": { - "type": "string" - }, - "com.amazonaws.route53#AssociateVPCWithHostedZone": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#AssociateVPCWithHostedZoneRequest" - }, - "output": { - "target": "com.amazonaws.route53#AssociateVPCWithHostedZoneResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConflictingDomainExists" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidVPCId" - }, - { - "target": "com.amazonaws.route53#LimitsExceeded" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#NotAuthorizedException" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - }, - { - "target": "com.amazonaws.route53#PublicZoneVPCAssociation" - } - ], - "traits": { - "smithy.api#documentation": "

Associates an Amazon VPC with a private hosted zone.

\n \n

To perform the association, the VPC and the private hosted zone must already\n\t\t\t\texist. You can't convert a public hosted zone into a private hosted zone.

\n \n \n

If you want to associate a VPC that was created by using one Amazon Web Services account with a private hosted zone that was created by using a\n\t\t\t\tdifferent account, the Amazon Web Services account that created the private hosted\n\t\t\t\tzone must first submit a CreateVPCAssociationAuthorization request.\n\t\t\t\tThen the account that created the VPC must submit an\n\t\t\t\t\tAssociateVPCWithHostedZone request.

\n \n \n

When granting access, the hosted zone and the Amazon VPC must belong to\n\t\t\t\tthe same partition. A partition is a group of Amazon Web Services Regions. Each\n\t\t\t\t\tAmazon Web Services account is scoped to one partition.

\n

The following are the supported partitions:

\n \n

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

\n ", - "smithy.api#examples": [ - { - "title": "To associate a VPC with a hosted zone", - "documentation": "The following example associates the VPC with ID vpc-1a2b3c4d with the hosted zone with ID Z3M3LMPEXAMPLE.", - "input": { - "HostedZoneId": "Z3M3LMPEXAMPLE", - "VPC": { - "VPCId": "vpc-1a2b3c4d", - "VPCRegion": "us-east-2" - }, - "Comment": "" + }, + "com.amazonaws.route53#ChangeBatch": { + "type": "structure", + "members": { + "Comment": { + "target": "com.amazonaws.route53#ResourceDescription", + "traits": { + "smithy.api#documentation": "

\n Optional: Any comments you want to include about a change batch\n\t\t\trequest.

" + } + }, + "Changes": { + "target": "com.amazonaws.route53#Changes", + "traits": { + "smithy.api#documentation": "

Information about the changes to make to the record sets.

", + "smithy.api#required": {} + } + } }, - "output": { - "ChangeInfo": { - "Status": "INSYNC", - "Comment": "", - "SubmittedAt": "2017-01-31T01:36:41.958Z", - "Id": "/change/C3HC6WDB2UANE2" - } - } - } - ], - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/associatevpc", - "code": 200 - } - } - }, - "com.amazonaws.route53#AssociateVPCWithHostedZoneRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the private hosted zone that you want to associate an Amazon VPC\n\t\t\twith.

\n

Note that you can't associate a VPC with a hosted zone that doesn't have an existing\n\t\t\tVPC association.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VPC": { - "target": "com.amazonaws.route53#VPC", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the VPC that you want to associate with\n\t\t\ta private hosted zone.

", - "smithy.api#required": {} - } - }, - "Comment": { - "target": "com.amazonaws.route53#AssociateVPCComment", - "traits": { - "smithy.api#documentation": "

\n Optional: A comment about the association request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the request to associate a VPC with a\n\t\t\tprivate hosted zone.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#AssociateVPCWithHostedZoneResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#documentation": "

A complex type that describes the changes made to your hosted zone.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response information for the\n\t\t\t\tAssociateVPCWithHostedZone request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#Bias": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": -99, - "max": 99 - } - } - }, - "com.amazonaws.route53#Change": { - "type": "structure", - "members": { - "Action": { - "target": "com.amazonaws.route53#ChangeAction", - "traits": { - "smithy.api#documentation": "

The action to perform:

\n ", - "smithy.api#required": {} - } - }, - "ResourceRecordSet": { - "target": "com.amazonaws.route53#ResourceRecordSet", - "traits": { - "smithy.api#documentation": "

Information about the resource record set to create, delete, or update.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The information for each resource record set that you want to change.

" - } - }, - "com.amazonaws.route53#ChangeAction": { - "type": "enum", - "members": { - "CREATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE" - } - }, - "DELETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE" - } - }, - "UPSERT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPSERT" - } - } - } - }, - "com.amazonaws.route53#ChangeBatch": { - "type": "structure", - "members": { - "Comment": { - "target": "com.amazonaws.route53#ResourceDescription", - "traits": { - "smithy.api#documentation": "

\n Optional: Any comments you want to include about a change batch\n\t\t\trequest.

" - } - }, - "Changes": { - "target": "com.amazonaws.route53#Changes", - "traits": { - "smithy.api#documentation": "

Information about the changes to make to the record sets.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The information for a change request.

" - } - }, - "com.amazonaws.route53#ChangeCidrCollection": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ChangeCidrCollectionRequest" - }, - "output": { - "target": "com.amazonaws.route53#ChangeCidrCollectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#CidrBlockInUseException" - }, - { - "target": "com.amazonaws.route53#CidrCollectionVersionMismatchException" - }, - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#LimitsExceeded" - }, - { - "target": "com.amazonaws.route53#NoSuchCidrCollectionException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates, changes, or deletes CIDR blocks within a collection. Contains authoritative\n\t\t\tIP information mapping blocks to one or multiple locations.

\n

A change request can update multiple locations in a collection at a time, which is\n\t\t\thelpful if you want to move one or more CIDR blocks from one location to another in one\n\t\t\ttransaction, without downtime.

\n

\n Limits\n

\n

The max number of CIDR blocks included in the request is 1000. As a result, big updates\n\t\t\trequire multiple API calls.

\n

\n PUT and DELETE_IF_EXISTS\n

\n

Use ChangeCidrCollection to perform the following actions:

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/cidrcollection/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#ChangeCidrCollectionRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#UUID", - "traits": { - "smithy.api#documentation": "

The UUID of the CIDR collection to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "CollectionVersion": { - "target": "com.amazonaws.route53#CollectionVersion", - "traits": { - "smithy.api#documentation": "

A sequential counter that Amazon Route 53 sets to 1 when you create a\n\t\t\tcollection and increments it by 1 each time you update the collection.

\n

We recommend that you use ListCidrCollection to get the current value of\n\t\t\t\tCollectionVersion for the collection that you want to update, and then\n\t\t\tinclude that value with the change request. This prevents Route 53 from\n\t\t\toverwriting an intervening update:

\n " - } - }, - "Changes": { - "target": "com.amazonaws.route53#CidrCollectionChanges", - "traits": { - "smithy.api#documentation": "

Information about changes to a CIDR collection.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ChangeCidrCollectionResponse": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ChangeId", - "traits": { - "smithy.api#documentation": "

The ID that is returned by ChangeCidrCollection. You can use it as input to\n\t\t\t\tGetChange to see if a CIDR collection change has propagated or\n\t\t\tnot.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ChangeId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 6500 - } - } - }, - "com.amazonaws.route53#ChangeInfo": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

This element contains an ID that you use when performing a GetChange action to get\n\t\t\tdetailed information about the change.

", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.route53#ChangeStatus", - "traits": { - "smithy.api#documentation": "

The current state of the request. PENDING indicates that this request has\n\t\t\tnot yet been applied to all Amazon Route 53 DNS servers.

", - "smithy.api#required": {} - } - }, - "SubmittedAt": { - "target": "com.amazonaws.route53#TimeStamp", - "traits": { - "smithy.api#documentation": "

The date and time that the change request was submitted in ISO 8601 format and Coordinated\n\t\t\tUniversal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z\n\t\t\trepresents March 27, 2017 at 17:48:16.751 UTC.

", - "smithy.api#required": {} - } - }, - "Comment": { - "target": "com.amazonaws.route53#ResourceDescription", - "traits": { - "smithy.api#documentation": "

A comment you can provide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that describes change information about changes made to your hosted\n\t\t\tzone.

" - } - }, - "com.amazonaws.route53#ChangeResourceRecordSets": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ChangeResourceRecordSetsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ChangeResourceRecordSetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidChangeBatch" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - } - ], - "traits": { - "smithy.api#documentation": "

Creates, changes, or deletes a resource record set, which contains authoritative DNS\n\t\t\tinformation for a specified domain name or subdomain name. For example, you can use\n\t\t\t\tChangeResourceRecordSets to create a resource record set that routes\n\t\t\ttraffic for test.example.com to a web server that has an IP address of\n\t\t\t192.0.2.44.

\n

\n Deleting Resource Record Sets\n

\n

To delete a resource record set, you must specify all the same values that you\n\t\t\tspecified when you created it.

\n

\n Change Batches and Transactional Changes\n

\n

The request body must include a document with a\n\t\t\t\tChangeResourceRecordSetsRequest element. The request body contains a\n\t\t\tlist of change items, known as a change batch. Change batches are considered\n\t\t\ttransactional changes. Route 53 validates the changes in the request and then either\n\t\t\tmakes all or none of the changes in the change batch request. This ensures that DNS\n\t\t\trouting isn't adversely affected by partial changes to the resource record sets in a\n\t\t\thosted zone.

\n

For example, suppose a change batch request contains two changes: it deletes the\n\t\t\t\tCNAME resource record set for www.example.com and creates an alias\n\t\t\tresource record set for www.example.com. If validation for both records succeeds, Route\n\t\t\t53 deletes the first resource record set and creates the second resource record set in a\n\t\t\tsingle operation. If validation for either the DELETE or the\n\t\t\t\tCREATE action fails, then the request is canceled, and the original\n\t\t\t\tCNAME record continues to exist.

\n \n

If you try to delete the same resource record set more than once in a single\n\t\t\t\tchange batch, Route 53 returns an InvalidChangeBatch error.

\n \n

\n Traffic Flow\n

\n

To create resource record sets for complex routing configurations, use either the\n\t\t\ttraffic flow visual editor in the Route 53 console or the API actions for traffic\n\t\t\tpolicies and traffic policy instances. Save the configuration as a traffic policy, then\n\t\t\tassociate the traffic policy with one or more domain names (such as example.com) or\n\t\t\tsubdomain names (such as www.example.com), in the same hosted zone or in multiple hosted\n\t\t\tzones. You can roll back the updates if the new configuration isn't performing as\n\t\t\texpected. For more information, see Using Traffic Flow to Route\n\t\t\t\tDNS Traffic in the Amazon Route 53 Developer\n\t\t\tGuide.

\n

\n Create, Delete, and Upsert\n

\n

Use ChangeResourceRecordsSetsRequest to perform the following\n\t\t\tactions:

\n \n

\n Syntaxes for Creating, Updating, and Deleting Resource Record\n\t\t\t\tSets\n

\n

The syntax for a request depends on the type of resource record set that you want to\n\t\t\tcreate, delete, or update, such as weighted, alias, or failover. The XML elements in\n\t\t\tyour request must appear in the order listed in the syntax.

\n

For an example for each type of resource record set, see \"Examples.\"

\n

Don't refer to the syntax in the \"Parameter Syntax\" section, which includes\n\t\t\tall of the elements for every kind of resource record set that you can create, delete,\n\t\t\tor update by using ChangeResourceRecordSets.

\n

\n Change Propagation to Route 53 DNS Servers\n

\n

When you submit a ChangeResourceRecordSets request, Route 53 propagates your\n\t\t\tchanges to all of the Route 53 authoritative DNS servers managing the hosted zone. While\n\t\t\tyour changes are propagating, GetChange returns a status of\n\t\t\t\tPENDING. When propagation is complete, GetChange returns a\n\t\t\tstatus of INSYNC. Changes generally propagate to all Route 53 name servers\n\t\t\tmanaging the hosted zone within 60 seconds. For more information, see GetChange.

\n

\n Limits on ChangeResourceRecordSets Requests\n

\n

For information about the limits on a ChangeResourceRecordSets request,\n\t\t\tsee Limits in the Amazon Route 53 Developer Guide.

", - "smithy.api#examples": [ - { - "title": "To create an alias resource record set", - "documentation": "The following example creates an alias resource record set that routes traffic to a CloudFront distribution.", + "traits": { + "smithy.api#documentation": "

The information for a change request.

" + } + }, + "com.amazonaws.route53#ChangeCidrCollection": { + "type": "operation", "input": { - "HostedZoneId": "Z3M3LMPEXAMPLE", - "ChangeBatch": { - "Comment": "CloudFront distribution for example.com", - "Changes": [ - { - "Action": "CREATE", - "ResourceRecordSet": { - "Name": "example.com", - "Type": "A", - "AliasTarget": { - "HostedZoneId": "Z2FDTNDATAQYW2", - "DNSName": "d123rk29d0stfj.cloudfront.net", - "EvaluateTargetHealth": false - } - } - } - ] - } + "target": "com.amazonaws.route53#ChangeCidrCollectionRequest" }, "output": { - "ChangeInfo": { - "Comment": "CloudFront distribution for example.com", - "Id": "/change/C2682N5HXP0BZ4", - "Status": "PENDING", - "SubmittedAt": "2017-02-10T01:36:41.958Z" - } - } - }, - { - "title": "To create failover alias resource record sets", - "documentation": "The following example creates primary and secondary failover alias resource record sets that route traffic to ELB load balancers. Traffic is generally routed to the primary resource, in the Ohio region. If that resource is unavailable, traffic is routed to the secondary resource, in the Oregon region.", - "input": { - "HostedZoneId": "Z3M3LMPEXAMPLE", - "ChangeBatch": { - "Comment": "Failover alias configuration for example.com", - "Changes": [ - { - "Action": "CREATE", - "ResourceRecordSet": { - "Name": "example.com", - "Type": "A", - "SetIdentifier": "Ohio region", - "Failover": "PRIMARY", - "AliasTarget": { - "HostedZoneId": "Z3AADJGX6KTTL2", - "DNSName": "example-com-123456789.us-east-2.elb.amazonaws.com ", - "EvaluateTargetHealth": true - } - } - }, - { - "Action": "CREATE", - "ResourceRecordSet": { - "Name": "example.com", - "Type": "A", - "SetIdentifier": "Oregon region", - "Failover": "SECONDARY", - "AliasTarget": { - "HostedZoneId": "Z1H1FL5HABSF5", - "DNSName": "example-com-987654321.us-west-2.elb.amazonaws.com ", - "EvaluateTargetHealth": true - } - } - } - ] - } + "target": "com.amazonaws.route53#ChangeCidrCollectionResponse" }, - "output": { - "ChangeInfo": { - "Comment": "Failover alias configuration for example.com", - "Id": "/change/C2682N5HXP0BZ4", - "Status": "PENDING", - "SubmittedAt": "2017-02-10T01:36:41.958Z" - } - } - }, - { - "title": "To create failover resource record sets", - "documentation": "The following example creates primary and secondary failover resource record sets that route traffic to EC2 instances. Traffic is generally routed to the primary resource, in the Ohio region. If that resource is unavailable, traffic is routed to the secondary resource, in the Oregon region.", - "input": { - "HostedZoneId": "Z3M3LMPEXAMPLE", - "ChangeBatch": { - "Comment": "Failover configuration for example.com", - "Changes": [ - { - "Action": "CREATE", - "ResourceRecordSet": { - "Name": "example.com", - "Type": "A", - "SetIdentifier": "Ohio region", - "Failover": "PRIMARY", - "TTL": 60, - "ResourceRecords": [ - { - "Value": "192.0.2.44" - } - ], - "HealthCheckId": "abcdef11-2222-3333-4444-555555fedcba" - } - }, - { - "Action": "CREATE", - "ResourceRecordSet": { - "Name": "example.com", - "Type": "A", - "SetIdentifier": "Oregon region", - "Failover": "SECONDARY", - "TTL": 60, - "ResourceRecords": [ - { - "Value": "192.0.2.45" - } - ], - "HealthCheckId": "abcdef66-7777-8888-9999-000000fedcba" + "errors": [ + { + "target": "com.amazonaws.route53#CidrBlockInUseException" + }, + { + "target": "com.amazonaws.route53#CidrCollectionVersionMismatchException" + }, + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#LimitsExceeded" + }, + { + "target": "com.amazonaws.route53#NoSuchCidrCollectionException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates, changes, or deletes CIDR blocks within a collection. Contains authoritative\n\t\t\tIP information mapping blocks to one or multiple locations.

\n

A change request can update multiple locations in a collection at a time, which is\n\t\t\thelpful if you want to move one or more CIDR blocks from one location to another in one\n\t\t\ttransaction, without downtime.

\n

\n Limits\n

\n

The max number of CIDR blocks included in the request is 1000. As a result, big updates\n\t\t\trequire multiple API calls.

\n

\n PUT and DELETE_IF_EXISTS\n

\n

Use ChangeCidrCollection to perform the following actions:

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/cidrcollection/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#ChangeCidrCollectionRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "

The UUID of the CIDR collection to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } - } - ] - } + }, + "CollectionVersion": { + "target": "com.amazonaws.route53#CollectionVersion", + "traits": { + "smithy.api#documentation": "

A sequential counter that Amazon Route 53 sets to 1 when you create a\n\t\t\tcollection and increments it by 1 each time you update the collection.

\n

We recommend that you use ListCidrCollection to get the current value of\n\t\t\t\tCollectionVersion for the collection that you want to update, and then\n\t\t\tinclude that value with the change request. This prevents Route 53 from\n\t\t\toverwriting an intervening update:

\n " + } + }, + "Changes": { + "target": "com.amazonaws.route53#CidrCollectionChanges", + "traits": { + "smithy.api#documentation": "

Information about changes to a CIDR collection.

", + "smithy.api#required": {} + } + } }, - "output": { - "ChangeInfo": { - "Comment": "Failover configuration for example.com", - "Id": "/change/C2682N5HXP0BZ4", - "Status": "PENDING", - "SubmittedAt": "2017-02-10T01:36:41.958Z" - } - } - }, - { - "title": "To create geolocation alias resource record sets", - "documentation": "The following example creates four geolocation alias resource record sets that route traffic to ELB load balancers. Traffic is routed to one of four IP addresses, for North America (NA), for South America (SA), for Europe (EU), and for all other locations (*).", - "input": { - "HostedZoneId": "Z3M3LMPEXAMPLE", - "ChangeBatch": { - "Comment": "Geolocation alias configuration for example.com", - "Changes": [ - { - "Action": "CREATE", - "ResourceRecordSet": { - "Name": "example.com", - "Type": "A", - "SetIdentifier": "North America", - "GeoLocation": { - "ContinentCode": "NA" - }, - "AliasTarget": { - "HostedZoneId": "Z3AADJGX6KTTL2", - "DNSName": "example-com-123456789.us-east-2.elb.amazonaws.com ", - "EvaluateTargetHealth": true - } - } - }, - { - "Action": "CREATE", - "ResourceRecordSet": { - "Name": "example.com", - "Type": "A", - "SetIdentifier": "South America", - "GeoLocation": { - "ContinentCode": "SA" - }, - "AliasTarget": { - "HostedZoneId": "Z2P70J7HTTTPLU", - "DNSName": "example-com-234567890.sa-east-1.elb.amazonaws.com ", - "EvaluateTargetHealth": true - } - } - }, - { - "Action": "CREATE", - "ResourceRecordSet": { - "Name": "example.com", - "Type": "A", - "SetIdentifier": "Europe", - "GeoLocation": { - "ContinentCode": "EU" - }, - "AliasTarget": { - "HostedZoneId": "Z215JYRZR1TBD5", - "DNSName": "example-com-234567890.eu-central-1.elb.amazonaws.com ", - "EvaluateTargetHealth": true - } - } - }, - { - "Action": "CREATE", - "ResourceRecordSet": { - "Name": "example.com", - "Type": "A", - "SetIdentifier": "Other locations", - "GeoLocation": { - "CountryCode": "*" - }, - "AliasTarget": { - "HostedZoneId": "Z1LMS91P8CMLE5", - "DNSName": "example-com-234567890.ap-southeast-1.elb.amazonaws.com ", - "EvaluateTargetHealth": true - } - } - } - ] - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ChangeCidrCollectionResponse": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ChangeId", + "traits": { + "smithy.api#documentation": "

The ID that is returned by ChangeCidrCollection. You can use it as input to\n\t\t\t\tGetChange to see if a CIDR collection change has propagated or\n\t\t\tnot.

", + "smithy.api#required": {} + } + } }, - "output": { - "ChangeInfo": { - "Comment": "Geolocation alias configuration for example.com", - "Id": "/change/C2682N5HXP0BZ4", - "Status": "PENDING", - "SubmittedAt": "2017-02-10T01:36:41.958Z" - } - } - }, - { - "title": "To create geolocation resource record sets", - "documentation": "The following example creates four geolocation resource record sets that use IPv4 addresses to route traffic to resources such as web servers running on EC2 instances. Traffic is routed to one of four IP addresses, for North America (NA), for South America (SA), for Europe (EU), and for all other locations (*).", - "input": { - "HostedZoneId": "Z3M3LMPEXAMPLE", - "ChangeBatch": { - "Comment": "Geolocation configuration for example.com", - "Changes": [ - { - "Action": "CREATE", - "ResourceRecordSet": { - "Name": "example.com", - "Type": "A", - "SetIdentifier": "North America", - "GeoLocation": { - "ContinentCode": "NA" - }, - "TTL": 60, - "ResourceRecords": [ - { - "Value": "192.0.2.44" - } - ] - } - }, - { - "Action": "CREATE", - "ResourceRecordSet": { - "Name": "example.com", - "Type": "A", - "SetIdentifier": "South America", - "GeoLocation": { - "ContinentCode": "SA" - }, - "TTL": 60, - "ResourceRecords": [ - { - "Value": "192.0.2.45" - } - ] - } - }, - { - "Action": "CREATE", - "ResourceRecordSet": { - "Name": "example.com", - "Type": "A", - "SetIdentifier": "Europe", - "GeoLocation": { - "ContinentCode": "EU" - }, - "TTL": 60, - "ResourceRecords": [ - { - "Value": "192.0.2.46" - } - ] - } - }, - { - "Action": "CREATE", - "ResourceRecordSet": { - "Name": "example.com", - "Type": "A", - "SetIdentifier": "Other locations", - "GeoLocation": { - "CountryCode": "*" - }, - "TTL": 60, - "ResourceRecords": [ - { - "Value": "192.0.2.47" - } - ] + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ChangeId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6500 + } + } + }, + "com.amazonaws.route53#ChangeInfo": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

This element contains an ID that you use when performing a GetChange action to get\n\t\t\tdetailed information about the change.

", + "smithy.api#required": {} } - } - ] - } + }, + "Status": { + "target": "com.amazonaws.route53#ChangeStatus", + "traits": { + "smithy.api#documentation": "

The current state of the request. PENDING indicates that this request has\n\t\t\tnot yet been applied to all Amazon Route 53 DNS servers.

", + "smithy.api#required": {} + } + }, + "SubmittedAt": { + "target": "com.amazonaws.route53#TimeStamp", + "traits": { + "smithy.api#documentation": "

The date and time that the change request was submitted in ISO 8601 format and Coordinated\n\t\t\tUniversal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z\n\t\t\trepresents March 27, 2017 at 17:48:16.751 UTC.

", + "smithy.api#required": {} + } + }, + "Comment": { + "target": "com.amazonaws.route53#ResourceDescription", + "traits": { + "smithy.api#documentation": "

A comment you can provide.

" + } + } }, - "output": { - "ChangeInfo": { - "Comment": "Geolocation configuration for example.com", - "Id": "/change/C2682N5HXP0BZ4", - "Status": "PENDING", - "SubmittedAt": "2017-02-10T01:36:41.958Z" - } - } - }, - { - "title": "To create latency alias resource record sets", - "documentation": "The following example creates two latency alias resource record sets that route traffic for example.com to ELB load balancers. Requests are routed either to the Ohio region or the Oregon region, depending on the latency between the user and those regions.", + "traits": { + "smithy.api#documentation": "

A complex type that describes change information about changes made to your hosted\n\t\t\tzone.

" + } + }, + "com.amazonaws.route53#ChangeResourceRecordSets": { + "type": "operation", "input": { - "HostedZoneId": "Z3M3LMPEXAMPLE", - "ChangeBatch": { - "Comment": "ELB load balancers for example.com", - "Changes": [ - { - "Action": "CREATE", - "ResourceRecordSet": { - "Name": "example.com", - "Type": "A", - "SetIdentifier": "Ohio region", - "Region": "us-east-2", - "AliasTarget": { - "HostedZoneId": "Z3AADJGX6KTTL2", - "DNSName": "example-com-123456789.us-east-2.elb.amazonaws.com ", - "EvaluateTargetHealth": true - } - } - }, - { - "Action": "CREATE", - "ResourceRecordSet": { - "Name": "example.com", - "Type": "A", - "SetIdentifier": "Oregon region", - "Region": "us-west-2", - "AliasTarget": { - "HostedZoneId": "Z1H1FL5HABSF5", - "DNSName": "example-com-987654321.us-west-2.elb.amazonaws.com ", - "EvaluateTargetHealth": true - } - } - } - ] - } + "target": "com.amazonaws.route53#ChangeResourceRecordSetsRequest" }, "output": { - "ChangeInfo": { - "Comment": "ELB load balancers for example.com", - "Id": "/change/C2682N5HXP0BZ4", - "Status": "PENDING", - "SubmittedAt": "2017-02-10T01:36:41.958Z" - } - } - }, - { - "title": "To create latency resource record sets", - "documentation": "The following example creates two latency resource record sets that route traffic to EC2 instances. Traffic for example.com is routed either to the Ohio region or the Oregon region, depending on the latency between the user and those regions.", - "input": { - "HostedZoneId": "Z3M3LMPEXAMPLE", - "ChangeBatch": { - "Comment": "EC2 instances for example.com", - "Changes": [ - { - "Action": "CREATE", - "ResourceRecordSet": { - "Name": "example.com", - "Type": "A", - "SetIdentifier": "Ohio region", - "Region": "us-east-2", - "TTL": 60, - "ResourceRecords": [ - { - "Value": "192.0.2.44" - } - ], - "HealthCheckId": "abcdef11-2222-3333-4444-555555fedcba" - } - }, - { - "Action": "CREATE", - "ResourceRecordSet": { - "Name": "example.com", - "Type": "A", - "SetIdentifier": "Oregon region", - "Region": "us-west-2", - "TTL": 60, - "ResourceRecords": [ - { - "Value": "192.0.2.45" - } - ], - "HealthCheckId": "abcdef66-7777-8888-9999-000000fedcba" - } - } - ] - } + "target": "com.amazonaws.route53#ChangeResourceRecordSetsResponse" }, - "output": { - "ChangeInfo": { - "Comment": "EC2 instances for example.com", - "Id": "/change/C2682N5HXP0BZ4", - "Status": "PENDING", - "SubmittedAt": "2017-02-10T01:36:41.958Z" - } - } - }, - { - "title": "To create a basic resource record set", - "documentation": "The following example creates a resource record set that routes Internet traffic to a resource with an IP address of 192.0.2.44.", - "input": { - "HostedZoneId": "Z3M3LMPEXAMPLE", - "ChangeBatch": { - "Comment": "Web server for example.com", - "Changes": [ - { - "Action": "CREATE", - "ResourceRecordSet": { - "Name": "example.com", - "Type": "A", - "TTL": 60, - "ResourceRecords": [ - { - "Value": "192.0.2.44" + "errors": [ + { + "target": "com.amazonaws.route53#InvalidChangeBatch" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" + } + ], + "traits": { + "smithy.api#documentation": "

Creates, changes, or deletes a resource record set, which contains authoritative DNS\n\t\t\tinformation for a specified domain name or subdomain name. For example, you can use\n\t\t\t\tChangeResourceRecordSets to create a resource record set that routes\n\t\t\ttraffic for test.example.com to a web server that has an IP address of\n\t\t\t192.0.2.44.

\n

\n Deleting Resource Record Sets\n

\n

To delete a resource record set, you must specify all the same values that you\n\t\t\tspecified when you created it.

\n

\n Change Batches and Transactional Changes\n

\n

The request body must include a document with a\n\t\t\t\tChangeResourceRecordSetsRequest element. The request body contains a\n\t\t\tlist of change items, known as a change batch. Change batches are considered\n\t\t\ttransactional changes. Route 53 validates the changes in the request and then either\n\t\t\tmakes all or none of the changes in the change batch request. This ensures that DNS\n\t\t\trouting isn't adversely affected by partial changes to the resource record sets in a\n\t\t\thosted zone.

\n

For example, suppose a change batch request contains two changes: it deletes the\n\t\t\t\tCNAME resource record set for www.example.com and creates an alias\n\t\t\tresource record set for www.example.com. If validation for both records succeeds, Route\n\t\t\t53 deletes the first resource record set and creates the second resource record set in a\n\t\t\tsingle operation. If validation for either the DELETE or the\n\t\t\t\tCREATE action fails, then the request is canceled, and the original\n\t\t\t\tCNAME record continues to exist.

\n \n

If you try to delete the same resource record set more than once in a single\n\t\t\t\tchange batch, Route 53 returns an InvalidChangeBatch error.

\n \n

\n Traffic Flow\n

\n

To create resource record sets for complex routing configurations, use either the\n\t\t\ttraffic flow visual editor in the Route 53 console or the API actions for traffic\n\t\t\tpolicies and traffic policy instances. Save the configuration as a traffic policy, then\n\t\t\tassociate the traffic policy with one or more domain names (such as example.com) or\n\t\t\tsubdomain names (such as www.example.com), in the same hosted zone or in multiple hosted\n\t\t\tzones. You can roll back the updates if the new configuration isn't performing as\n\t\t\texpected. For more information, see Using Traffic Flow to Route\n\t\t\t\tDNS Traffic in the Amazon Route 53 Developer\n\t\t\tGuide.

\n

\n Create, Delete, and Upsert\n

\n

Use ChangeResourceRecordsSetsRequest to perform the following\n\t\t\tactions:

\n \n

\n Syntaxes for Creating, Updating, and Deleting Resource Record\n\t\t\t\tSets\n

\n

The syntax for a request depends on the type of resource record set that you want to\n\t\t\tcreate, delete, or update, such as weighted, alias, or failover. The XML elements in\n\t\t\tyour request must appear in the order listed in the syntax.

\n

For an example for each type of resource record set, see \"Examples.\"

\n

Don't refer to the syntax in the \"Parameter Syntax\" section, which includes\n\t\t\tall of the elements for every kind of resource record set that you can create, delete,\n\t\t\tor update by using ChangeResourceRecordSets.

\n

\n Change Propagation to Route 53 DNS Servers\n

\n

When you submit a ChangeResourceRecordSets request, Route 53 propagates your\n\t\t\tchanges to all of the Route 53 authoritative DNS servers managing the hosted zone. While\n\t\t\tyour changes are propagating, GetChange returns a status of\n\t\t\t\tPENDING. When propagation is complete, GetChange returns a\n\t\t\tstatus of INSYNC. Changes generally propagate to all Route 53 name servers\n\t\t\tmanaging the hosted zone within 60 seconds. For more information, see GetChange.

\n

\n Limits on ChangeResourceRecordSets Requests\n

\n

For information about the limits on a ChangeResourceRecordSets request,\n\t\t\tsee Limits in the Amazon Route 53 Developer Guide.

", + "smithy.api#examples": [ + { + "title": "To create an alias resource record set", + "documentation": "The following example creates an alias resource record set that routes traffic to a CloudFront distribution.", + "input": { + "HostedZoneId": "Z3M3LMPEXAMPLE", + "ChangeBatch": { + "Comment": "CloudFront distribution for example.com", + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "Type": "A", + "AliasTarget": { + "HostedZoneId": "Z2FDTNDATAQYW2", + "DNSName": "d123rk29d0stfj.cloudfront.net", + "EvaluateTargetHealth": false + } + } + } + ] + } + }, + "output": { + "ChangeInfo": { + "Comment": "CloudFront distribution for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + } + }, + { + "title": "To create failover alias resource record sets", + "documentation": "The following example creates primary and secondary failover alias resource record sets that route traffic to ELB load balancers. Traffic is generally routed to the primary resource, in the Ohio region. If that resource is unavailable, traffic is routed to the secondary resource, in the Oregon region.", + "input": { + "HostedZoneId": "Z3M3LMPEXAMPLE", + "ChangeBatch": { + "Comment": "Failover alias configuration for example.com", + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "Type": "A", + "SetIdentifier": "Ohio region", + "Failover": "PRIMARY", + "AliasTarget": { + "HostedZoneId": "Z3AADJGX6KTTL2", + "DNSName": "example-com-123456789.us-east-2.elb.amazonaws.com ", + "EvaluateTargetHealth": true + } + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "Type": "A", + "SetIdentifier": "Oregon region", + "Failover": "SECONDARY", + "AliasTarget": { + "HostedZoneId": "Z1H1FL5HABSF5", + "DNSName": "example-com-987654321.us-west-2.elb.amazonaws.com ", + "EvaluateTargetHealth": true + } + } + } + ] + } + }, + "output": { + "ChangeInfo": { + "Comment": "Failover alias configuration for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + } + }, + { + "title": "To create failover resource record sets", + "documentation": "The following example creates primary and secondary failover resource record sets that route traffic to EC2 instances. Traffic is generally routed to the primary resource, in the Ohio region. If that resource is unavailable, traffic is routed to the secondary resource, in the Oregon region.", + "input": { + "HostedZoneId": "Z3M3LMPEXAMPLE", + "ChangeBatch": { + "Comment": "Failover configuration for example.com", + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "Type": "A", + "SetIdentifier": "Ohio region", + "Failover": "PRIMARY", + "TTL": 60, + "ResourceRecords": [ + { + "Value": "192.0.2.44" + } + ], + "HealthCheckId": "abcdef11-2222-3333-4444-555555fedcba" + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "Type": "A", + "SetIdentifier": "Oregon region", + "Failover": "SECONDARY", + "TTL": 60, + "ResourceRecords": [ + { + "Value": "192.0.2.45" + } + ], + "HealthCheckId": "abcdef66-7777-8888-9999-000000fedcba" + } + } + ] + } + }, + "output": { + "ChangeInfo": { + "Comment": "Failover configuration for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + } + }, + { + "title": "To create geolocation alias resource record sets", + "documentation": "The following example creates four geolocation alias resource record sets that route traffic to ELB load balancers. Traffic is routed to one of four IP addresses, for North America (NA), for South America (SA), for Europe (EU), and for all other locations (*).", + "input": { + "HostedZoneId": "Z3M3LMPEXAMPLE", + "ChangeBatch": { + "Comment": "Geolocation alias configuration for example.com", + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "Type": "A", + "SetIdentifier": "North America", + "GeoLocation": { + "ContinentCode": "NA" + }, + "AliasTarget": { + "HostedZoneId": "Z3AADJGX6KTTL2", + "DNSName": "example-com-123456789.us-east-2.elb.amazonaws.com ", + "EvaluateTargetHealth": true + } + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "Type": "A", + "SetIdentifier": "South America", + "GeoLocation": { + "ContinentCode": "SA" + }, + "AliasTarget": { + "HostedZoneId": "Z2P70J7HTTTPLU", + "DNSName": "example-com-234567890.sa-east-1.elb.amazonaws.com ", + "EvaluateTargetHealth": true + } + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "Type": "A", + "SetIdentifier": "Europe", + "GeoLocation": { + "ContinentCode": "EU" + }, + "AliasTarget": { + "HostedZoneId": "Z215JYRZR1TBD5", + "DNSName": "example-com-234567890.eu-central-1.elb.amazonaws.com ", + "EvaluateTargetHealth": true + } + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "Type": "A", + "SetIdentifier": "Other locations", + "GeoLocation": { + "CountryCode": "*" + }, + "AliasTarget": { + "HostedZoneId": "Z1LMS91P8CMLE5", + "DNSName": "example-com-234567890.ap-southeast-1.elb.amazonaws.com ", + "EvaluateTargetHealth": true + } + } + } + ] + } + }, + "output": { + "ChangeInfo": { + "Comment": "Geolocation alias configuration for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + } + }, + { + "title": "To create geolocation resource record sets", + "documentation": "The following example creates four geolocation resource record sets that use IPv4 addresses to route traffic to resources such as web servers running on EC2 instances. Traffic is routed to one of four IP addresses, for North America (NA), for South America (SA), for Europe (EU), and for all other locations (*).", + "input": { + "HostedZoneId": "Z3M3LMPEXAMPLE", + "ChangeBatch": { + "Comment": "Geolocation configuration for example.com", + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "Type": "A", + "SetIdentifier": "North America", + "GeoLocation": { + "ContinentCode": "NA" + }, + "TTL": 60, + "ResourceRecords": [ + { + "Value": "192.0.2.44" + } + ] + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "Type": "A", + "SetIdentifier": "South America", + "GeoLocation": { + "ContinentCode": "SA" + }, + "TTL": 60, + "ResourceRecords": [ + { + "Value": "192.0.2.45" + } + ] + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "Type": "A", + "SetIdentifier": "Europe", + "GeoLocation": { + "ContinentCode": "EU" + }, + "TTL": 60, + "ResourceRecords": [ + { + "Value": "192.0.2.46" + } + ] + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "Type": "A", + "SetIdentifier": "Other locations", + "GeoLocation": { + "CountryCode": "*" + }, + "TTL": 60, + "ResourceRecords": [ + { + "Value": "192.0.2.47" + } + ] + } + } + ] + } + }, + "output": { + "ChangeInfo": { + "Comment": "Geolocation configuration for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + } + }, + { + "title": "To create latency alias resource record sets", + "documentation": "The following example creates two latency alias resource record sets that route traffic for example.com to ELB load balancers. Requests are routed either to the Ohio region or the Oregon region, depending on the latency between the user and those regions.", + "input": { + "HostedZoneId": "Z3M3LMPEXAMPLE", + "ChangeBatch": { + "Comment": "ELB load balancers for example.com", + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "Type": "A", + "SetIdentifier": "Ohio region", + "Region": "us-east-2", + "AliasTarget": { + "HostedZoneId": "Z3AADJGX6KTTL2", + "DNSName": "example-com-123456789.us-east-2.elb.amazonaws.com ", + "EvaluateTargetHealth": true + } + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "Type": "A", + "SetIdentifier": "Oregon region", + "Region": "us-west-2", + "AliasTarget": { + "HostedZoneId": "Z1H1FL5HABSF5", + "DNSName": "example-com-987654321.us-west-2.elb.amazonaws.com ", + "EvaluateTargetHealth": true + } + } + } + ] + } + }, + "output": { + "ChangeInfo": { + "Comment": "ELB load balancers for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + } + }, + { + "title": "To create latency resource record sets", + "documentation": "The following example creates two latency resource record sets that route traffic to EC2 instances. Traffic for example.com is routed either to the Ohio region or the Oregon region, depending on the latency between the user and those regions.", + "input": { + "HostedZoneId": "Z3M3LMPEXAMPLE", + "ChangeBatch": { + "Comment": "EC2 instances for example.com", + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "Type": "A", + "SetIdentifier": "Ohio region", + "Region": "us-east-2", + "TTL": 60, + "ResourceRecords": [ + { + "Value": "192.0.2.44" + } + ], + "HealthCheckId": "abcdef11-2222-3333-4444-555555fedcba" + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "Type": "A", + "SetIdentifier": "Oregon region", + "Region": "us-west-2", + "TTL": 60, + "ResourceRecords": [ + { + "Value": "192.0.2.45" + } + ], + "HealthCheckId": "abcdef66-7777-8888-9999-000000fedcba" + } + } + ] + } + }, + "output": { + "ChangeInfo": { + "Comment": "EC2 instances for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + } + }, + { + "title": "To create a basic resource record set", + "documentation": "The following example creates a resource record set that routes Internet traffic to a resource with an IP address of 192.0.2.44.", + "input": { + "HostedZoneId": "Z3M3LMPEXAMPLE", + "ChangeBatch": { + "Comment": "Web server for example.com", + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "Type": "A", + "TTL": 60, + "ResourceRecords": [ + { + "Value": "192.0.2.44" + } + ] + } + } + ] + } + }, + "output": { + "ChangeInfo": { + "Comment": "Web server for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + } + }, + { + "title": "To create weighted alias resource record sets", + "documentation": "The following example creates two weighted alias resource record sets that route traffic to ELB load balancers. The resource with a Weight of 100 will get 1/3rd of traffic (100/100+200), and the other resource will get the rest of the traffic for example.com.", + "input": { + "HostedZoneId": "Z3M3LMPEXAMPLE", + "ChangeBatch": { + "Comment": "ELB load balancers for example.com", + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "Type": "A", + "SetIdentifier": "Ohio region", + "Weight": 100, + "AliasTarget": { + "HostedZoneId": "Z3AADJGX6KTTL2", + "DNSName": "example-com-123456789.us-east-2.elb.amazonaws.com ", + "EvaluateTargetHealth": true + } + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "Type": "A", + "SetIdentifier": "Oregon region", + "Weight": 200, + "AliasTarget": { + "HostedZoneId": "Z1H1FL5HABSF5", + "DNSName": "example-com-987654321.us-west-2.elb.amazonaws.com ", + "EvaluateTargetHealth": true + } + } + } + ] + } + }, + "output": { + "ChangeInfo": { + "Comment": "ELB load balancers for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } + } + }, + { + "title": "To create weighted resource record sets", + "documentation": "The following example creates two weighted resource record sets. The resource with a Weight of 100 will get 1/3rd of traffic (100/100+200), and the other resource will get the rest of the traffic for example.com.", + "input": { + "HostedZoneId": "Z3M3LMPEXAMPLE", + "ChangeBatch": { + "Comment": "Web servers for example.com", + "Changes": [ + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "Type": "A", + "SetIdentifier": "Seattle data center", + "Weight": 100, + "TTL": 60, + "ResourceRecords": [ + { + "Value": "192.0.2.44" + } + ], + "HealthCheckId": "abcdef11-2222-3333-4444-555555fedcba" + } + }, + { + "Action": "CREATE", + "ResourceRecordSet": { + "Name": "example.com", + "Type": "A", + "SetIdentifier": "Portland data center", + "Weight": 200, + "TTL": 60, + "ResourceRecords": [ + { + "Value": "192.0.2.45" + } + ], + "HealthCheckId": "abcdef66-7777-8888-9999-000000fedcba" + } + } + ] + } + }, + "output": { + "ChangeInfo": { + "Comment": "Web servers for example.com", + "Id": "/change/C2682N5HXP0BZ4", + "Status": "PENDING", + "SubmittedAt": "2017-02-10T01:36:41.958Z" + } } - ] } - } - ] - } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/rrset", + "code": 200 + } + } + }, + "com.amazonaws.route53#ChangeResourceRecordSetsRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that contains the resource record sets that you want to\n\t\t\tchange.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChangeBatch": { + "target": "com.amazonaws.route53#ChangeBatch", + "traits": { + "smithy.api#documentation": "

A complex type that contains an optional comment and the Changes\n\t\t\telement.

", + "smithy.api#required": {} + } + } }, - "output": { - "ChangeInfo": { - "Comment": "Web server for example.com", - "Id": "/change/C2682N5HXP0BZ4", - "Status": "PENDING", - "SubmittedAt": "2017-02-10T01:36:41.958Z" - } - } - }, - { - "title": "To create weighted alias resource record sets", - "documentation": "The following example creates two weighted alias resource record sets that route traffic to ELB load balancers. The resource with a Weight of 100 will get 1/3rd of traffic (100/100+200), and the other resource will get the rest of the traffic for example.com.", - "input": { - "HostedZoneId": "Z3M3LMPEXAMPLE", - "ChangeBatch": { - "Comment": "ELB load balancers for example.com", - "Changes": [ - { - "Action": "CREATE", - "ResourceRecordSet": { - "Name": "example.com", - "Type": "A", - "SetIdentifier": "Ohio region", - "Weight": 100, - "AliasTarget": { - "HostedZoneId": "Z3AADJGX6KTTL2", - "DNSName": "example-com-123456789.us-east-2.elb.amazonaws.com ", - "EvaluateTargetHealth": true - } - } - }, - { - "Action": "CREATE", - "ResourceRecordSet": { - "Name": "example.com", - "Type": "A", - "SetIdentifier": "Oregon region", - "Weight": 200, - "AliasTarget": { - "HostedZoneId": "Z1H1FL5HABSF5", - "DNSName": "example-com-987654321.us-west-2.elb.amazonaws.com ", - "EvaluateTargetHealth": true - } - } - } - ] - } + "traits": { + "smithy.api#documentation": "

A complex type that contains change information for the resource record set.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ChangeResourceRecordSetsResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about changes made to your hosted\n\t\t\tzone.

\n

This element contains an ID that you use when performing a GetChange action to get\n\t\t\tdetailed information about the change.

", + "smithy.api#required": {} + } + } }, - "output": { - "ChangeInfo": { - "Comment": "ELB load balancers for example.com", - "Id": "/change/C2682N5HXP0BZ4", - "Status": "PENDING", - "SubmittedAt": "2017-02-10T01:36:41.958Z" - } - } - }, - { - "title": "To create weighted resource record sets", - "documentation": "The following example creates two weighted resource record sets. The resource with a Weight of 100 will get 1/3rd of traffic (100/100+200), and the other resource will get the rest of the traffic for example.com.", - "input": { - "HostedZoneId": "Z3M3LMPEXAMPLE", - "ChangeBatch": { - "Comment": "Web servers for example.com", - "Changes": [ - { - "Action": "CREATE", - "ResourceRecordSet": { - "Name": "example.com", - "Type": "A", - "SetIdentifier": "Seattle data center", - "Weight": 100, - "TTL": 60, - "ResourceRecords": [ - { - "Value": "192.0.2.44" - } - ], - "HealthCheckId": "abcdef11-2222-3333-4444-555555fedcba" - } - }, - { - "Action": "CREATE", - "ResourceRecordSet": { - "Name": "example.com", - "Type": "A", - "SetIdentifier": "Portland data center", - "Weight": 200, - "TTL": 60, - "ResourceRecords": [ - { - "Value": "192.0.2.45" - } - ], - "HealthCheckId": "abcdef66-7777-8888-9999-000000fedcba" + "traits": { + "smithy.api#documentation": "

A complex type containing the response for the request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ChangeStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" } - } - ] - } + }, + "INSYNC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSYNC" + } + } + } + }, + "com.amazonaws.route53#ChangeTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ChangeTagsForResourceRequest" }, "output": { - "ChangeInfo": { - "Comment": "Web servers for example.com", - "Id": "/change/C2682N5HXP0BZ4", - "Status": "PENDING", - "SubmittedAt": "2017-02-10T01:36:41.958Z" - } - } - } - ], - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/rrset", - "code": 200 - } - } - }, - "com.amazonaws.route53#ChangeResourceRecordSetsRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that contains the resource record sets that you want to\n\t\t\tchange.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ChangeBatch": { - "target": "com.amazonaws.route53#ChangeBatch", - "traits": { - "smithy.api#documentation": "

A complex type that contains an optional comment and the Changes\n\t\t\telement.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains change information for the resource record set.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ChangeResourceRecordSetsResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about changes made to your hosted\n\t\t\tzone.

\n

This element contains an ID that you use when performing a GetChange action to get\n\t\t\tdetailed information about the change.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type containing the response for the request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ChangeStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "INSYNC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSYNC" - } - } - } - }, - "com.amazonaws.route53#ChangeTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ChangeTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.route53#ChangeTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - }, - { - "target": "com.amazonaws.route53#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds, edits, or deletes tags for a health check or a hosted zone.

\n

For information about using tags for cost allocation, see Using Cost Allocation\n\t\t\t\tTags in the Billing and Cost Management User Guide.

", - "smithy.api#examples": [ - { - "title": "To add or remove tags from a hosted zone or health check", - "documentation": "The following example adds two tags and removes one tag from the hosted zone with ID Z3M3LMPEXAMPLE.", - "input": { - "ResourceType": "hostedzone", - "ResourceId": "Z3M3LMPEXAMPLE", - "AddTags": [ + "target": "com.amazonaws.route53#ChangeTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, { - "Key": "apex", - "Value": "3874" + "target": "com.amazonaws.route53#PriorRequestNotComplete" }, { - "Key": "acme", - "Value": "4938" + "target": "com.amazonaws.route53#ThrottlingException" } - ], - "RemoveTagKeys": ["Nadir"] - }, - "output": {} - } - ], - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/tags/{ResourceType}/{ResourceId}", - "code": 200 - } - } - }, - "com.amazonaws.route53#ChangeTagsForResourceRequest": { - "type": "structure", - "members": { - "ResourceType": { - "target": "com.amazonaws.route53#TagResourceType", - "traits": { - "smithy.api#documentation": "

The type of the resource.

\n ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.route53#TagResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the resource for which you want to add, change, or delete tags.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AddTags": { - "target": "com.amazonaws.route53#TagList", - "traits": { - "smithy.api#documentation": "

A complex type that contains a list of the tags that you want to add to the specified\n\t\t\thealth check or hosted zone and/or the tags that you want to edit Value\n\t\t\tfor.

\n

You can add a maximum of 10 tags to a health check or a hosted zone.

" - } - }, - "RemoveTagKeys": { - "target": "com.amazonaws.route53#TagKeyList", - "traits": { - "smithy.api#documentation": "

A complex type that contains a list of the tags that you want to delete from the\n\t\t\tspecified health check or hosted zone. You can specify up to 10 keys.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the tags that you want to add, edit, or\n\t\t\tdelete.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ChangeTagsForResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Empty response for the request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#Changes": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#Change", - "traits": { - "smithy.api#xmlName": "Change" - } - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.route53#CheckerIpRanges": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#IPAddressCidr" - } - }, - "com.amazonaws.route53#ChildHealthCheckList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#HealthCheckId", - "traits": { - "smithy.api#xmlName": "ChildHealthCheck" - } - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.route53#Cidr": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.route53#CidrBlockInUseException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

This CIDR block is already in use.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#CidrBlockSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#CidrBlockSummary" - } - }, - "com.amazonaws.route53#CidrBlockSummary": { - "type": "structure", - "members": { - "CidrBlock": { - "target": "com.amazonaws.route53#Cidr", - "traits": { - "smithy.api#documentation": "

Value for the CIDR block.

" - } - }, - "LocationName": { - "target": "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed", - "traits": { - "smithy.api#documentation": "

The location name of the CIDR block.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that lists the CIDR blocks.

" - } - }, - "com.amazonaws.route53#CidrCollection": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.route53#ARN", - "traits": { - "smithy.api#documentation": "

The ARN of the collection. Can be used to reference the collection in IAM policy or in\n\t\t\tanother Amazon Web Services account.

" - } - }, - "Id": { - "target": "com.amazonaws.route53#UUID", - "traits": { - "smithy.api#documentation": "

The unique ID of the CIDR collection.

" - } - }, - "Name": { - "target": "com.amazonaws.route53#CollectionName", - "traits": { - "smithy.api#documentation": "

The name of a CIDR collection.

" - } - }, - "Version": { - "target": "com.amazonaws.route53#CollectionVersion", - "traits": { - "smithy.api#documentation": "

A sequential counter that Route 53 sets to 1 when you create a CIDR\n\t\t\tcollection and increments by 1 each time you update settings for the CIDR\n\t\t\tcollection.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex\n\t\t\ttype that\n\t\t\tidentifies a CIDR collection.

" - } - }, - "com.amazonaws.route53#CidrCollectionAlreadyExistsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

A CIDR collection with this name and a different caller reference already exists in this account.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#CidrCollectionChange": { - "type": "structure", - "members": { - "LocationName": { - "target": "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed", - "traits": { - "smithy.api#documentation": "

Name of the location that is associated with the CIDR collection.

", - "smithy.api#required": {} - } - }, - "Action": { - "target": "com.amazonaws.route53#CidrCollectionChangeAction", - "traits": { - "smithy.api#documentation": "

CIDR collection change action.

", - "smithy.api#required": {} - } - }, - "CidrList": { - "target": "com.amazonaws.route53#CidrList", - "traits": { - "smithy.api#documentation": "

List of CIDR blocks.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the CIDR collection change.

" - } - }, - "com.amazonaws.route53#CidrCollectionChangeAction": { - "type": "enum", - "members": { - "PUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PUT" - } - }, - "DELETE_IF_EXISTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_IF_EXISTS" - } - } - } - }, - "com.amazonaws.route53#CidrCollectionChanges": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#CidrCollectionChange" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.route53#CidrCollectionInUseException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

This CIDR collection is in use, and isn't empty.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#CidrCollectionVersionMismatchException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The CIDR collection version you provided, doesn't match the one in the\n\t\t\t\tListCidrCollections operation.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.route53#CidrList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#Cidr", - "traits": { - "smithy.api#xmlName": "Cidr" - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.route53#CidrLocationNameDefaultAllowed": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16 - }, - "smithy.api#pattern": "^[0-9A-Za-z_\\-\\*]+$" - } - }, - "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16 - }, - "smithy.api#pattern": "^[0-9A-Za-z_\\-]+$" - } - }, - "com.amazonaws.route53#CidrNonce": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^\\p{ASCII}+$" - } - }, - "com.amazonaws.route53#CidrRoutingConfig": { - "type": "structure", - "members": { - "CollectionId": { - "target": "com.amazonaws.route53#UUID", - "traits": { - "smithy.api#documentation": "

The CIDR collection ID.

", - "smithy.api#required": {} - } - }, - "LocationName": { - "target": "com.amazonaws.route53#CidrLocationNameDefaultAllowed", - "traits": { - "smithy.api#documentation": "

The CIDR collection location name.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The object that is specified in resource record set object when you are linking a\n\t\t\tresource record set to a CIDR location.

\n

A LocationName with an asterisk “*” can be used to create a default CIDR\n\t\t\trecord. CollectionId is still required for default record.

" - } - }, - "com.amazonaws.route53#CloudWatchAlarmConfiguration": { - "type": "structure", - "members": { - "EvaluationPeriods": { - "target": "com.amazonaws.route53#EvaluationPeriods", - "traits": { - "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the number of periods\n\t\t\tthat the metric is compared to the threshold.

", - "smithy.api#required": {} - } - }, - "Threshold": { - "target": "com.amazonaws.route53#Threshold", - "traits": { - "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the value the metric is\n\t\t\tcompared with.

", - "smithy.api#required": {} - } - }, - "ComparisonOperator": { - "target": "com.amazonaws.route53#ComparisonOperator", - "traits": { - "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the arithmetic operation\n\t\t\tthat is used for the comparison.

", - "smithy.api#required": {} - } - }, - "Period": { - "target": "com.amazonaws.route53#Period", - "traits": { - "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the duration of one\n\t\t\tevaluation period in seconds.

", - "smithy.api#required": {} - } - }, - "MetricName": { - "target": "com.amazonaws.route53#MetricName", - "traits": { - "smithy.api#documentation": "

The name of the CloudWatch metric that the alarm is associated with.

", - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.route53#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace of the metric that the alarm is associated with. For more information,\n\t\t\tsee Amazon\n\t\t\t\tCloudWatch Namespaces, Dimensions, and Metrics Reference in the\n\t\t\t\tAmazon CloudWatch User Guide.

", - "smithy.api#required": {} - } - }, - "Statistic": { - "target": "com.amazonaws.route53#Statistic", - "traits": { - "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the statistic that is\n\t\t\tapplied to the metric.

", - "smithy.api#required": {} - } - }, - "Dimensions": { - "target": "com.amazonaws.route53#DimensionList", - "traits": { - "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, a complex type that\n\t\t\tcontains information about the dimensions for the metric. For information, see Amazon\n\t\t\t\tCloudWatch Namespaces, Dimensions, and Metrics Reference in the\n\t\t\t\tAmazon CloudWatch User Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the CloudWatch alarm that Amazon Route\n\t\t\t53 is monitoring for this health check.

" - } - }, - "com.amazonaws.route53#CloudWatchLogsLogGroupArn": { - "type": "string" - }, - "com.amazonaws.route53#CloudWatchRegion": { - "type": "enum", - "members": { - "us_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-1" - } - }, - "us_east_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-2" - } - }, - "us_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-1" - } - }, - "us_west_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-2" - } - }, - "ca_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ca-central-1" - } - }, - "eu_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-central-1" - } - }, - "eu_central_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-central-2" - } - }, - "eu_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-1" - } - }, - "eu_west_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-2" - } - }, - "eu_west_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-3" - } - }, - "ap_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-east-1" - } - }, - "me_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "me-south-1" - } - }, - "me_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "me-central-1" - } - }, - "ap_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-south-1" - } - }, - "ap_south_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-south-2" - } - }, - "ap_southeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-1" - } - }, - "ap_southeast_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-2" - } - }, - "ap_southeast_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-3" - } - }, - "ap_northeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-1" - } - }, - "ap_northeast_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-2" - } - }, - "ap_northeast_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-3" - } - }, - "eu_north_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-north-1" - } - }, - "sa_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sa-east-1" - } - }, - "cn_northwest_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cn-northwest-1" - } - }, - "cn_north_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cn-north-1" - } - }, - "af_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "af-south-1" - } - }, - "eu_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-south-1" - } - }, - "eu_south_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-south-2" - } - }, - "us_gov_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-gov-west-1" - } - }, - "us_gov_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-gov-east-1" - } - }, - "us_iso_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-iso-east-1" - } - }, - "us_iso_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-iso-west-1" - } - }, - "us_isob_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-isob-east-1" - } - }, - "ap_southeast_4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-4" - } - }, - "il_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "il-central-1" - } - }, - "ca_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ca-west-1" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#CollectionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[0-9A-Za-z_\\-]+$" - } - }, - "com.amazonaws.route53#CollectionSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#CollectionSummary" - } - }, - "com.amazonaws.route53#CollectionSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.route53#ARN", - "traits": { - "smithy.api#documentation": "

The ARN of the collection summary. Can be used to reference the collection in IAM\n\t\t\tpolicy or cross-account.

" - } - }, - "Id": { - "target": "com.amazonaws.route53#UUID", - "traits": { - "smithy.api#documentation": "

Unique ID for the CIDR collection.

" - } - }, - "Name": { - "target": "com.amazonaws.route53#CollectionName", - "traits": { - "smithy.api#documentation": "

The name of a CIDR collection.

" - } - }, - "Version": { - "target": "com.amazonaws.route53#CollectionVersion", - "traits": { - "smithy.api#documentation": "

A sequential counter that Route 53 sets to 1 when you create a CIDR\n\t\t\tcollection and increments by 1 each time you update settings for the CIDR\n\t\t\tcollection.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that is an entry in an CidrCollection\n\t\t\tarray.

" - } - }, - "com.amazonaws.route53#CollectionVersion": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.route53#ComparisonOperator": { - "type": "enum", - "members": { - "GreaterThanOrEqualToThreshold": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GreaterThanOrEqualToThreshold" - } - }, - "GreaterThanThreshold": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GreaterThanThreshold" - } - }, - "LessThanThreshold": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LessThanThreshold" - } - }, - "LessThanOrEqualToThreshold": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LessThanOrEqualToThreshold" - } - } - } - }, - "com.amazonaws.route53#ConcurrentModification": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Another user submitted a request to create, update, or delete the object at the same\n\t\t\ttime that you did. Retry the request.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#ConflictingDomainExists": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The cause of this error depends on the operation that you're performing:

\n ", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#ConflictingTypes": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

You tried to update a traffic policy instance by using a traffic policy version that\n\t\t\thas a different DNS type than the current type for the instance. You specified the type\n\t\t\tin the JSON document in the CreateTrafficPolicy or\n\t\t\t\tCreateTrafficPolicyVersionrequest.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#Coordinates": { - "type": "structure", - "members": { - "Latitude": { - "target": "com.amazonaws.route53#Latitude", - "traits": { - "smithy.api#documentation": "

Specifies a coordinate of the north–south position of a geographic point on the surface of\n\t\t\tthe Earth (-90 - 90).

", - "smithy.api#required": {} - } - }, - "Longitude": { - "target": "com.amazonaws.route53#Longitude", - "traits": { - "smithy.api#documentation": "

Specifies a coordinate of the east–west position of a geographic point on the surface of\n\t\t\tthe Earth (-180 - 180).

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

\n\t\t\tA complex type that lists the coordinates for a geoproximity resource record.\n\t\t

" - } - }, - "com.amazonaws.route53#CreateCidrCollection": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateCidrCollectionRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateCidrCollectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#CidrCollectionAlreadyExistsException" - }, - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#LimitsExceeded" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a CIDR collection in the current Amazon Web Services account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/cidrcollection", - "code": 201 - } - } - }, - "com.amazonaws.route53#CreateCidrCollectionRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.route53#CollectionName", - "traits": { - "smithy.api#documentation": "

A unique identifier for the account that can be used to reference the collection from\n\t\t\tother API calls.

", - "smithy.api#required": {} - } - }, - "CallerReference": { - "target": "com.amazonaws.route53#CidrNonce", - "traits": { - "smithy.api#documentation": "

A client-specific token that allows requests to be securely retried so that the\n\t\t\tintended outcome will only occur once, retries receive a similar response, and there are\n\t\t\tno additional edge cases to handle.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#CreateCidrCollectionResponse": { - "type": "structure", - "members": { - "Collection": { - "target": "com.amazonaws.route53#CidrCollection", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the CIDR collection.

" - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "

A unique URL that represents the location for the CIDR collection.

", - "smithy.api#httpHeader": "Location" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#CreateHealthCheck": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateHealthCheckRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateHealthCheckResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#HealthCheckAlreadyExists" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#TooManyHealthChecks" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new health check.

\n

For information about adding health checks to resource record sets, see HealthCheckId in ChangeResourceRecordSets.

\n

\n ELB Load Balancers\n

\n

If you're registering EC2 instances with an Elastic Load Balancing (ELB) load\n\t\t\tbalancer, do not create Amazon Route 53 health checks for the EC2 instances. When you\n\t\t\tregister an EC2 instance with a load balancer, you configure settings for an ELB health\n\t\t\tcheck, which performs a similar function to a Route 53 health check.

\n

\n Private Hosted Zones\n

\n

You can associate health checks with failover resource record sets in a private hosted\n\t\t\tzone. Note the following:

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/healthcheck", - "code": 201 - } - } - }, - "com.amazonaws.route53#CreateHealthCheckRequest": { - "type": "structure", - "members": { - "CallerReference": { - "target": "com.amazonaws.route53#HealthCheckNonce", - "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and that allows you to retry a failed\n\t\t\t\tCreateHealthCheck request without the risk of creating two identical\n\t\t\thealth checks:

\n \n

Route 53 does not store the CallerReference for a deleted health check indefinitely. \n\t\t\tThe CallerReference for a deleted health check will be deleted after a number of days.

", - "smithy.api#required": {} - } - }, - "HealthCheckConfig": { - "target": "com.amazonaws.route53#HealthCheckConfig", - "traits": { - "smithy.api#documentation": "

A complex type that contains settings for a new health check.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the health check request information.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#CreateHealthCheckResponse": { - "type": "structure", - "members": { - "HealthCheck": { - "target": "com.amazonaws.route53#HealthCheck", - "traits": { - "smithy.api#documentation": "

A complex type that contains identifying information about the health check.

", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "

The unique URL representing the new health check.

", - "smithy.api#httpHeader": "Location", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type containing the response information for the new health check.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#CreateHostedZone": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateHostedZoneRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateHostedZoneResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConflictingDomainExists" - }, - { - "target": "com.amazonaws.route53#DelegationSetNotAvailable" - }, - { - "target": "com.amazonaws.route53#DelegationSetNotReusable" + ], + "traits": { + "smithy.api#documentation": "

Adds, edits, or deletes tags for a health check or a hosted zone.

\n

For information about using tags for cost allocation, see Using Cost Allocation\n\t\t\t\tTags in the Billing and Cost Management User Guide.

", + "smithy.api#examples": [ + { + "title": "To add or remove tags from a hosted zone or health check", + "documentation": "The following example adds two tags and removes one tag from the hosted zone with ID Z3M3LMPEXAMPLE.", + "input": { + "ResourceType": "hostedzone", + "ResourceId": "Z3M3LMPEXAMPLE", + "AddTags": [ + { + "Key": "apex", + "Value": "3874" + }, + { + "Key": "acme", + "Value": "4938" + } + ], + "RemoveTagKeys": [ + "Nadir" + ] + }, + "output": {} + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/tags/{ResourceType}/{ResourceId}", + "code": 200 + } + } }, - { - "target": "com.amazonaws.route53#HostedZoneAlreadyExists" + "com.amazonaws.route53#ChangeTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.route53#TagResourceType", + "traits": { + "smithy.api#documentation": "

The type of the resource.

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.route53#TagResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the resource for which you want to add, change, or delete tags.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AddTags": { + "target": "com.amazonaws.route53#TagList", + "traits": { + "smithy.api#documentation": "

A complex type that contains a list of the tags that you want to add to the specified\n\t\t\thealth check or hosted zone and/or the tags that you want to edit Value\n\t\t\tfor.

\n

You can add a maximum of 10 tags to a health check or a hosted zone.

" + } + }, + "RemoveTagKeys": { + "target": "com.amazonaws.route53#TagKeyList", + "traits": { + "smithy.api#documentation": "

A complex type that contains a list of the tags that you want to delete from the\n\t\t\tspecified health check or hosted zone. You can specify up to 10 keys.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the tags that you want to add, edit, or\n\t\t\tdelete.

", + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.route53#InvalidDomainName" + "com.amazonaws.route53#ChangeTagsForResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Empty response for the request.

", + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.route53#InvalidInput" + "com.amazonaws.route53#Changes": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#Change", + "traits": { + "smithy.api#xmlName": "Change" + } + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } }, - { - "target": "com.amazonaws.route53#InvalidVPCId" + "com.amazonaws.route53#CheckerIpRanges": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#IPAddressCidr" + } }, - { - "target": "com.amazonaws.route53#NoSuchDelegationSet" + "com.amazonaws.route53#ChildHealthCheckList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#HealthCheckId", + "traits": { + "smithy.api#xmlName": "ChildHealthCheck" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } }, - { - "target": "com.amazonaws.route53#TooManyHostedZones" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new public or private hosted zone. You create records in a public hosted\n\t\t\tzone to define how you want to route traffic on the internet for a domain, such as\n\t\t\texample.com, and its subdomains (apex.example.com, acme.example.com). You create records\n\t\t\tin a private hosted zone to define how you want to route traffic for a domain and its\n\t\t\tsubdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).

\n \n

You can't convert a public hosted zone to a private hosted zone or vice versa.\n\t\t\t\tInstead, you must create a new hosted zone with the same name and create new\n\t\t\t\tresource record sets.

\n \n

For more information about charges for hosted zones, see Amazon Route 53 Pricing.

\n

Note the following:

\n \n

When you submit a CreateHostedZone request, the initial status of the\n\t\t\thosted zone is PENDING. For public hosted zones, this means that the NS and\n\t\t\tSOA records are not yet available on all Route 53 DNS servers. When the NS and\n\t\t\tSOA records are available, the status of the zone changes to INSYNC.

\n

The CreateHostedZone request requires the caller to have an\n\t\t\t\tec2:DescribeVpcs permission.

\n \n

When creating private hosted zones, the Amazon VPC must belong to the same\n\t\t\t\tpartition where the hosted zone is created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one\n\t\t\t\tpartition.

\n

The following are the supported partitions:

\n \n

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/hostedzone", - "code": 201 - } - } - }, - "com.amazonaws.route53#CreateHostedZoneRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

The name of the domain. Specify a fully qualified domain name, for example,\n\t\t\t\twww.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that\n\t\t\t\tRoute 53 treats www.example.com (without a trailing\n\t\t\tdot) and www.example.com. (with a trailing dot) as\n\t\t\tidentical.

\n

If you're creating a public hosted zone, this is the name you have registered with\n\t\t\tyour DNS registrar. If your domain name is registered with a registrar other than\n\t\t\t\tRoute 53, change the name servers for your domain to the set of\n\t\t\t\tNameServers that CreateHostedZone returns in\n\t\t\t\tDelegationSet.

", - "smithy.api#required": {} - } - }, - "VPC": { - "target": "com.amazonaws.route53#VPC", - "traits": { - "smithy.api#documentation": "

(Private hosted zones only) A complex type that contains information about the Amazon\n\t\t\tVPC that you're associating with this hosted zone.

\n

You can specify only one Amazon VPC when you create a private hosted zone. If you are\n\t\t\tassociating a VPC with a hosted zone with this request, the paramaters\n\t\t\t\tVPCId and VPCRegion are also required.

\n

To associate additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone after you create a hosted zone.

" - } - }, - "CallerReference": { - "target": "com.amazonaws.route53#Nonce", - "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and that allows failed\n\t\t\t\tCreateHostedZone requests to be retried without the risk of executing\n\t\t\tthe operation twice. You must use a unique CallerReference string every\n\t\t\ttime you submit a CreateHostedZone request. CallerReference\n\t\t\tcan be any unique string, for example, a date/time stamp.

", - "smithy.api#required": {} - } - }, - "HostedZoneConfig": { - "target": "com.amazonaws.route53#HostedZoneConfig", - "traits": { - "smithy.api#documentation": "

(Optional) A complex type that contains the following optional values:

\n \n

If you don't specify a comment or the PrivateZone element, omit\n\t\t\t\tHostedZoneConfig and the other elements.

" - } - }, - "DelegationSetId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

If you want to associate a reusable delegation set with this hosted zone, the ID that\n\t\t\t\tAmazon Route 53 assigned to the reusable delegation set when you created it.\n\t\t\tFor more information about reusable delegation sets, see CreateReusableDelegationSet.

\n

If you are using a reusable delegation set to create a public hosted zone for a subdomain,\n\t\t\tmake sure that the parent hosted zone doesn't use one or more of the same name servers.\n\t\t\tIf you have overlapping nameservers, the operation will cause a\n\t\t\t\tConflictingDomainsExist error.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the request to create a public or\n\t\t\tprivate hosted zone.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#CreateHostedZoneResponse": { - "type": "structure", - "members": { - "HostedZone": { - "target": "com.amazonaws.route53#HostedZone", - "traits": { - "smithy.api#documentation": "

A complex type that contains general information about the hosted zone.

", - "smithy.api#required": {} - } - }, - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the CreateHostedZone\n\t\t\trequest.

", - "smithy.api#required": {} - } - }, - "DelegationSet": { - "target": "com.amazonaws.route53#DelegationSet", - "traits": { - "smithy.api#documentation": "

A complex type that describes the name servers for this hosted zone.

", - "smithy.api#required": {} - } - }, - "VPC": { - "target": "com.amazonaws.route53#VPC", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about an Amazon VPC that you associated with\n\t\t\tthis hosted zone.

" - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "

The unique URL representing the new hosted zone.

", - "smithy.api#httpHeader": "Location", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type containing the response information for the hosted zone.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#CreateKeySigningKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateKeySigningKeyRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateKeySigningKeyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" + "com.amazonaws.route53#Cidr": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "\\S" + } }, - { - "target": "com.amazonaws.route53#InvalidArgument" + "com.amazonaws.route53#CidrBlockInUseException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

This CIDR block is already in use.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.route53#InvalidInput" + "com.amazonaws.route53#CidrBlockSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#CidrBlockSummary" + } }, - { - "target": "com.amazonaws.route53#InvalidKeySigningKeyName" + "com.amazonaws.route53#CidrBlockSummary": { + "type": "structure", + "members": { + "CidrBlock": { + "target": "com.amazonaws.route53#Cidr", + "traits": { + "smithy.api#documentation": "

Value for the CIDR block.

" + } + }, + "LocationName": { + "target": "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed", + "traits": { + "smithy.api#documentation": "

The location name of the CIDR block.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that lists the CIDR blocks.

" + } }, - { - "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + "com.amazonaws.route53#CidrCollection": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.route53#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the collection. Can be used to reference the collection in IAM policy or in\n\t\t\tanother Amazon Web Services account.

" + } + }, + "Id": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "

The unique ID of the CIDR collection.

" + } + }, + "Name": { + "target": "com.amazonaws.route53#CollectionName", + "traits": { + "smithy.api#documentation": "

The name of a CIDR collection.

" + } + }, + "Version": { + "target": "com.amazonaws.route53#CollectionVersion", + "traits": { + "smithy.api#documentation": "

A sequential counter that Route 53 sets to 1 when you create a CIDR\n\t\t\tcollection and increments by 1 each time you update settings for the CIDR\n\t\t\tcollection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex\n\t\t\ttype that\n\t\t\tidentifies a CIDR collection.

" + } }, - { - "target": "com.amazonaws.route53#InvalidKMSArn" + "com.amazonaws.route53#CidrCollectionAlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

A CIDR collection with this name and a different caller reference already exists in this account.

", + "smithy.api#error": "client" + } }, - { - "target": "com.amazonaws.route53#InvalidSigningStatus" + "com.amazonaws.route53#CidrCollectionChange": { + "type": "structure", + "members": { + "LocationName": { + "target": "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed", + "traits": { + "smithy.api#documentation": "

Name of the location that is associated with the CIDR collection.

", + "smithy.api#required": {} + } + }, + "Action": { + "target": "com.amazonaws.route53#CidrCollectionChangeAction", + "traits": { + "smithy.api#documentation": "

CIDR collection change action.

", + "smithy.api#required": {} + } + }, + "CidrList": { + "target": "com.amazonaws.route53#CidrList", + "traits": { + "smithy.api#documentation": "

List of CIDR blocks.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the CIDR collection change.

" + } }, - { - "target": "com.amazonaws.route53#KeySigningKeyAlreadyExists" + "com.amazonaws.route53#CidrCollectionChangeAction": { + "type": "enum", + "members": { + "PUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUT" + } + }, + "DELETE_IF_EXISTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IF_EXISTS" + } + } + } }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" + "com.amazonaws.route53#CidrCollectionChanges": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#CidrCollectionChange" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } }, - { - "target": "com.amazonaws.route53#TooManyKeySigningKeys" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new key-signing key (KSK) associated with a hosted zone. You can only have\n\t\t\ttwo KSKs per hosted zone.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/keysigningkey", - "code": 201 - } - } - }, - "com.amazonaws.route53#CreateKeySigningKeyRequest": { - "type": "structure", - "members": { - "CallerReference": { - "target": "com.amazonaws.route53#Nonce", - "traits": { - "smithy.api#documentation": "

A unique string that identifies the request.

", - "smithy.api#required": {} - } - }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The unique string (ID) used to identify a hosted zone.

", - "smithy.api#required": {} - } - }, - "KeyManagementServiceArn": { - "target": "com.amazonaws.route53#SigningKeyString", - "traits": { - "smithy.api#documentation": "

The Amazon resource name (ARN) for a customer managed key in Key Management Service\n\t\t\t\t(KMS). The KeyManagementServiceArn must be unique for\n\t\t\teach key-signing key (KSK) in a single hosted zone. To see an example of\n\t\t\t\tKeyManagementServiceArn that grants the correct permissions for DNSSEC,\n\t\t\tscroll down to Example.

\n

You must configure the customer managed customer managed key as follows:

\n
\n
Status
\n
\n

Enabled

\n
\n
Key spec
\n
\n

ECC_NIST_P256

\n
\n
Key usage
\n
\n

Sign and verify

\n
\n
Key policy
\n
\n

The key policy must give permission for the following actions:

\n
    \n
  • \n

    DescribeKey

    \n
    • \n
  • \n

    GetPublicKey

    \n
    • \n
  • \n

    Sign

    \n
    • \n
\n

The key policy must also include the Amazon Route 53 service in the\n\t\t\t\t\t\tprincipal for your account. Specify the following:

\n
    \n
  • \n

    \n \"Service\": \"dnssec-route53.amazonaws.com\"\n

    \n
    • \n
\n
\n
\n

For more information about working with a customer managed key in KMS, see Key Management Service concepts.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.route53#SigningKeyName", - "traits": { - "smithy.api#documentation": "

A string used to identify a key-signing key (KSK). Name can include\n\t\t\tnumbers, letters, and underscores (_). Name must be unique for each\n\t\t\tkey-signing key in the same hosted zone.

", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.route53#SigningKeyStatus", - "traits": { - "smithy.api#documentation": "

A string specifying the initial status of the key-signing key (KSK). You can set the\n\t\t\tvalue to ACTIVE or INACTIVE.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#CreateKeySigningKeyResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#required": {} - } - }, - "KeySigningKey": { - "target": "com.amazonaws.route53#KeySigningKey", - "traits": { - "smithy.api#documentation": "

The key-signing key (KSK) that the request creates.

", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "

The unique URL representing the new key-signing key (KSK).

", - "smithy.api#httpHeader": "Location", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#CreateQueryLoggingConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateQueryLoggingConfigRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateQueryLoggingConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InsufficientCloudWatchLogsResourcePolicy" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchCloudWatchLogsLogGroup" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#QueryLoggingConfigAlreadyExists" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a configuration for DNS query logging. After you create a query logging\n\t\t\tconfiguration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs\n\t\t\tlog group.

\n

DNS query logs contain information about the queries that Route 53 receives for a\n\t\t\tspecified public hosted zone, such as the following:

\n \n
\n
Log Group and Resource Policy
\n
\n

Before you create a query logging configuration, perform the following\n\t\t\t\t\t\toperations.

\n \n

If you create a query logging configuration using the Route 53\n\t\t\t\t\t\t\tconsole, Route 53 performs these operations automatically.

\n \n
    \n
  1. \n

    Create a CloudWatch Logs log group, and make note of the ARN,\n\t\t\t\t\t\t\t\twhich you specify when you create a query logging configuration.\n\t\t\t\t\t\t\t\tNote the following:

    \n
      \n
    • \n

      You must create the log group in the us-east-1\n\t\t\t\t\t\t\t\t\t\tregion.

      \n
      • \n
    • \n

      You must use the same Amazon Web Services account to create\n\t\t\t\t\t\t\t\t\t\tthe log group and the hosted zone that you want to configure\n\t\t\t\t\t\t\t\t\t\tquery logging for.

      \n
      • \n
    • \n

      When you create log groups for query logging, we recommend\n\t\t\t\t\t\t\t\t\t\tthat you use a consistent prefix, for example:

      \n

      \n /aws/route53/hosted zone\n\t\t\t\t\t\t\t\t\t\t\tname\n \n

      \n

      In the next step, you'll create a resource policy, which\n\t\t\t\t\t\t\t\t\t\tcontrols access to one or more log groups and the associated\n\t\t\t\t\t\t\t\t\t\t\tAmazon Web Services resources, such as Route 53 hosted\n\t\t\t\t\t\t\t\t\t\tzones. There's a limit on the number of resource policies\n\t\t\t\t\t\t\t\t\t\tthat you can create, so we recommend that you use a\n\t\t\t\t\t\t\t\t\t\tconsistent prefix so you can use the same resource policy\n\t\t\t\t\t\t\t\t\t\tfor all the log groups that you create for query\n\t\t\t\t\t\t\t\t\t\tlogging.

      \n
      • \n
    \n
    2. \n
  2. \n

    Create a CloudWatch Logs resource policy, and give it the\n\t\t\t\t\t\t\t\tpermissions that Route 53 needs to create log streams and to send\n\t\t\t\t\t\t\t\tquery logs to log streams. For the value of Resource,\n\t\t\t\t\t\t\t\tspecify the ARN for the log group that you created in the previous\n\t\t\t\t\t\t\t\tstep. To use the same resource policy for all the CloudWatch Logs\n\t\t\t\t\t\t\t\tlog groups that you created for query logging configurations,\n\t\t\t\t\t\t\t\treplace the hosted zone name with *, for\n\t\t\t\t\t\t\t\texample:

    \n

    \n arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*\n

    \n

    To avoid the confused deputy problem, a security issue where an\n\t\t\t\t\t\t\t\tentity without a permission for an action can coerce a\n\t\t\t\t\t\t\t\tmore-privileged entity to perform it, you can optionally limit the\n\t\t\t\t\t\t\t\tpermissions that a service has to a resource in a resource-based\n\t\t\t\t\t\t\t\tpolicy by supplying the following values:

    \n
      \n
    • \n

      For aws:SourceArn, supply the hosted zone ARN\n\t\t\t\t\t\t\t\t\t\tused in creating the query logging configuration. For\n\t\t\t\t\t\t\t\t\t\texample, aws:SourceArn:\n\t\t\t\t\t\t\t\t\t\t\tarn:aws:route53:::hostedzone/hosted zone\n\t\t\t\t\t\t\t\t\t\tID.

      \n
      • \n
    • \n

      For aws:SourceAccount, supply the account ID\n\t\t\t\t\t\t\t\t\t\tfor the account that creates the query logging\n\t\t\t\t\t\t\t\t\t\tconfiguration. For example,\n\t\t\t\t\t\t\t\t\t\t\taws:SourceAccount:111111111111.

      \n
      • \n
    \n

    For more information, see The confused\n\t\t\t\t\t\t\t\t\tdeputy problem in the Amazon Web Services\n\t\t\t\t\t\t\t\t\tIAM User Guide.

    \n \n

    You can't use the CloudWatch console to create or edit a\n\t\t\t\t\t\t\t\t\tresource policy. You must use the CloudWatch API, one of the\n\t\t\t\t\t\t\t\t\t\tAmazon Web Services SDKs, or the CLI.

    \n     \n
    3. \n
\n
\n
Log Streams and Edge Locations
\n
\n

When Route 53 finishes creating the configuration for DNS query logging,\n\t\t\t\t\t\tit does the following:

\n
    \n
  • \n

    Creates a log stream for an edge location the first time that the\n\t\t\t\t\t\t\t\tedge location responds to DNS queries for the specified hosted zone.\n\t\t\t\t\t\t\t\tThat log stream is used to log all queries that Route 53 responds to\n\t\t\t\t\t\t\t\tfor that edge location.

    \n
    • \n
  • \n

    Begins to send query logs to the applicable log stream.

    \n
    • \n
\n

The name of each log stream is in the following format:

\n

\n \n hosted zone ID/edge location\n\t\t\t\t\t\t\t\tcode\n \n

\n

The edge location code is a three-letter code and an arbitrarily assigned\n\t\t\t\t\t\tnumber, for example, DFW3. The three-letter code typically corresponds with\n\t\t\t\t\t\tthe International Air Transport Association airport code for an airport near\n\t\t\t\t\t\tthe edge location. (These abbreviations might change in the future.) For a\n\t\t\t\t\t\tlist of edge locations, see \"The Route 53 Global Network\" on the Route 53 Product Details\n\t\t\t\t\t\tpage.

\n
\n
Queries That Are Logged
\n
\n

Query logs contain only the queries that DNS resolvers forward to Route\n\t\t\t\t\t\t53. If a DNS resolver has already cached the response to a query (such as\n\t\t\t\t\t\tthe IP address for a load balancer for example.com), the resolver will\n\t\t\t\t\t\tcontinue to return the cached response. It doesn't forward another query to\n\t\t\t\t\t\tRoute 53 until the TTL for the corresponding resource record set expires.\n\t\t\t\t\t\tDepending on how many DNS queries are submitted for a resource record set,\n\t\t\t\t\t\tand depending on the TTL for that resource record set, query logs might\n\t\t\t\t\t\tcontain information about only one query out of every several thousand\n\t\t\t\t\t\tqueries that are submitted to DNS. For more information about how DNS works,\n\t\t\t\t\t\tsee Routing\n\t\t\t\t\t\t\tInternet Traffic to Your Website or Web Application in the\n\t\t\t\t\t\t\tAmazon Route 53 Developer Guide.

\n
\n
Log File Format
\n
\n

For a list of the values in each query log and the format of each value,\n\t\t\t\t\t\tsee Logging DNS\n\t\t\t\t\t\t\tQueries in the Amazon Route 53 Developer\n\t\t\t\t\t\t\tGuide.

\n
\n
Pricing
\n
\n

For information about charges for query logs, see Amazon CloudWatch Pricing.

\n
\n
How to Stop Logging
\n
\n

If you want Route 53 to stop sending query logs to CloudWatch Logs, delete\n\t\t\t\t\t\tthe query logging configuration. For more information, see DeleteQueryLoggingConfig.

\n
\n
", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/queryloggingconfig", - "code": 201 - } - } - }, - "com.amazonaws.route53#CreateQueryLoggingConfigRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that you want to log queries for. You can log queries only\n\t\t\tfor public hosted zones.

", - "smithy.api#required": {} - } - }, - "CloudWatchLogsLogGroupArn": { - "target": "com.amazonaws.route53#CloudWatchLogsLogGroupArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to\n\t\t\tsend query logs to. This is the format of the ARN:

\n

arn:aws:logs:region:account-id:log-group:log_group_name\n

\n

To get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups\n\t\t\tcommand, or the applicable command in one of the Amazon Web Services SDKs.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#CreateQueryLoggingConfigResponse": { - "type": "structure", - "members": { - "QueryLoggingConfig": { - "target": "com.amazonaws.route53#QueryLoggingConfig", - "traits": { - "smithy.api#documentation": "

A complex type that contains the ID for a query logging configuration, the ID of the\n\t\t\thosted zone that you want to log queries for, and the ARN for the log group that you\n\t\t\twant Amazon Route 53 to send query logs to.

", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "

The unique URL representing the new query logging configuration.

", - "smithy.api#httpHeader": "Location", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#CreateReusableDelegationSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateReusableDelegationSetRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateReusableDelegationSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#DelegationSetAlreadyCreated" - }, - { - "target": "com.amazonaws.route53#DelegationSetAlreadyReusable" - }, - { - "target": "com.amazonaws.route53#DelegationSetNotAvailable" - }, - { - "target": "com.amazonaws.route53#HostedZoneNotFound" - }, - { - "target": "com.amazonaws.route53#InvalidArgument" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#LimitsExceeded" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a delegation set (a group of four name servers) that can be reused by multiple\n\t\t\thosted zones that were created by the same Amazon Web Services account.

\n

You can also create a reusable delegation set that uses the four name servers that are\n\t\t\tassociated with an existing hosted zone. Specify the hosted zone ID in the\n\t\t\t\tCreateReusableDelegationSet request.

\n \n

You can't associate a reusable delegation set with a private hosted zone.

\n \n

For information about using a reusable delegation set to configure white label name\n\t\t\tservers, see Configuring White\n\t\t\t\tLabel Name Servers.

\n

The process for migrating existing hosted zones to use a reusable delegation set is\n\t\t\tcomparable to the process for configuring white label name servers. You need to perform\n\t\t\tthe following steps:

\n
    \n
  1. \n

    Create a reusable delegation set.

    \n
    2. \n
  2. \n

    Recreate hosted zones, and reduce the TTL to 60 seconds or less.

    \n
    3. \n
  3. \n

    Recreate resource record sets in the new hosted zones.

    \n
    4. \n
  4. \n

    Change the registrar's name servers to use the name servers for the new hosted\n\t\t\t\t\tzones.

    \n
    5. \n
  5. \n

    Monitor traffic for the website or application.

    \n
    6. \n
  6. \n

    Change TTLs back to their original values.

    \n
    7. \n
\n

If you want to migrate existing hosted zones to use a reusable delegation set, the\n\t\t\texisting hosted zones can't use any of the name servers that are assigned to the\n\t\t\treusable delegation set. If one or more hosted zones do use one or more name servers\n\t\t\tthat are assigned to the reusable delegation set, you can do one of the\n\t\t\tfollowing:

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/delegationset", - "code": 201 - } - } - }, - "com.amazonaws.route53#CreateReusableDelegationSetRequest": { - "type": "structure", - "members": { - "CallerReference": { - "target": "com.amazonaws.route53#Nonce", - "traits": { - "smithy.api#documentation": "

A unique string that identifies the request, and that allows you to retry failed\n\t\t\t\tCreateReusableDelegationSet requests without the risk of executing the\n\t\t\toperation twice. You must use a unique CallerReference string every time\n\t\t\tyou submit a CreateReusableDelegationSet request.\n\t\t\t\tCallerReference can be any unique string, for example a date/time\n\t\t\tstamp.

", - "smithy.api#required": {} - } - }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

If you want to mark the delegation set for an existing hosted zone as reusable, the ID\n\t\t\tfor that hosted zone.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#CreateReusableDelegationSetResponse": { - "type": "structure", - "members": { - "DelegationSet": { - "target": "com.amazonaws.route53#DelegationSet", - "traits": { - "smithy.api#documentation": "

A complex type that contains name server information.

", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "

The unique URL representing the new reusable delegation set.

", - "smithy.api#httpHeader": "Location", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#CreateTrafficPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateTrafficPolicyRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateTrafficPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidTrafficPolicyDocument" - }, - { - "target": "com.amazonaws.route53#TooManyTrafficPolicies" - }, - { - "target": "com.amazonaws.route53#TrafficPolicyAlreadyExists" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a traffic policy, which you use to create multiple DNS resource record sets\n\t\t\tfor one domain name (such as example.com) or one subdomain name (such as\n\t\t\twww.example.com).

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/trafficpolicy", - "code": 201 - } - } - }, - "com.amazonaws.route53#CreateTrafficPolicyInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateTrafficPolicyInstanceRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateTrafficPolicyInstanceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicy" - }, - { - "target": "com.amazonaws.route53#TooManyTrafficPolicyInstances" - }, - { - "target": "com.amazonaws.route53#TrafficPolicyInstanceAlreadyExists" - } - ], - "traits": { - "smithy.api#documentation": "

Creates resource record sets in a specified hosted zone based on the settings in a\n\t\t\tspecified traffic policy version. In addition, CreateTrafficPolicyInstance\n\t\t\tassociates the resource record sets with a specified domain name (such as example.com)\n\t\t\tor subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for\n\t\t\tthe domain or subdomain name by using the resource record sets that\n\t\t\t\tCreateTrafficPolicyInstance created.

\n \n

After you submit an CreateTrafficPolicyInstance request, there's a\n\t\t\t\tbrief delay while Amazon Route 53 creates the resource record sets that are\n\t\t\t\tspecified in the traffic policy definition. \n\t\t\t\tUse GetTrafficPolicyInstance with the id of new traffic policy instance to confirm that the CreateTrafficPolicyInstance\n\t\t\t\trequest completed successfully. For more information, see the\n\t\t\t\tState response element.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/trafficpolicyinstance", - "code": 201 - } - } - }, - "com.amazonaws.route53#CreateTrafficPolicyInstanceRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that you want Amazon Route 53 to create resource record sets\n\t\t\tin by using the configuration in a traffic policy.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

The domain name (such as example.com) or subdomain name (such as www.example.com) for\n\t\t\twhich Amazon Route 53 responds to DNS queries by using the resource record sets that\n\t\t\tRoute 53 creates for this traffic policy instance.

", - "smithy.api#required": {} - } - }, - "TTL": { - "target": "com.amazonaws.route53#TTL", - "traits": { - "smithy.api#documentation": "

(Optional) The TTL that you want Amazon Route 53 to assign to all of the resource\n\t\t\trecord sets that it creates in the specified hosted zone.

", - "smithy.api#required": {} - } - }, - "TrafficPolicyId": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

The ID of the traffic policy that you want to use to create resource record sets in\n\t\t\tthe specified hosted zone.

", - "smithy.api#required": {} - } - }, - "TrafficPolicyVersion": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", - "traits": { - "smithy.api#documentation": "

The version of the traffic policy that you want to use to create resource record sets\n\t\t\tin the specified hosted zone.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the resource record sets that you want\n\t\t\tto create based on a specified traffic policy.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#CreateTrafficPolicyInstanceResponse": { - "type": "structure", - "members": { - "TrafficPolicyInstance": { - "target": "com.amazonaws.route53#TrafficPolicyInstance", - "traits": { - "smithy.api#documentation": "

A complex type that contains settings for the new traffic policy instance.

", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "

A unique URL that represents a new traffic policy instance.

", - "smithy.api#httpHeader": "Location", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response information for the\n\t\t\t\tCreateTrafficPolicyInstance request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#CreateTrafficPolicyRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.route53#TrafficPolicyName", - "traits": { - "smithy.api#documentation": "

The name of the traffic policy.

", - "smithy.api#required": {} - } - }, - "Document": { - "target": "com.amazonaws.route53#TrafficPolicyDocument", - "traits": { - "smithy.api#documentation": "

The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format.

", - "smithy.api#required": {} - } - }, - "Comment": { - "target": "com.amazonaws.route53#TrafficPolicyComment", - "traits": { - "smithy.api#documentation": "

(Optional) Any comments that you want to include about the traffic policy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the traffic policy that you want to\n\t\t\tcreate.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#CreateTrafficPolicyResponse": { - "type": "structure", - "members": { - "TrafficPolicy": { - "target": "com.amazonaws.route53#TrafficPolicy", - "traits": { - "smithy.api#documentation": "

A complex type that contains settings for the new traffic policy.

", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "

A unique URL that represents a new traffic policy.

", - "smithy.api#httpHeader": "Location", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response information for the\n\t\t\t\tCreateTrafficPolicy request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#CreateTrafficPolicyVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateTrafficPolicyVersionRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateTrafficPolicyVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidTrafficPolicyDocument" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicy" - }, - { - "target": "com.amazonaws.route53#TooManyTrafficPolicyVersionsForCurrentPolicy" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new version of an existing traffic policy. When you create a new version of\n\t\t\ta traffic policy, you specify the ID of the traffic policy that you want to update and a\n\t\t\tJSON-formatted document that describes the new version. You use traffic policies to\n\t\t\tcreate multiple DNS resource record sets for one domain name (such as example.com) or\n\t\t\tone subdomain name (such as www.example.com). You can create a maximum of 1000 versions\n\t\t\tof a traffic policy. If you reach the limit and need to create another version, you'll\n\t\t\tneed to start a new traffic policy.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/trafficpolicy/{Id}", - "code": 201 - } - } - }, - "com.amazonaws.route53#CreateTrafficPolicyVersionRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

The ID of the traffic policy for which you want to create a new version.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Document": { - "target": "com.amazonaws.route53#TrafficPolicyDocument", - "traits": { - "smithy.api#documentation": "

The definition of this version of the traffic policy, in JSON format. You specified\n\t\t\tthe JSON in the CreateTrafficPolicyVersion request. For more information\n\t\t\tabout the JSON format, see CreateTrafficPolicy.

", - "smithy.api#required": {} - } - }, - "Comment": { - "target": "com.amazonaws.route53#TrafficPolicyComment", - "traits": { - "smithy.api#documentation": "

The comment that you specified in the CreateTrafficPolicyVersion request,\n\t\t\tif any.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the traffic policy that you want to\n\t\t\tcreate a new version for.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#CreateTrafficPolicyVersionResponse": { - "type": "structure", - "members": { - "TrafficPolicy": { - "target": "com.amazonaws.route53#TrafficPolicy", - "traits": { - "smithy.api#documentation": "

A complex type that contains settings for the new version of the traffic\n\t\t\tpolicy.

", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "

A unique URL that represents a new traffic policy version.

", - "smithy.api#httpHeader": "Location", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response information for the\n\t\t\t\tCreateTrafficPolicyVersion request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#CreateVPCAssociationAuthorization": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateVPCAssociationAuthorizationRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateVPCAssociationAuthorizationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidVPCId" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#TooManyVPCAssociationAuthorizations" - } - ], - "traits": { - "smithy.api#documentation": "

Authorizes the Amazon Web Services account that created a specified VPC to submit an\n\t\t\t\tAssociateVPCWithHostedZone request to associate the VPC with a\n\t\t\tspecified hosted zone that was created by a different account. To submit a\n\t\t\t\tCreateVPCAssociationAuthorization request, you must use the account\n\t\t\tthat created the hosted zone. After you authorize the association, use the account that\n\t\t\tcreated the VPC to submit an AssociateVPCWithHostedZone request.

\n \n

If you want to associate multiple VPCs that you created by using one account with\n\t\t\t\ta hosted zone that you created by using a different account, you must submit one\n\t\t\t\tauthorization request for each VPC.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/authorizevpcassociation", - "code": 200 - } - } - }, - "com.amazonaws.route53#CreateVPCAssociationAuthorizationRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the private hosted zone that you want to authorize associating a VPC\n\t\t\twith.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VPC": { - "target": "com.amazonaws.route53#VPC", - "traits": { - "smithy.api#documentation": "

A complex type that contains the VPC ID and region for the VPC that you want to\n\t\t\tauthorize associating with your hosted zone.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the request to authorize associating a\n\t\t\tVPC with your private hosted zone. Authorization is only required when a private hosted\n\t\t\tzone and a VPC were created by using different accounts.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#CreateVPCAssociationAuthorizationResponse": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that you authorized associating a VPC with.

", - "smithy.api#required": {} - } - }, - "VPC": { - "target": "com.amazonaws.route53#VPC", - "traits": { - "smithy.api#documentation": "

The VPC that you authorized associating with a hosted zone.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response information from a\n\t\t\t\tCreateVPCAssociationAuthorization request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#DNSName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.route53#DNSRCode": { - "type": "string" - }, - "com.amazonaws.route53#DNSSECNotFound": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The hosted zone doesn't have any DNSSEC resources.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#DNSSECStatus": { - "type": "structure", - "members": { - "ServeSignature": { - "target": "com.amazonaws.route53#ServeSignature", - "traits": { - "smithy.api#documentation": "

A string that represents the current hosted zone signing status.

\n

Status can have one of the following values:

\n
\n
SIGNING
\n
\n

DNSSEC signing is enabled for the hosted zone.

\n
\n
NOT_SIGNING
\n
\n

DNSSEC signing is not enabled for the hosted zone.

\n
\n
DELETING
\n
\n

DNSSEC signing is in the process of being removed for the hosted\n\t\t\t\t\t\tzone.

\n
\n
ACTION_NEEDED
\n
\n

There is a problem with signing in the hosted zone that requires you to\n\t\t\t\t\t\ttake action to resolve. For example, the customer managed key might have\n\t\t\t\t\t\tbeen deleted, or the permissions for the customer managed key might have\n\t\t\t\t\t\tbeen changed.

\n
\n
INTERNAL_FAILURE
\n
\n

There was an error during a request. Before you can continue to work with\n\t\t\t\t\t\tDNSSEC signing, including with key-signing keys (KSKs), you must correct the\n\t\t\t\t\t\tproblem by enabling or disabling DNSSEC signing for the hosted zone.

\n
\n
" - } - }, - "StatusMessage": { - "target": "com.amazonaws.route53#SigningKeyStatusMessage", - "traits": { - "smithy.api#documentation": "

The status message provided for the following DNSSEC signing status:\n\t\t\t\tINTERNAL_FAILURE. The status message includes information about what\n\t\t\tthe problem might be and steps that you can take to correct the issue.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A string representing the status of DNSSEC signing.

" - } - }, - "com.amazonaws.route53#DeactivateKeySigningKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeactivateKeySigningKeyRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeactivateKeySigningKeyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" - }, - { - "target": "com.amazonaws.route53#InvalidSigningStatus" - }, - { - "target": "com.amazonaws.route53#KeySigningKeyInParentDSRecord" - }, - { - "target": "com.amazonaws.route53#KeySigningKeyInUse" - }, - { - "target": "com.amazonaws.route53#NoSuchKeySigningKey" - } - ], - "traits": { - "smithy.api#documentation": "

Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC.\n\t\t\tThis operation changes the KSK status to INACTIVE.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/keysigningkey/{HostedZoneId}/{Name}/deactivate", - "code": 200 - } - } - }, - "com.amazonaws.route53#DeactivateKeySigningKeyRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.route53#SigningKeyName", - "traits": { - "smithy.api#documentation": "

A string used to identify a key-signing key (KSK).

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DeactivateKeySigningKeyResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#DelegationSet": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID that Amazon Route 53 assigns to a reusable delegation set.

" - } - }, - "CallerReference": { - "target": "com.amazonaws.route53#Nonce", - "traits": { - "smithy.api#documentation": "

The value that you specified for CallerReference when you created the\n\t\t\treusable delegation set.

" - } - }, - "NameServers": { - "target": "com.amazonaws.route53#DelegationSetNameServers", - "traits": { - "smithy.api#documentation": "

A complex type that contains a list of the authoritative name servers for a hosted\n\t\t\tzone or for a reusable delegation set.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that lists the name servers in a delegation set, as well as the\n\t\t\t\tCallerReference and the ID for the delegation set.

" - } - }, - "com.amazonaws.route53#DelegationSetAlreadyCreated": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A delegation set with the same owner and caller reference combination has already been\n\t\t\tcreated.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#DelegationSetAlreadyReusable": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The specified delegation set has already been marked as reusable.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#DelegationSetInUse": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The specified delegation contains associated hosted zones which must be deleted before\n\t\t\tthe reusable delegation set can be deleted.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#DelegationSetNameServers": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#xmlName": "NameServer" - } - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.route53#DelegationSetNotAvailable": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

You can create a hosted zone that has the same name as an existing hosted zone\n\t\t\t(example.com is common), but there is a limit to the number of hosted zones that have\n\t\t\tthe same name. If you get this error, Amazon Route 53 has reached that limit. If you own\n\t\t\tthe domain name and Route 53 generates this error, contact Customer Support.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#DelegationSetNotReusable": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A reusable delegation set with the specified ID does not exist.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#DelegationSets": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#DelegationSet", - "traits": { - "smithy.api#xmlName": "DelegationSet" - } - } - }, - "com.amazonaws.route53#DeleteCidrCollection": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteCidrCollectionRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteCidrCollectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#CidrCollectionInUseException" - }, - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchCidrCollectionException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a CIDR collection in the current Amazon Web Services account. The collection\n\t\t\tmust be empty before it can be deleted.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2013-04-01/cidrcollection/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#DeleteCidrCollectionRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#UUID", - "traits": { - "smithy.api#documentation": "

The UUID of the collection to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DeleteCidrCollectionResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#DeleteHealthCheck": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteHealthCheckRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteHealthCheckResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#HealthCheckInUse" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a health check.

\n \n

Amazon Route 53 does not prevent you from deleting a health check even if the\n\t\t\t\thealth check is associated with one or more resource record sets. If you delete a\n\t\t\t\thealth check and you don't update the associated resource record sets, the future\n\t\t\t\tstatus of the health check can't be predicted and may change. This will affect the\n\t\t\t\trouting of DNS queries for your DNS failover configuration. For more information,\n\t\t\t\tsee Replacing and Deleting Health Checks in the Amazon Route 53\n\t\t\t\t\tDeveloper Guide.

\n \n

If you're using Cloud Map and you configured Cloud Map to create a Route 53\n\t\t\thealth check when you register an instance, you can't use the Route 53\n\t\t\t\tDeleteHealthCheck command to delete the health check. The health check\n\t\t\tis deleted automatically when you deregister the instance; there can be a delay of\n\t\t\tseveral hours before the health check is deleted from Route 53.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2013-04-01/healthcheck/{HealthCheckId}", - "code": 200 - } - } - }, - "com.amazonaws.route53#DeleteHealthCheckRequest": { - "type": "structure", - "members": { - "HealthCheckId": { - "target": "com.amazonaws.route53#HealthCheckId", - "traits": { - "smithy.api#documentation": "

The ID of the health check that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

This action deletes a health check.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DeleteHealthCheckResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

An empty element.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#DeleteHostedZone": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteHostedZoneRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteHostedZoneResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#HostedZoneNotEmpty" - }, - { - "target": "com.amazonaws.route53#InvalidDomainName" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a hosted zone.

\n

If the hosted zone was created by another service, such as Cloud Map, see\n\t\t\t\tDeleting Public Hosted Zones That Were Created by Another Service in the\n\t\t\t\t\tAmazon Route 53 Developer Guide for information\n\t\t\tabout how to delete it. (The process is the same for public and private hosted zones\n\t\t\tthat were created by another service.)

\n

If you want to keep your domain registration but you want to stop routing internet\n\t\t\ttraffic to your website or web application, we recommend that you delete resource record\n\t\t\tsets in the hosted zone instead of deleting the hosted zone.

\n \n

If you delete a hosted zone, you can't undelete it. You must create a new hosted\n\t\t\t\tzone and update the name servers for your domain registration, which can require up\n\t\t\t\tto 48 hours to take effect. (If you delegated responsibility for a subdomain to a\n\t\t\t\thosted zone and you delete the child hosted zone, you must update the name servers\n\t\t\t\tin the parent hosted zone.) In addition, if you delete a hosted zone, someone could\n\t\t\t\thijack the domain and route traffic to their own resources using your domain\n\t\t\t\tname.

\n \n

If you want to avoid the monthly charge for the hosted zone, you can transfer DNS\n\t\t\tservice for the domain to a free DNS service. When you transfer DNS service, you have to\n\t\t\tupdate the name servers for the domain registration. If the domain is registered with\n\t\t\t\tRoute 53, see UpdateDomainNameservers for information about how to replace Route 53 name servers with name servers for the new DNS service. If the domain is\n\t\t\tregistered with another registrar, use the method provided by the registrar to update\n\t\t\tname servers for the domain registration. For more information, perform an internet\n\t\t\tsearch on \"free DNS service.\"

\n

You can delete a hosted zone only if it contains only the default SOA record and NS\n\t\t\tresource record sets. If the hosted zone contains other resource record sets, you must\n\t\t\tdelete them before you can delete the hosted zone. If you try to delete a hosted zone\n\t\t\tthat contains other resource record sets, the request fails, and Route 53\n\t\t\treturns a HostedZoneNotEmpty error. For information about deleting records\n\t\t\tfrom your hosted zone, see ChangeResourceRecordSets.

\n

To verify that the hosted zone has been deleted, do one of the following:

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2013-04-01/hostedzone/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#DeleteHostedZoneRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A request to delete a hosted zone.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DeleteHostedZoneResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#documentation": "

A complex type that contains the ID, the status, and the date and time of a request to\n\t\t\tdelete a hosted zone.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response to a DeleteHostedZone\n\t\t\trequest.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#DeleteKeySigningKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteKeySigningKeyRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteKeySigningKeyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" - }, - { - "target": "com.amazonaws.route53#InvalidKMSArn" - }, - { - "target": "com.amazonaws.route53#InvalidSigningStatus" - }, - { - "target": "com.amazonaws.route53#NoSuchKeySigningKey" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a key-signing key (KSK). Before you can delete a KSK, you must deactivate it.\n\t\t\tThe KSK must be deactivated before you can delete it regardless of whether the hosted\n\t\t\tzone is enabled for DNSSEC signing.

\n

You can use DeactivateKeySigningKey to deactivate the key before you delete it.

\n

Use GetDNSSEC to verify that the KSK is in an INACTIVE\n\t\t\tstatus.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2013-04-01/keysigningkey/{HostedZoneId}/{Name}", - "code": 200 - } - } - }, - "com.amazonaws.route53#DeleteKeySigningKeyRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.route53#SigningKeyName", - "traits": { - "smithy.api#documentation": "

A string used to identify a key-signing key (KSK).

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DeleteKeySigningKeyResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#DeleteQueryLoggingConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteQueryLoggingConfigRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteQueryLoggingConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchQueryLoggingConfig" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a configuration for DNS query logging. If you delete a configuration, Amazon\n\t\t\tRoute 53 stops sending query logs to CloudWatch Logs. Route 53 doesn't delete any logs\n\t\t\tthat are already in CloudWatch Logs.

\n

For more information about DNS query logs, see CreateQueryLoggingConfig.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2013-04-01/queryloggingconfig/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#DeleteQueryLoggingConfigRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#QueryLoggingConfigId", - "traits": { - "smithy.api#documentation": "

The ID of the configuration that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DeleteQueryLoggingConfigResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#DeleteReusableDelegationSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteReusableDelegationSetRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteReusableDelegationSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#DelegationSetInUse" - }, - { - "target": "com.amazonaws.route53#DelegationSetNotReusable" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchDelegationSet" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a reusable delegation set.

\n \n

You can delete a reusable delegation set only if it isn't associated with any\n\t\t\t\thosted zones.

\n \n

To verify that the reusable delegation set is not associated with any hosted zones,\n\t\t\tsubmit a GetReusableDelegationSet request and specify the ID of the reusable\n\t\t\tdelegation set that you want to delete.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2013-04-01/delegationset/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#DeleteReusableDelegationSetRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the reusable delegation set that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A request to delete a reusable delegation set.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DeleteReusableDelegationSetResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

An empty element.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#DeleteTrafficPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteTrafficPolicyRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteTrafficPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicy" - }, - { - "target": "com.amazonaws.route53#TrafficPolicyInUse" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a traffic policy.

\n

When you delete a traffic policy, Route 53 sets a flag on the policy to indicate that\n\t\t\tit has been deleted. However, Route 53 never fully deletes the traffic policy. Note the\n\t\t\tfollowing:

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2013-04-01/trafficpolicy/{Id}/{Version}", - "code": 200 - } - } - }, - "com.amazonaws.route53#DeleteTrafficPolicyInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteTrafficPolicyInstanceRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteTrafficPolicyInstanceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a traffic policy instance and all of the resource record sets that Amazon\n\t\t\tRoute 53 created when you created the instance.

\n \n

In the Route 53 console, traffic policy instances are known as policy\n\t\t\t\trecords.

\n ", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2013-04-01/trafficpolicyinstance/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#DeleteTrafficPolicyInstanceRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyInstanceId", - "traits": { - "smithy.api#documentation": "

The ID of the traffic policy instance that you want to delete.

\n \n

When you delete a traffic policy instance, Amazon Route 53 also deletes all of the\n\t\t\t\tresource record sets that were created when you created the traffic policy\n\t\t\t\tinstance.

\n ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A request to delete a specified traffic policy instance.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DeleteTrafficPolicyInstanceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

An empty element.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#DeleteTrafficPolicyRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

The ID of the traffic policy that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Version": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", - "traits": { - "smithy.api#documentation": "

The version number of the traffic policy that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A request to delete a specified traffic policy version.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DeleteTrafficPolicyResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

An empty element.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#DeleteVPCAssociationAuthorization": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteVPCAssociationAuthorizationRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteVPCAssociationAuthorizationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidVPCId" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#VPCAssociationAuthorizationNotFound" - } - ], - "traits": { - "smithy.api#documentation": "

Removes authorization to submit an AssociateVPCWithHostedZone request to\n\t\t\tassociate a specified VPC with a hosted zone that was created by a different account.\n\t\t\tYou must use the account that created the hosted zone to submit a\n\t\t\t\tDeleteVPCAssociationAuthorization request.

\n \n

Sending this request only prevents the Amazon Web Services account that created the\n\t\t\t\tVPC from associating the VPC with the Amazon Route 53 hosted zone in the future. If\n\t\t\t\tthe VPC is already associated with the hosted zone,\n\t\t\t\t\tDeleteVPCAssociationAuthorization won't disassociate the VPC from\n\t\t\t\tthe hosted zone. If you want to delete an existing association, use\n\t\t\t\t\tDisassociateVPCFromHostedZone.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/deauthorizevpcassociation", - "code": 200 - } - } - }, - "com.amazonaws.route53#DeleteVPCAssociationAuthorizationRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, the ID of the hosted zone.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VPC": { - "target": "com.amazonaws.route53#VPC", - "traits": { - "smithy.api#documentation": "

When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, a complex type that includes the ID and region of the\n\t\t\tVPC.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the request to remove authorization to\n\t\t\tassociate a VPC that was created by one Amazon Web Services account with a hosted zone\n\t\t\tthat was created with a different Amazon Web Services account.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DeleteVPCAssociationAuthorizationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Empty response for the request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#Dimension": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.route53#DimensionField", - "traits": { - "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the name of one\n\t\t\tdimension.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.route53#DimensionField", - "traits": { - "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the value of one\n\t\t\tdimension.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, a complex type that\n\t\t\tcontains information about one dimension.

" - } - }, - "com.amazonaws.route53#DimensionField": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.route53#DimensionList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#Dimension", - "traits": { - "smithy.api#xmlName": "Dimension" - } - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.route53#DisableHostedZoneDNSSEC": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DisableHostedZoneDNSSECRequest" - }, - "output": { - "target": "com.amazonaws.route53#DisableHostedZoneDNSSECResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#DNSSECNotFound" - }, - { - "target": "com.amazonaws.route53#InvalidArgument" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" - }, - { - "target": "com.amazonaws.route53#InvalidKMSArn" - }, - { - "target": "com.amazonaws.route53#KeySigningKeyInParentDSRecord" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - } - ], - "traits": { - "smithy.api#documentation": "

Disables DNSSEC signing in a specific hosted zone. This action does not deactivate any\n\t\t\tkey-signing keys (KSKs) that are active in the hosted zone.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/disable-dnssec", - "code": 200 - } - } - }, - "com.amazonaws.route53#DisableHostedZoneDNSSECRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DisableHostedZoneDNSSECResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#Disabled": { - "type": "boolean" - }, - "com.amazonaws.route53#DisassociateVPCComment": { - "type": "string" - }, - "com.amazonaws.route53#DisassociateVPCFromHostedZone": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DisassociateVPCFromHostedZoneRequest" - }, - "output": { - "target": "com.amazonaws.route53#DisassociateVPCFromHostedZoneResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidVPCId" - }, - { - "target": "com.amazonaws.route53#LastVPCAssociation" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#VPCAssociationNotFound" - } - ], - "traits": { - "smithy.api#documentation": "

Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53\n\t\t\tprivate hosted zone. Note the following:

\n \n \n

When revoking access, the hosted zone and the Amazon VPC must belong to\n\t\t\t\tthe same partition. A partition is a group of Amazon Web Services Regions. Each\n\t\t\t\t\tAmazon Web Services account is scoped to one partition.

\n

The following are the supported partitions:

\n \n

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/disassociatevpc", - "code": 200 - } - } - }, - "com.amazonaws.route53#DisassociateVPCFromHostedZoneRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the private hosted zone that you want to disassociate a VPC from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VPC": { - "target": "com.amazonaws.route53#VPC", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the VPC that you're disassociating from\n\t\t\tthe specified hosted zone.

", - "smithy.api#required": {} - } - }, - "Comment": { - "target": "com.amazonaws.route53#DisassociateVPCComment", - "traits": { - "smithy.api#documentation": "

\n Optional: A comment about the disassociation request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the VPC that you want to disassociate\n\t\t\tfrom a specified private hosted zone.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DisassociateVPCFromHostedZoneResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#documentation": "

A complex type that describes the changes made to the specified private hosted\n\t\t\tzone.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response information for the disassociate\n\t\t\trequest.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#EnableHostedZoneDNSSEC": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#EnableHostedZoneDNSSECRequest" - }, - "output": { - "target": "com.amazonaws.route53#EnableHostedZoneDNSSECResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" + "com.amazonaws.route53#CidrCollectionInUseException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

This CIDR collection is in use, and isn't empty.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.route53#DNSSECNotFound" + "com.amazonaws.route53#CidrCollectionVersionMismatchException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The CIDR collection version you provided, doesn't match the one in the\n\t\t\t\tListCidrCollections operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } }, - { - "target": "com.amazonaws.route53#HostedZonePartiallyDelegated" + "com.amazonaws.route53#CidrList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#Cidr", + "traits": { + "smithy.api#xmlName": "Cidr" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } }, - { - "target": "com.amazonaws.route53#InvalidArgument" + "com.amazonaws.route53#CidrLocationNameDefaultAllowed": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + }, + "smithy.api#pattern": "^[0-9A-Za-z_\\-\\*]+$" + } }, - { - "target": "com.amazonaws.route53#InvalidInput" + "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + }, + "smithy.api#pattern": "^[0-9A-Za-z_\\-]+$" + } }, - { - "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + "com.amazonaws.route53#CidrNonce": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^\\p{ASCII}+$" + } }, - { - "target": "com.amazonaws.route53#InvalidKMSArn" + "com.amazonaws.route53#CidrRoutingConfig": { + "type": "structure", + "members": { + "CollectionId": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "

The CIDR collection ID.

", + "smithy.api#required": {} + } + }, + "LocationName": { + "target": "com.amazonaws.route53#CidrLocationNameDefaultAllowed", + "traits": { + "smithy.api#documentation": "

The CIDR collection location name.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The object that is specified in resource record set object when you are linking a\n\t\t\tresource record set to a CIDR location.

\n

A LocationName with an asterisk “*” can be used to create a default CIDR\n\t\t\trecord. CollectionId is still required for default record.

" + } }, - { - "target": "com.amazonaws.route53#KeySigningKeyWithActiveStatusNotFound" + "com.amazonaws.route53#CloudWatchAlarmConfiguration": { + "type": "structure", + "members": { + "EvaluationPeriods": { + "target": "com.amazonaws.route53#EvaluationPeriods", + "traits": { + "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the number of periods\n\t\t\tthat the metric is compared to the threshold.

", + "smithy.api#required": {} + } + }, + "Threshold": { + "target": "com.amazonaws.route53#Threshold", + "traits": { + "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the value the metric is\n\t\t\tcompared with.

", + "smithy.api#required": {} + } + }, + "ComparisonOperator": { + "target": "com.amazonaws.route53#ComparisonOperator", + "traits": { + "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the arithmetic operation\n\t\t\tthat is used for the comparison.

", + "smithy.api#required": {} + } + }, + "Period": { + "target": "com.amazonaws.route53#Period", + "traits": { + "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the duration of one\n\t\t\tevaluation period in seconds.

", + "smithy.api#required": {} + } + }, + "MetricName": { + "target": "com.amazonaws.route53#MetricName", + "traits": { + "smithy.api#documentation": "

The name of the CloudWatch metric that the alarm is associated with.

", + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.route53#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the metric that the alarm is associated with. For more information,\n\t\t\tsee Amazon\n\t\t\t\tCloudWatch Namespaces, Dimensions, and Metrics Reference in the\n\t\t\t\tAmazon CloudWatch User Guide.

", + "smithy.api#required": {} + } + }, + "Statistic": { + "target": "com.amazonaws.route53#Statistic", + "traits": { + "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the statistic that is\n\t\t\tapplied to the metric.

", + "smithy.api#required": {} + } + }, + "Dimensions": { + "target": "com.amazonaws.route53#DimensionList", + "traits": { + "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, a complex type that\n\t\t\tcontains information about the dimensions for the metric. For information, see Amazon\n\t\t\t\tCloudWatch Namespaces, Dimensions, and Metrics Reference in the\n\t\t\t\tAmazon CloudWatch User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the CloudWatch alarm that Amazon Route\n\t\t\t53 is monitoring for this health check.

" + } }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - } - ], - "traits": { - "smithy.api#documentation": "

Enables DNSSEC signing in a specific hosted zone.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/enable-dnssec", - "code": 200 - } - } - }, - "com.amazonaws.route53#EnableHostedZoneDNSSECRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#EnableHostedZoneDNSSECResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#EnableSNI": { - "type": "boolean" - }, - "com.amazonaws.route53#ErrorMessage": { - "type": "string" - }, - "com.amazonaws.route53#ErrorMessages": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#xmlName": "Message" - } - } - }, - "com.amazonaws.route53#EvaluationPeriods": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.route53#FailureThreshold": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.route53#FullyQualifiedDomainName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.route53#GeoLocation": { - "type": "structure", - "members": { - "ContinentCode": { - "target": "com.amazonaws.route53#GeoLocationContinentCode", - "traits": { - "smithy.api#documentation": "

The two-letter code for the continent.

\n

Amazon Route 53 supports the following continent codes:

\n \n

Constraint: Specifying ContinentCode with either CountryCode\n\t\t\tor SubdivisionCode returns an InvalidInput error.

" - } - }, - "CountryCode": { - "target": "com.amazonaws.route53#GeoLocationCountryCode", - "traits": { - "smithy.api#documentation": "

For geolocation resource record sets, the two-letter code for a country.

\n

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1\n\t\t\t\talpha-2.

\n

Route 53 also supports the country code UA for\n\t\t\tUkraine.

" - } - }, - "SubdivisionCode": { - "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", - "traits": { - "smithy.api#documentation": "

For geolocation resource record sets, the two-letter code for a state of the United\n\t\t\tStates. Route 53 doesn't support any other values for SubdivisionCode. For\n\t\t\ta list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United\n\t\t\tStates Postal Service website.

\n

If you specify subdivisioncode, you must also specify US for\n\t\t\t\tCountryCode.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about a geographic location.

" - } - }, - "com.amazonaws.route53#GeoLocationContinentCode": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 2 - } - } - }, - "com.amazonaws.route53#GeoLocationContinentName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.route53#GeoLocationCountryCode": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2 - } - } - }, - "com.amazonaws.route53#GeoLocationCountryName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#GeoLocationDetails": { - "type": "structure", - "members": { - "ContinentCode": { - "target": "com.amazonaws.route53#GeoLocationContinentCode", - "traits": { - "smithy.api#documentation": "

The two-letter code for the continent.

" - } - }, - "ContinentName": { - "target": "com.amazonaws.route53#GeoLocationContinentName", - "traits": { - "smithy.api#documentation": "

The full name of the continent.

" - } - }, - "CountryCode": { - "target": "com.amazonaws.route53#GeoLocationCountryCode", - "traits": { - "smithy.api#documentation": "

The two-letter code for the country.

" - } - }, - "CountryName": { - "target": "com.amazonaws.route53#GeoLocationCountryName", - "traits": { - "smithy.api#documentation": "

The name of the country.

" - } - }, - "SubdivisionCode": { - "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", - "traits": { - "smithy.api#documentation": "

The code for the subdivision, such as a particular state within the United States. For\n\t\t\ta list of US state abbreviations, see Appendix B: Two–Letter State and\n\t\t\t\tPossession Abbreviations on the United States Postal Service website. For a\n\t\t\tlist of all supported subdivision codes, use the ListGeoLocations\n\t\t\tAPI.

" - } - }, - "SubdivisionName": { - "target": "com.amazonaws.route53#GeoLocationSubdivisionName", - "traits": { - "smithy.api#documentation": "

The full name of the subdivision. Route 53 currently supports only states in the\n\t\t\tUnited States.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the codes and full continent, country, and subdivision\n\t\t\tnames for the specified geolocation code.

" - } - }, - "com.amazonaws.route53#GeoLocationDetailsList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#GeoLocationDetails", - "traits": { - "smithy.api#xmlName": "GeoLocationDetails" - } - } - }, - "com.amazonaws.route53#GeoLocationSubdivisionCode": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 3 - } - } - }, - "com.amazonaws.route53#GeoLocationSubdivisionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#GeoProximityLocation": { - "type": "structure", - "members": { - "AWSRegion": { - "target": "com.amazonaws.route53#AWSRegion", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region the resource you are directing DNS traffic to, is in.

" - } - }, - "LocalZoneGroup": { - "target": "com.amazonaws.route53#LocalZoneGroup", - "traits": { - "smithy.api#documentation": "

\n\t\t\tSpecifies an Amazon Web Services Local Zone Group.\n\t\t

\n

A local Zone Group is usually the Local Zone code without the ending character. For example, \n\t\t\tif the Local Zone is us-east-1-bue-1a the Local Zone Group is us-east-1-bue-1.

\n

You can identify the Local Zones Group for a specific Local Zone by using the describe-availability-zones CLI command:

\n

This command returns: \"GroupName\": \"us-west-2-den-1\", specifying that the Local Zone us-west-2-den-1a \n\t\t\tbelongs to the Local Zone Group us-west-2-den-1.

" - } - }, - "Coordinates": { - "target": "com.amazonaws.route53#Coordinates", - "traits": { - "smithy.api#documentation": "

Contains the longitude and latitude for a geographic region.

" - } - }, - "Bias": { - "target": "com.amazonaws.route53#Bias", - "traits": { - "smithy.api#documentation": "

\n\t\t\tThe bias increases or decreases the size of the geographic region from which Route 53 routes traffic to a resource.\n\t\t

\n

To use Bias to change the size of the geographic region, specify the \n\t\t\tapplicable value for the bias:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

(Resource record sets only): A complex type that lets you specify where your resources are\n\t\t\tlocated. Only one of LocalZoneGroup, Coordinates, or\n\t\t\t\t\tAmazon Web ServicesRegion is allowed per request at a time.

\n

For more information about geoproximity routing, see Geoproximity routing in the\n\t\t\t\t\tAmazon Route 53 Developer Guide.

" - } - }, - "com.amazonaws.route53#GetAccountLimit": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetAccountLimitRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetAccountLimitResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the specified limit for the current account, for example, the maximum number of\n\t\t\thealth checks that you can create using the account.

\n

For the default limit, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide. To request a higher limit,\n\t\t\t\topen a case.

\n \n

You can also view account limits in Amazon Web Services Trusted Advisor. Sign in to\n\t\t\t\tthe Amazon Web Services Management Console and open the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/. Then choose Service limits in the navigation pane.

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/accountlimit/{Type}", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetAccountLimitRequest": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.route53#AccountLimitType", - "traits": { - "smithy.api#documentation": "

The limit that you want to get. Valid values include the following:

\n ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the request to create a hosted\n\t\t\tzone.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetAccountLimitResponse": { - "type": "structure", - "members": { - "Limit": { - "target": "com.amazonaws.route53#AccountLimit", - "traits": { - "smithy.api#documentation": "

The current setting for the specified limit. For example, if you specified\n\t\t\t\tMAX_HEALTH_CHECKS_BY_OWNER for the value of Type in the\n\t\t\trequest, the value of Limit is the maximum number of health checks that you\n\t\t\tcan create using the current account.

", - "smithy.api#required": {} - } - }, - "Count": { - "target": "com.amazonaws.route53#UsageCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The current number of entities that you have created of the specified type. For\n\t\t\texample, if you specified MAX_HEALTH_CHECKS_BY_OWNER for the value of\n\t\t\t\tType in the request, the value of Count is the current\n\t\t\tnumber of health checks that you have created using the current account.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the requested limit.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetChange": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetChangeRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetChangeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchChange" - } - ], - "traits": { - "smithy.api#documentation": "

Returns the current status of a change batch request. The status is one of the\n\t\t\tfollowing values:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/change/{Id}", - "code": 200 - }, - "smithy.waiters#waitable": { - "ResourceRecordSetsChanged": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "ChangeInfo.Status", - "expected": "INSYNC", - "comparator": "stringEquals" - } - } - } - ], - "minDelay": 30 - } - } - } - }, - "com.amazonaws.route53#GetChangeRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ChangeId", - "traits": { - "smithy.api#documentation": "

The ID of the change batch request. The value that you specify here is the value that\n\t\t\t\tChangeResourceRecordSets returned in the Id element when\n\t\t\tyou submitted the request.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The input for a GetChange request.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetChangeResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the specified change batch.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the ChangeInfo element.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetCheckerIpRanges": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetCheckerIpRangesRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetCheckerIpRangesResponse" - }, - "traits": { - "smithy.api#documentation": "

Route 53 does not perform authorization for this API because it retrieves information\n\t\t\tthat is already available to the public.

\n \n

\n GetCheckerIpRanges still works, but we recommend that you download\n\t\t\t\tip-ranges.json, which includes IP address ranges for all Amazon Web Services\n\t\t\t\tservices. For more information, see IP Address Ranges\n\t\t\t\t\tof Amazon Route 53 Servers in the Amazon Route 53 Developer\n\t\t\t\t\tGuide.

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/checkeripranges", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetCheckerIpRangesRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Empty request.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetCheckerIpRangesResponse": { - "type": "structure", - "members": { - "CheckerIpRanges": { - "target": "com.amazonaws.route53#CheckerIpRanges", - "traits": { - "smithy.api#documentation": "

A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route\n\t\t\t53 health checkers.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the CheckerIpRanges element.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetDNSSEC": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetDNSSECRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetDNSSECResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidArgument" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about DNSSEC for a specific hosted zone, including the key-signing\n\t\t\tkeys (KSKs) in the hosted zone.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/dnssec", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetDNSSECRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetDNSSECResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.route53#DNSSECStatus", - "traits": { - "smithy.api#documentation": "

A string representing the status of DNSSEC.

", - "smithy.api#required": {} - } - }, - "KeySigningKeys": { - "target": "com.amazonaws.route53#KeySigningKeys", - "traits": { - "smithy.api#documentation": "

The key-signing keys (KSKs) in your account.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetGeoLocation": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetGeoLocationRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetGeoLocationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchGeoLocation" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about whether a specified geographic location is supported for Amazon\n\t\t\tRoute 53 geolocation resource record sets.

\n

Route 53 does not perform authorization for this API because it retrieves information\n\t\t\tthat is already available to the public.

\n

Use the following syntax to determine whether a continent is supported for\n\t\t\tgeolocation:

\n

\n GET /2013-04-01/geolocation?continentcode=two-letter abbreviation for\n\t\t\t\t\ta continent\n \n

\n

Use the following syntax to determine whether a country is supported for\n\t\t\tgeolocation:

\n

\n GET /2013-04-01/geolocation?countrycode=two-character country\n\t\t\t\t\tcode\n \n

\n

Use the following syntax to determine whether a subdivision of a country is supported\n\t\t\tfor geolocation:

\n

\n GET /2013-04-01/geolocation?countrycode=two-character country\n\t\t\t\t\tcode&subdivisioncode=subdivision\n\t\t\tcode\n \n

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/geolocation", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetGeoLocationRequest": { - "type": "structure", - "members": { - "ContinentCode": { - "target": "com.amazonaws.route53#GeoLocationContinentCode", - "traits": { - "smithy.api#documentation": "

For geolocation resource record sets, a two-letter abbreviation that identifies a\n\t\t\tcontinent. Amazon Route 53 supports the following continent codes:

\n ", - "smithy.api#httpQuery": "continentcode" - } - }, - "CountryCode": { - "target": "com.amazonaws.route53#GeoLocationCountryCode", - "traits": { - "smithy.api#documentation": "

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1\n\t\t\t\talpha-2.

\n

Route 53 also supports the country code UA for\n\t\t\tUkraine.

", - "smithy.api#httpQuery": "countrycode" - } - }, - "SubdivisionCode": { - "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", - "traits": { - "smithy.api#documentation": "

The code for the subdivision, such as a particular state within the United States. For\n\t\t\ta list of US state abbreviations, see Appendix B: Two–Letter State and\n\t\t\t\tPossession Abbreviations on the United States Postal Service website. For a\n\t\t\tlist of all supported subdivision codes, use the ListGeoLocations\n\t\t\tAPI.

", - "smithy.api#httpQuery": "subdivisioncode" - } - } - }, - "traits": { - "smithy.api#documentation": "

A request for information about whether a specified geographic location is supported\n\t\t\tfor Amazon Route 53 geolocation resource record sets.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetGeoLocationResponse": { - "type": "structure", - "members": { - "GeoLocationDetails": { - "target": "com.amazonaws.route53#GeoLocationDetails", - "traits": { - "smithy.api#documentation": "

A complex type that contains the codes and full continent, country, and subdivision\n\t\t\tnames for the specified geolocation code.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response information for the specified geolocation\n\t\t\tcode.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetHealthCheck": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetHealthCheckRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetHealthCheckResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#IncompatibleVersion" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about a specified health check.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/healthcheck/{HealthCheckId}", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetHealthCheckCount": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetHealthCheckCountRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetHealthCheckCountResponse" - }, - "traits": { - "smithy.api#documentation": "

Retrieves the number of health checks that are associated with the current Amazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/healthcheckcount", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetHealthCheckCountRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

A request for the number of health checks that are associated with the current Amazon Web Services account.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetHealthCheckCountResponse": { - "type": "structure", - "members": { - "HealthCheckCount": { - "target": "com.amazonaws.route53#HealthCheckCount", - "traits": { - "smithy.api#documentation": "

The number of health checks associated with the current Amazon Web Services account.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response to a GetHealthCheckCount\n\t\t\trequest.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetHealthCheckLastFailureReason": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetHealthCheckLastFailureReasonRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetHealthCheckLastFailureReasonResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the reason that a specified health check failed most recently.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/healthcheck/{HealthCheckId}/lastfailurereason", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetHealthCheckLastFailureReasonRequest": { - "type": "structure", - "members": { - "HealthCheckId": { - "target": "com.amazonaws.route53#HealthCheckId", - "traits": { - "smithy.api#documentation": "

The ID for the health check for which you want the last failure reason. When you\n\t\t\tcreated the health check, CreateHealthCheck returned the ID in the\n\t\t\tresponse, in the HealthCheckId element.

\n \n

If you want to get the last failure reason for a calculated health check, you must\n\t\t\t\tuse the Amazon Route 53 console or the CloudWatch console. You can't use\n\t\t\t\t\tGetHealthCheckLastFailureReason for a calculated health\n\t\t\t\tcheck.

\n ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A request for the reason that a health check failed most recently.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetHealthCheckLastFailureReasonResponse": { - "type": "structure", - "members": { - "HealthCheckObservations": { - "target": "com.amazonaws.route53#HealthCheckObservations", - "traits": { - "smithy.api#documentation": "

A list that contains one Observation element for each Amazon Route 53\n\t\t\thealth checker that is reporting a last failure reason.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response to a\n\t\t\t\tGetHealthCheckLastFailureReason request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetHealthCheckRequest": { - "type": "structure", - "members": { - "HealthCheckId": { - "target": "com.amazonaws.route53#HealthCheckId", - "traits": { - "smithy.api#documentation": "

The identifier that Amazon Route 53 assigned to the health check when you created it.\n\t\t\tWhen you add or update a resource record set, you use this value to specify which health\n\t\t\tcheck to use. The value can be up to 64 characters long.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A request to get information about a specified health check.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetHealthCheckResponse": { - "type": "structure", - "members": { - "HealthCheck": { - "target": "com.amazonaws.route53#HealthCheck", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about one health check that is associated\n\t\t\twith the current Amazon Web Services account.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response to a GetHealthCheck\n\t\t\trequest.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetHealthCheckStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetHealthCheckStatusRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetHealthCheckStatusResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - } - ], - "traits": { - "smithy.api#documentation": "

Gets status of a specified health check.

\n \n

This API is intended for use during development to diagnose behavior. It doesn’t\n\t\t\t\tsupport production use-cases with high query rates that require immediate and\n\t\t\t\tactionable responses.

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/healthcheck/{HealthCheckId}/status", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetHealthCheckStatusRequest": { - "type": "structure", - "members": { - "HealthCheckId": { - "target": "com.amazonaws.route53#HealthCheckId", - "traits": { - "smithy.api#documentation": "

The ID for the health check that you want the current status for. When you created the\n\t\t\thealth check, CreateHealthCheck returned the ID in the response, in the\n\t\t\t\tHealthCheckId element.

\n \n

If you want to check the status of a calculated health check, you must use the\n\t\t\t\tAmazon Route 53 console or the CloudWatch console. You can't use\n\t\t\t\t\tGetHealthCheckStatus to get the status of a calculated health\n\t\t\t\tcheck.

\n ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A request to get the status for a health check.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetHealthCheckStatusResponse": { - "type": "structure", - "members": { - "HealthCheckObservations": { - "target": "com.amazonaws.route53#HealthCheckObservations", - "traits": { - "smithy.api#documentation": "

A list that contains one HealthCheckObservation element for each Amazon\n\t\t\tRoute 53 health checker that is reporting a status about the health check\n\t\t\tendpoint.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response to a GetHealthCheck\n\t\t\trequest.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetHostedZone": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetHostedZoneRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetHostedZoneResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about a specified hosted zone including the four name servers\n\t\t\tassigned to the hosted zone.

", - "smithy.api#examples": [ - { - "title": "To get information about a hosted zone", - "documentation": "The following example gets information about the Z3M3LMPEXAMPLE hosted zone.", + "com.amazonaws.route53#CloudWatchLogsLogGroupArn": { + "type": "string" + }, + "com.amazonaws.route53#CloudWatchRegion": { + "type": "enum", + "members": { + "us_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-1" + } + }, + "us_east_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-2" + } + }, + "us_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-1" + } + }, + "us_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-2" + } + }, + "ca_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca-central-1" + } + }, + "eu_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-1" + } + }, + "eu_central_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-2" + } + }, + "eu_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-1" + } + }, + "eu_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-2" + } + }, + "eu_west_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-3" + } + }, + "ap_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-east-1" + } + }, + "me_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "me-south-1" + } + }, + "me_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "me-central-1" + } + }, + "ap_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-1" + } + }, + "ap_south_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-2" + } + }, + "ap_southeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-1" + } + }, + "ap_southeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-2" + } + }, + "ap_southeast_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-3" + } + }, + "ap_northeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-1" + } + }, + "ap_northeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-2" + } + }, + "ap_northeast_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-3" + } + }, + "eu_north_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-north-1" + } + }, + "sa_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sa-east-1" + } + }, + "cn_northwest_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cn-northwest-1" + } + }, + "cn_north_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cn-north-1" + } + }, + "af_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "af-south-1" + } + }, + "eu_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-south-1" + } + }, + "eu_south_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-south-2" + } + }, + "us_gov_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-gov-west-1" + } + }, + "us_gov_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-gov-east-1" + } + }, + "us_iso_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-iso-east-1" + } + }, + "us_iso_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-iso-west-1" + } + }, + "us_isob_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-isob-east-1" + } + }, + "ap_southeast_4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-4" + } + }, + "il_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "il-central-1" + } + }, + "ca_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca-west-1" + } + }, + "ap_southeast_5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-5" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53#CollectionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9A-Za-z_\\-]+$" + } + }, + "com.amazonaws.route53#CollectionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#CollectionSummary" + } + }, + "com.amazonaws.route53#CollectionSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.route53#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the collection summary. Can be used to reference the collection in IAM\n\t\t\tpolicy or cross-account.

" + } + }, + "Id": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "

Unique ID for the CIDR collection.

" + } + }, + "Name": { + "target": "com.amazonaws.route53#CollectionName", + "traits": { + "smithy.api#documentation": "

The name of a CIDR collection.

" + } + }, + "Version": { + "target": "com.amazonaws.route53#CollectionVersion", + "traits": { + "smithy.api#documentation": "

A sequential counter that Route 53 sets to 1 when you create a CIDR\n\t\t\tcollection and increments by 1 each time you update settings for the CIDR\n\t\t\tcollection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that is an entry in an CidrCollection\n\t\t\tarray.

" + } + }, + "com.amazonaws.route53#CollectionVersion": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.route53#ComparisonOperator": { + "type": "enum", + "members": { + "GreaterThanOrEqualToThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThanOrEqualToThreshold" + } + }, + "GreaterThanThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThanThreshold" + } + }, + "LessThanThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThanThreshold" + } + }, + "LessThanOrEqualToThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThanOrEqualToThreshold" + } + } + } + }, + "com.amazonaws.route53#ConcurrentModification": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Another user submitted a request to create, update, or delete the object at the same\n\t\t\ttime that you did. Retry the request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#ConflictingDomainExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The cause of this error depends on the operation that you're performing:

\n ", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#ConflictingTypes": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

You tried to update a traffic policy instance by using a traffic policy version that\n\t\t\thas a different DNS type than the current type for the instance. You specified the type\n\t\t\tin the JSON document in the CreateTrafficPolicy or\n\t\t\t\tCreateTrafficPolicyVersionrequest.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#Coordinates": { + "type": "structure", + "members": { + "Latitude": { + "target": "com.amazonaws.route53#Latitude", + "traits": { + "smithy.api#documentation": "

Specifies a coordinate of the north–south position of a geographic point on the surface of\n\t\t\tthe Earth (-90 - 90).

", + "smithy.api#required": {} + } + }, + "Longitude": { + "target": "com.amazonaws.route53#Longitude", + "traits": { + "smithy.api#documentation": "

Specifies a coordinate of the east–west position of a geographic point on the surface of\n\t\t\tthe Earth (-180 - 180).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n\t\t\tA complex type that lists the coordinates for a geoproximity resource record.\n\t\t

" + } + }, + "com.amazonaws.route53#CreateCidrCollection": { + "type": "operation", "input": { - "Id": "Z3M3LMPEXAMPLE" + "target": "com.amazonaws.route53#CreateCidrCollectionRequest" }, "output": { - "HostedZone": { - "ResourceRecordSetCount": 8, - "CallerReference": "C741617D-04E4-F8DE-B9D7-0D150FC61C2E", - "Config": { - "PrivateZone": false - }, - "Id": "/hostedzone/Z3M3LMPEXAMPLE", - "Name": "myawsbucket.com." - }, - "DelegationSet": { - "NameServers": [ - "ns-2048.awsdns-64.com", - "ns-2049.awsdns-65.net", - "ns-2050.awsdns-66.org", - "ns-2051.awsdns-67.co.uk" - ] - } + "target": "com.amazonaws.route53#CreateCidrCollectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#CidrCollectionAlreadyExistsException" + }, + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#LimitsExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a CIDR collection in the current Amazon Web Services account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/cidrcollection", + "code": 201 + } } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/hostedzone/{Id}", - "code": 200 }, - "smithy.test#smokeTests": [ - { - "id": "GetHostedZoneFailure", - "params": { - "Id": "fake-zone" + "com.amazonaws.route53#CreateCidrCollectionRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53#CollectionName", + "traits": { + "smithy.api#documentation": "

A unique identifier for the account that can be used to reference the collection from\n\t\t\tother API calls.

", + "smithy.api#required": {} + } + }, + "CallerReference": { + "target": "com.amazonaws.route53#CidrNonce", + "traits": { + "smithy.api#documentation": "

A client-specific token that allows requests to be securely retried so that the\n\t\t\tintended outcome will only occur once, retries receive a similar response, and there are\n\t\t\tno additional edge cases to handle.

", + "smithy.api#required": {} + } + } }, - "vendorParams": { - "region": "us-east-1" + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#CreateCidrCollectionResponse": { + "type": "structure", + "members": { + "Collection": { + "target": "com.amazonaws.route53#CidrCollection", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the CIDR collection.

" + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "

A unique URL that represents the location for the CIDR collection.

", + "smithy.api#httpHeader": "Location" + } + } }, - "vendorParamsShape": "aws.test#AwsVendorParams", - "expect": { - "failure": {} + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#CreateHealthCheck": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateHealthCheckRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateHealthCheckResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#HealthCheckAlreadyExists" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#TooManyHealthChecks" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new health check.

\n

For information about adding health checks to resource record sets, see HealthCheckId in ChangeResourceRecordSets.

\n

\n ELB Load Balancers\n

\n

If you're registering EC2 instances with an Elastic Load Balancing (ELB) load\n\t\t\tbalancer, do not create Amazon Route 53 health checks for the EC2 instances. When you\n\t\t\tregister an EC2 instance with a load balancer, you configure settings for an ELB health\n\t\t\tcheck, which performs a similar function to a Route 53 health check.

\n

\n Private Hosted Zones\n

\n

You can associate health checks with failover resource record sets in a private hosted\n\t\t\tzone. Note the following:

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/healthcheck", + "code": 201 + } + } + }, + "com.amazonaws.route53#CreateHealthCheckRequest": { + "type": "structure", + "members": { + "CallerReference": { + "target": "com.amazonaws.route53#HealthCheckNonce", + "traits": { + "smithy.api#documentation": "

A unique string that identifies the request and that allows you to retry a failed\n\t\t\t\tCreateHealthCheck request without the risk of creating two identical\n\t\t\thealth checks:

\n \n

Route 53 does not store the CallerReference for a deleted health check indefinitely. \n\t\t\tThe CallerReference for a deleted health check will be deleted after a number of days.

", + "smithy.api#required": {} + } + }, + "HealthCheckConfig": { + "target": "com.amazonaws.route53#HealthCheckConfig", + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for a new health check.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the health check request information.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#CreateHealthCheckResponse": { + "type": "structure", + "members": { + "HealthCheck": { + "target": "com.amazonaws.route53#HealthCheck", + "traits": { + "smithy.api#documentation": "

A complex type that contains identifying information about the health check.

", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "

The unique URL representing the new health check.

", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type containing the response information for the new health check.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#CreateHostedZone": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateHostedZoneRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateHostedZoneResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConflictingDomainExists" + }, + { + "target": "com.amazonaws.route53#DelegationSetNotAvailable" + }, + { + "target": "com.amazonaws.route53#DelegationSetNotReusable" + }, + { + "target": "com.amazonaws.route53#HostedZoneAlreadyExists" + }, + { + "target": "com.amazonaws.route53#InvalidDomainName" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidVPCId" + }, + { + "target": "com.amazonaws.route53#NoSuchDelegationSet" + }, + { + "target": "com.amazonaws.route53#TooManyHostedZones" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new public or private hosted zone. You create records in a public hosted\n\t\t\tzone to define how you want to route traffic on the internet for a domain, such as\n\t\t\texample.com, and its subdomains (apex.example.com, acme.example.com). You create records\n\t\t\tin a private hosted zone to define how you want to route traffic for a domain and its\n\t\t\tsubdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).

\n \n

You can't convert a public hosted zone to a private hosted zone or vice versa.\n\t\t\t\tInstead, you must create a new hosted zone with the same name and create new\n\t\t\t\tresource record sets.

\n \n

For more information about charges for hosted zones, see Amazon Route 53 Pricing.

\n

Note the following:

\n \n

When you submit a CreateHostedZone request, the initial status of the\n\t\t\thosted zone is PENDING. For public hosted zones, this means that the NS and\n\t\t\tSOA records are not yet available on all Route 53 DNS servers. When the NS and\n\t\t\tSOA records are available, the status of the zone changes to INSYNC.

\n

The CreateHostedZone request requires the caller to have an\n\t\t\t\tec2:DescribeVpcs permission.

\n \n

When creating private hosted zones, the Amazon VPC must belong to the same\n\t\t\t\tpartition where the hosted zone is created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one\n\t\t\t\tpartition.

\n

The following are the supported partitions:

\n \n

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/hostedzone", + "code": 201 + } + } + }, + "com.amazonaws.route53#CreateHostedZoneRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

The name of the domain. Specify a fully qualified domain name, for example,\n\t\t\t\twww.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that\n\t\t\t\tRoute 53 treats www.example.com (without a trailing\n\t\t\tdot) and www.example.com. (with a trailing dot) as\n\t\t\tidentical.

\n

If you're creating a public hosted zone, this is the name you have registered with\n\t\t\tyour DNS registrar. If your domain name is registered with a registrar other than\n\t\t\t\tRoute 53, change the name servers for your domain to the set of\n\t\t\t\tNameServers that CreateHostedZone returns in\n\t\t\t\tDelegationSet.

", + "smithy.api#required": {} + } + }, + "VPC": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#documentation": "

(Private hosted zones only) A complex type that contains information about the Amazon\n\t\t\tVPC that you're associating with this hosted zone.

\n

You can specify only one Amazon VPC when you create a private hosted zone. If you are\n\t\t\tassociating a VPC with a hosted zone with this request, the paramaters\n\t\t\t\tVPCId and VPCRegion are also required.

\n

To associate additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone after you create a hosted zone.

" + } + }, + "CallerReference": { + "target": "com.amazonaws.route53#Nonce", + "traits": { + "smithy.api#documentation": "

A unique string that identifies the request and that allows failed\n\t\t\t\tCreateHostedZone requests to be retried without the risk of executing\n\t\t\tthe operation twice. You must use a unique CallerReference string every\n\t\t\ttime you submit a CreateHostedZone request. CallerReference\n\t\t\tcan be any unique string, for example, a date/time stamp.

", + "smithy.api#required": {} + } + }, + "HostedZoneConfig": { + "target": "com.amazonaws.route53#HostedZoneConfig", + "traits": { + "smithy.api#documentation": "

(Optional) A complex type that contains the following optional values:

\n \n

If you don't specify a comment or the PrivateZone element, omit\n\t\t\t\tHostedZoneConfig and the other elements.

" + } + }, + "DelegationSetId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

If you want to associate a reusable delegation set with this hosted zone, the ID that\n\t\t\t\tAmazon Route 53 assigned to the reusable delegation set when you created it.\n\t\t\tFor more information about reusable delegation sets, see CreateReusableDelegationSet.

\n

If you are using a reusable delegation set to create a public hosted zone for a subdomain,\n\t\t\tmake sure that the parent hosted zone doesn't use one or more of the same name servers.\n\t\t\tIf you have overlapping nameservers, the operation will cause a\n\t\t\t\tConflictingDomainsExist error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the request to create a public or\n\t\t\tprivate hosted zone.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#CreateHostedZoneResponse": { + "type": "structure", + "members": { + "HostedZone": { + "target": "com.amazonaws.route53#HostedZone", + "traits": { + "smithy.api#documentation": "

A complex type that contains general information about the hosted zone.

", + "smithy.api#required": {} + } + }, + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the CreateHostedZone\n\t\t\trequest.

", + "smithy.api#required": {} + } + }, + "DelegationSet": { + "target": "com.amazonaws.route53#DelegationSet", + "traits": { + "smithy.api#documentation": "

A complex type that describes the name servers for this hosted zone.

", + "smithy.api#required": {} + } + }, + "VPC": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about an Amazon VPC that you associated with\n\t\t\tthis hosted zone.

" + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "

The unique URL representing the new hosted zone.

", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type containing the response information for the hosted zone.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#CreateKeySigningKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateKeySigningKeyRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateKeySigningKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidArgument" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyName" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + }, + { + "target": "com.amazonaws.route53#InvalidKMSArn" + }, + { + "target": "com.amazonaws.route53#InvalidSigningStatus" + }, + { + "target": "com.amazonaws.route53#KeySigningKeyAlreadyExists" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#TooManyKeySigningKeys" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new key-signing key (KSK) associated with a hosted zone. You can only have\n\t\t\ttwo KSKs per hosted zone.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/keysigningkey", + "code": 201 + } + } + }, + "com.amazonaws.route53#CreateKeySigningKeyRequest": { + "type": "structure", + "members": { + "CallerReference": { + "target": "com.amazonaws.route53#Nonce", + "traits": { + "smithy.api#documentation": "

A unique string that identifies the request.

", + "smithy.api#required": {} + } + }, + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The unique string (ID) used to identify a hosted zone.

", + "smithy.api#required": {} + } + }, + "KeyManagementServiceArn": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) for a customer managed key in Key Management Service\n\t\t\t\t(KMS). The KeyManagementServiceArn must be unique for\n\t\t\teach key-signing key (KSK) in a single hosted zone. To see an example of\n\t\t\t\tKeyManagementServiceArn that grants the correct permissions for DNSSEC,\n\t\t\tscroll down to Example.

\n

You must configure the customer managed customer managed key as follows:

\n
\n
Status
\n
\n

Enabled

\n
\n
Key spec
\n
\n

ECC_NIST_P256

\n
\n
Key usage
\n
\n

Sign and verify

\n
\n
Key policy
\n
\n

The key policy must give permission for the following actions:

\n
    \n
  • \n

    DescribeKey

    \n
    • \n
  • \n

    GetPublicKey

    \n
    • \n
  • \n

    Sign

    \n
    • \n
\n

The key policy must also include the Amazon Route 53 service in the\n\t\t\t\t\t\tprincipal for your account. Specify the following:

\n
    \n
  • \n

    \n \"Service\": \"dnssec-route53.amazonaws.com\"\n

    \n
    • \n
\n
\n
\n

For more information about working with a customer managed key in KMS, see Key Management Service concepts.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#SigningKeyName", + "traits": { + "smithy.api#documentation": "

A string used to identify a key-signing key (KSK). Name can include\n\t\t\tnumbers, letters, and underscores (_). Name must be unique for each\n\t\t\tkey-signing key in the same hosted zone.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.route53#SigningKeyStatus", + "traits": { + "smithy.api#documentation": "

A string specifying the initial status of the key-signing key (KSK). You can set the\n\t\t\tvalue to ACTIVE or INACTIVE.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#CreateKeySigningKeyResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#required": {} + } + }, + "KeySigningKey": { + "target": "com.amazonaws.route53#KeySigningKey", + "traits": { + "smithy.api#documentation": "

The key-signing key (KSK) that the request creates.

", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "

The unique URL representing the new key-signing key (KSK).

", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#CreateQueryLoggingConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateQueryLoggingConfigRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateQueryLoggingConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InsufficientCloudWatchLogsResourcePolicy" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchCloudWatchLogsLogGroup" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#QueryLoggingConfigAlreadyExists" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a configuration for DNS query logging. After you create a query logging\n\t\t\tconfiguration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs\n\t\t\tlog group.

\n

DNS query logs contain information about the queries that Route 53 receives for a\n\t\t\tspecified public hosted zone, such as the following:

\n \n
\n
Log Group and Resource Policy
\n
\n

Before you create a query logging configuration, perform the following\n\t\t\t\t\t\toperations.

\n \n

If you create a query logging configuration using the Route 53\n\t\t\t\t\t\t\tconsole, Route 53 performs these operations automatically.

\n \n
    \n
  1. \n

    Create a CloudWatch Logs log group, and make note of the ARN,\n\t\t\t\t\t\t\t\twhich you specify when you create a query logging configuration.\n\t\t\t\t\t\t\t\tNote the following:

    \n
      \n
    • \n

      You must create the log group in the us-east-1\n\t\t\t\t\t\t\t\t\t\tregion.

      \n
      • \n
    • \n

      You must use the same Amazon Web Services account to create\n\t\t\t\t\t\t\t\t\t\tthe log group and the hosted zone that you want to configure\n\t\t\t\t\t\t\t\t\t\tquery logging for.

      \n
      • \n
    • \n

      When you create log groups for query logging, we recommend\n\t\t\t\t\t\t\t\t\t\tthat you use a consistent prefix, for example:

      \n

      \n /aws/route53/hosted zone\n\t\t\t\t\t\t\t\t\t\t\tname\n \n

      \n

      In the next step, you'll create a resource policy, which\n\t\t\t\t\t\t\t\t\t\tcontrols access to one or more log groups and the associated\n\t\t\t\t\t\t\t\t\t\t\tAmazon Web Services resources, such as Route 53 hosted\n\t\t\t\t\t\t\t\t\t\tzones. There's a limit on the number of resource policies\n\t\t\t\t\t\t\t\t\t\tthat you can create, so we recommend that you use a\n\t\t\t\t\t\t\t\t\t\tconsistent prefix so you can use the same resource policy\n\t\t\t\t\t\t\t\t\t\tfor all the log groups that you create for query\n\t\t\t\t\t\t\t\t\t\tlogging.

      \n
      • \n
    \n
    2. \n
  2. \n

    Create a CloudWatch Logs resource policy, and give it the\n\t\t\t\t\t\t\t\tpermissions that Route 53 needs to create log streams and to send\n\t\t\t\t\t\t\t\tquery logs to log streams. For the value of Resource,\n\t\t\t\t\t\t\t\tspecify the ARN for the log group that you created in the previous\n\t\t\t\t\t\t\t\tstep. To use the same resource policy for all the CloudWatch Logs\n\t\t\t\t\t\t\t\tlog groups that you created for query logging configurations,\n\t\t\t\t\t\t\t\treplace the hosted zone name with *, for\n\t\t\t\t\t\t\t\texample:

    \n

    \n arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*\n

    \n

    To avoid the confused deputy problem, a security issue where an\n\t\t\t\t\t\t\t\tentity without a permission for an action can coerce a\n\t\t\t\t\t\t\t\tmore-privileged entity to perform it, you can optionally limit the\n\t\t\t\t\t\t\t\tpermissions that a service has to a resource in a resource-based\n\t\t\t\t\t\t\t\tpolicy by supplying the following values:

    \n
      \n
    • \n

      For aws:SourceArn, supply the hosted zone ARN\n\t\t\t\t\t\t\t\t\t\tused in creating the query logging configuration. For\n\t\t\t\t\t\t\t\t\t\texample, aws:SourceArn:\n\t\t\t\t\t\t\t\t\t\t\tarn:aws:route53:::hostedzone/hosted zone\n\t\t\t\t\t\t\t\t\t\tID.

      \n
      • \n
    • \n

      For aws:SourceAccount, supply the account ID\n\t\t\t\t\t\t\t\t\t\tfor the account that creates the query logging\n\t\t\t\t\t\t\t\t\t\tconfiguration. For example,\n\t\t\t\t\t\t\t\t\t\t\taws:SourceAccount:111111111111.

      \n
      • \n
    \n

    For more information, see The confused\n\t\t\t\t\t\t\t\t\tdeputy problem in the Amazon Web Services\n\t\t\t\t\t\t\t\t\tIAM User Guide.

    \n \n

    You can't use the CloudWatch console to create or edit a\n\t\t\t\t\t\t\t\t\tresource policy. You must use the CloudWatch API, one of the\n\t\t\t\t\t\t\t\t\t\tAmazon Web Services SDKs, or the CLI.

    \n     \n
    3. \n
\n
\n
Log Streams and Edge Locations
\n
\n

When Route 53 finishes creating the configuration for DNS query logging,\n\t\t\t\t\t\tit does the following:

\n
    \n
  • \n

    Creates a log stream for an edge location the first time that the\n\t\t\t\t\t\t\t\tedge location responds to DNS queries for the specified hosted zone.\n\t\t\t\t\t\t\t\tThat log stream is used to log all queries that Route 53 responds to\n\t\t\t\t\t\t\t\tfor that edge location.

    \n
    • \n
  • \n

    Begins to send query logs to the applicable log stream.

    \n
    • \n
\n

The name of each log stream is in the following format:

\n

\n \n hosted zone ID/edge location\n\t\t\t\t\t\t\t\tcode\n \n

\n

The edge location code is a three-letter code and an arbitrarily assigned\n\t\t\t\t\t\tnumber, for example, DFW3. The three-letter code typically corresponds with\n\t\t\t\t\t\tthe International Air Transport Association airport code for an airport near\n\t\t\t\t\t\tthe edge location. (These abbreviations might change in the future.) For a\n\t\t\t\t\t\tlist of edge locations, see \"The Route 53 Global Network\" on the Route 53 Product Details\n\t\t\t\t\t\tpage.

\n
\n
Queries That Are Logged
\n
\n

Query logs contain only the queries that DNS resolvers forward to Route\n\t\t\t\t\t\t53. If a DNS resolver has already cached the response to a query (such as\n\t\t\t\t\t\tthe IP address for a load balancer for example.com), the resolver will\n\t\t\t\t\t\tcontinue to return the cached response. It doesn't forward another query to\n\t\t\t\t\t\tRoute 53 until the TTL for the corresponding resource record set expires.\n\t\t\t\t\t\tDepending on how many DNS queries are submitted for a resource record set,\n\t\t\t\t\t\tand depending on the TTL for that resource record set, query logs might\n\t\t\t\t\t\tcontain information about only one query out of every several thousand\n\t\t\t\t\t\tqueries that are submitted to DNS. For more information about how DNS works,\n\t\t\t\t\t\tsee Routing\n\t\t\t\t\t\t\tInternet Traffic to Your Website or Web Application in the\n\t\t\t\t\t\t\tAmazon Route 53 Developer Guide.

\n
\n
Log File Format
\n
\n

For a list of the values in each query log and the format of each value,\n\t\t\t\t\t\tsee Logging DNS\n\t\t\t\t\t\t\tQueries in the Amazon Route 53 Developer\n\t\t\t\t\t\t\tGuide.

\n
\n
Pricing
\n
\n

For information about charges for query logs, see Amazon CloudWatch Pricing.

\n
\n
How to Stop Logging
\n
\n

If you want Route 53 to stop sending query logs to CloudWatch Logs, delete\n\t\t\t\t\t\tthe query logging configuration. For more information, see DeleteQueryLoggingConfig.

\n
\n
", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/queryloggingconfig", + "code": 201 + } + } + }, + "com.amazonaws.route53#CreateQueryLoggingConfigRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that you want to log queries for. You can log queries only\n\t\t\tfor public hosted zones.

", + "smithy.api#required": {} + } + }, + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.route53#CloudWatchLogsLogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to\n\t\t\tsend query logs to. This is the format of the ARN:

\n

arn:aws:logs:region:account-id:log-group:log_group_name\n

\n

To get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups\n\t\t\tcommand, or the applicable command in one of the Amazon Web Services SDKs.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#CreateQueryLoggingConfigResponse": { + "type": "structure", + "members": { + "QueryLoggingConfig": { + "target": "com.amazonaws.route53#QueryLoggingConfig", + "traits": { + "smithy.api#documentation": "

A complex type that contains the ID for a query logging configuration, the ID of the\n\t\t\thosted zone that you want to log queries for, and the ARN for the log group that you\n\t\t\twant Amazon Route 53 to send query logs to.

", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "

The unique URL representing the new query logging configuration.

", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#CreateReusableDelegationSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateReusableDelegationSetRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateReusableDelegationSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#DelegationSetAlreadyCreated" + }, + { + "target": "com.amazonaws.route53#DelegationSetAlreadyReusable" + }, + { + "target": "com.amazonaws.route53#DelegationSetNotAvailable" + }, + { + "target": "com.amazonaws.route53#HostedZoneNotFound" + }, + { + "target": "com.amazonaws.route53#InvalidArgument" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#LimitsExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a delegation set (a group of four name servers) that can be reused by multiple\n\t\t\thosted zones that were created by the same Amazon Web Services account.

\n

You can also create a reusable delegation set that uses the four name servers that are\n\t\t\tassociated with an existing hosted zone. Specify the hosted zone ID in the\n\t\t\t\tCreateReusableDelegationSet request.

\n \n

You can't associate a reusable delegation set with a private hosted zone.

\n \n

For information about using a reusable delegation set to configure white label name\n\t\t\tservers, see Configuring White\n\t\t\t\tLabel Name Servers.

\n

The process for migrating existing hosted zones to use a reusable delegation set is\n\t\t\tcomparable to the process for configuring white label name servers. You need to perform\n\t\t\tthe following steps:

\n
    \n
  1. \n

    Create a reusable delegation set.

    \n
    2. \n
  2. \n

    Recreate hosted zones, and reduce the TTL to 60 seconds or less.

    \n
    3. \n
  3. \n

    Recreate resource record sets in the new hosted zones.

    \n
    4. \n
  4. \n

    Change the registrar's name servers to use the name servers for the new hosted\n\t\t\t\t\tzones.

    \n
    5. \n
  5. \n

    Monitor traffic for the website or application.

    \n
    6. \n
  6. \n

    Change TTLs back to their original values.

    \n
    7. \n
\n

If you want to migrate existing hosted zones to use a reusable delegation set, the\n\t\t\texisting hosted zones can't use any of the name servers that are assigned to the\n\t\t\treusable delegation set. If one or more hosted zones do use one or more name servers\n\t\t\tthat are assigned to the reusable delegation set, you can do one of the\n\t\t\tfollowing:

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/delegationset", + "code": 201 + } + } + }, + "com.amazonaws.route53#CreateReusableDelegationSetRequest": { + "type": "structure", + "members": { + "CallerReference": { + "target": "com.amazonaws.route53#Nonce", + "traits": { + "smithy.api#documentation": "

A unique string that identifies the request, and that allows you to retry failed\n\t\t\t\tCreateReusableDelegationSet requests without the risk of executing the\n\t\t\toperation twice. You must use a unique CallerReference string every time\n\t\t\tyou submit a CreateReusableDelegationSet request.\n\t\t\t\tCallerReference can be any unique string, for example a date/time\n\t\t\tstamp.

", + "smithy.api#required": {} + } + }, + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

If you want to mark the delegation set for an existing hosted zone as reusable, the ID\n\t\t\tfor that hosted zone.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#CreateReusableDelegationSetResponse": { + "type": "structure", + "members": { + "DelegationSet": { + "target": "com.amazonaws.route53#DelegationSet", + "traits": { + "smithy.api#documentation": "

A complex type that contains name server information.

", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "

The unique URL representing the new reusable delegation set.

", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#CreateTrafficPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateTrafficPolicyRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateTrafficPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidTrafficPolicyDocument" + }, + { + "target": "com.amazonaws.route53#TooManyTrafficPolicies" + }, + { + "target": "com.amazonaws.route53#TrafficPolicyAlreadyExists" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a traffic policy, which you use to create multiple DNS resource record sets\n\t\t\tfor one domain name (such as example.com) or one subdomain name (such as\n\t\t\twww.example.com).

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/trafficpolicy", + "code": 201 + } + } + }, + "com.amazonaws.route53#CreateTrafficPolicyInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateTrafficPolicyInstanceRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateTrafficPolicyInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicy" + }, + { + "target": "com.amazonaws.route53#TooManyTrafficPolicyInstances" + }, + { + "target": "com.amazonaws.route53#TrafficPolicyInstanceAlreadyExists" + } + ], + "traits": { + "smithy.api#documentation": "

Creates resource record sets in a specified hosted zone based on the settings in a\n\t\t\tspecified traffic policy version. In addition, CreateTrafficPolicyInstance\n\t\t\tassociates the resource record sets with a specified domain name (such as example.com)\n\t\t\tor subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for\n\t\t\tthe domain or subdomain name by using the resource record sets that\n\t\t\t\tCreateTrafficPolicyInstance created.

\n \n

After you submit an CreateTrafficPolicyInstance request, there's a\n\t\t\t\tbrief delay while Amazon Route 53 creates the resource record sets that are\n\t\t\t\tspecified in the traffic policy definition. \n\t\t\t\tUse GetTrafficPolicyInstance with the id of new traffic policy instance to confirm that the CreateTrafficPolicyInstance\n\t\t\t\trequest completed successfully. For more information, see the\n\t\t\t\tState response element.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/trafficpolicyinstance", + "code": 201 + } + } + }, + "com.amazonaws.route53#CreateTrafficPolicyInstanceRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that you want Amazon Route 53 to create resource record sets\n\t\t\tin by using the configuration in a traffic policy.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

The domain name (such as example.com) or subdomain name (such as www.example.com) for\n\t\t\twhich Amazon Route 53 responds to DNS queries by using the resource record sets that\n\t\t\tRoute 53 creates for this traffic policy instance.

", + "smithy.api#required": {} + } + }, + "TTL": { + "target": "com.amazonaws.route53#TTL", + "traits": { + "smithy.api#documentation": "

(Optional) The TTL that you want Amazon Route 53 to assign to all of the resource\n\t\t\trecord sets that it creates in the specified hosted zone.

", + "smithy.api#required": {} + } + }, + "TrafficPolicyId": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

The ID of the traffic policy that you want to use to create resource record sets in\n\t\t\tthe specified hosted zone.

", + "smithy.api#required": {} + } + }, + "TrafficPolicyVersion": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "

The version of the traffic policy that you want to use to create resource record sets\n\t\t\tin the specified hosted zone.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the resource record sets that you want\n\t\t\tto create based on a specified traffic policy.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#CreateTrafficPolicyInstanceResponse": { + "type": "structure", + "members": { + "TrafficPolicyInstance": { + "target": "com.amazonaws.route53#TrafficPolicyInstance", + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for the new traffic policy instance.

", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "

A unique URL that represents a new traffic policy instance.

", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response information for the\n\t\t\t\tCreateTrafficPolicyInstance request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#CreateTrafficPolicyRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53#TrafficPolicyName", + "traits": { + "smithy.api#documentation": "

The name of the traffic policy.

", + "smithy.api#required": {} + } + }, + "Document": { + "target": "com.amazonaws.route53#TrafficPolicyDocument", + "traits": { + "smithy.api#documentation": "

The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format.

", + "smithy.api#required": {} + } + }, + "Comment": { + "target": "com.amazonaws.route53#TrafficPolicyComment", + "traits": { + "smithy.api#documentation": "

(Optional) Any comments that you want to include about the traffic policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the traffic policy that you want to\n\t\t\tcreate.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#CreateTrafficPolicyResponse": { + "type": "structure", + "members": { + "TrafficPolicy": { + "target": "com.amazonaws.route53#TrafficPolicy", + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for the new traffic policy.

", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "

A unique URL that represents a new traffic policy.

", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response information for the\n\t\t\t\tCreateTrafficPolicy request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#CreateTrafficPolicyVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateTrafficPolicyVersionRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateTrafficPolicyVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidTrafficPolicyDocument" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicy" + }, + { + "target": "com.amazonaws.route53#TooManyTrafficPolicyVersionsForCurrentPolicy" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new version of an existing traffic policy. When you create a new version of\n\t\t\ta traffic policy, you specify the ID of the traffic policy that you want to update and a\n\t\t\tJSON-formatted document that describes the new version. You use traffic policies to\n\t\t\tcreate multiple DNS resource record sets for one domain name (such as example.com) or\n\t\t\tone subdomain name (such as www.example.com). You can create a maximum of 1000 versions\n\t\t\tof a traffic policy. If you reach the limit and need to create another version, you'll\n\t\t\tneed to start a new traffic policy.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/trafficpolicy/{Id}", + "code": 201 + } + } + }, + "com.amazonaws.route53#CreateTrafficPolicyVersionRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

The ID of the traffic policy for which you want to create a new version.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Document": { + "target": "com.amazonaws.route53#TrafficPolicyDocument", + "traits": { + "smithy.api#documentation": "

The definition of this version of the traffic policy, in JSON format. You specified\n\t\t\tthe JSON in the CreateTrafficPolicyVersion request. For more information\n\t\t\tabout the JSON format, see CreateTrafficPolicy.

", + "smithy.api#required": {} + } + }, + "Comment": { + "target": "com.amazonaws.route53#TrafficPolicyComment", + "traits": { + "smithy.api#documentation": "

The comment that you specified in the CreateTrafficPolicyVersion request,\n\t\t\tif any.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the traffic policy that you want to\n\t\t\tcreate a new version for.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#CreateTrafficPolicyVersionResponse": { + "type": "structure", + "members": { + "TrafficPolicy": { + "target": "com.amazonaws.route53#TrafficPolicy", + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for the new version of the traffic\n\t\t\tpolicy.

", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "

A unique URL that represents a new traffic policy version.

", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response information for the\n\t\t\t\tCreateTrafficPolicyVersion request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#CreateVPCAssociationAuthorization": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateVPCAssociationAuthorizationRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateVPCAssociationAuthorizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidVPCId" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#TooManyVPCAssociationAuthorizations" + } + ], + "traits": { + "smithy.api#documentation": "

Authorizes the Amazon Web Services account that created a specified VPC to submit an\n\t\t\t\tAssociateVPCWithHostedZone request to associate the VPC with a\n\t\t\tspecified hosted zone that was created by a different account. To submit a\n\t\t\t\tCreateVPCAssociationAuthorization request, you must use the account\n\t\t\tthat created the hosted zone. After you authorize the association, use the account that\n\t\t\tcreated the VPC to submit an AssociateVPCWithHostedZone request.

\n \n

If you want to associate multiple VPCs that you created by using one account with\n\t\t\t\ta hosted zone that you created by using a different account, you must submit one\n\t\t\t\tauthorization request for each VPC.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/authorizevpcassociation", + "code": 200 + } + } + }, + "com.amazonaws.route53#CreateVPCAssociationAuthorizationRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the private hosted zone that you want to authorize associating a VPC\n\t\t\twith.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPC": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#documentation": "

A complex type that contains the VPC ID and region for the VPC that you want to\n\t\t\tauthorize associating with your hosted zone.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the request to authorize associating a\n\t\t\tVPC with your private hosted zone. Authorization is only required when a private hosted\n\t\t\tzone and a VPC were created by using different accounts.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#CreateVPCAssociationAuthorizationResponse": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that you authorized associating a VPC with.

", + "smithy.api#required": {} + } + }, + "VPC": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#documentation": "

The VPC that you authorized associating with a hosted zone.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response information from a\n\t\t\t\tCreateVPCAssociationAuthorization request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#DNSName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.route53#DNSRCode": { + "type": "string" + }, + "com.amazonaws.route53#DNSSECNotFound": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The hosted zone doesn't have any DNSSEC resources.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#DNSSECStatus": { + "type": "structure", + "members": { + "ServeSignature": { + "target": "com.amazonaws.route53#ServeSignature", + "traits": { + "smithy.api#documentation": "

A string that represents the current hosted zone signing status.

\n

Status can have one of the following values:

\n
\n
SIGNING
\n
\n

DNSSEC signing is enabled for the hosted zone.

\n
\n
NOT_SIGNING
\n
\n

DNSSEC signing is not enabled for the hosted zone.

\n
\n
DELETING
\n
\n

DNSSEC signing is in the process of being removed for the hosted\n\t\t\t\t\t\tzone.

\n
\n
ACTION_NEEDED
\n
\n

There is a problem with signing in the hosted zone that requires you to\n\t\t\t\t\t\ttake action to resolve. For example, the customer managed key might have\n\t\t\t\t\t\tbeen deleted, or the permissions for the customer managed key might have\n\t\t\t\t\t\tbeen changed.

\n
\n
INTERNAL_FAILURE
\n
\n

There was an error during a request. Before you can continue to work with\n\t\t\t\t\t\tDNSSEC signing, including with key-signing keys (KSKs), you must correct the\n\t\t\t\t\t\tproblem by enabling or disabling DNSSEC signing for the hosted zone.

\n
\n
" + } + }, + "StatusMessage": { + "target": "com.amazonaws.route53#SigningKeyStatusMessage", + "traits": { + "smithy.api#documentation": "

The status message provided for the following DNSSEC signing status:\n\t\t\t\tINTERNAL_FAILURE. The status message includes information about what\n\t\t\tthe problem might be and steps that you can take to correct the issue.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A string representing the status of DNSSEC signing.

" + } + }, + "com.amazonaws.route53#DeactivateKeySigningKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeactivateKeySigningKeyRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeactivateKeySigningKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + }, + { + "target": "com.amazonaws.route53#InvalidSigningStatus" + }, + { + "target": "com.amazonaws.route53#KeySigningKeyInParentDSRecord" + }, + { + "target": "com.amazonaws.route53#KeySigningKeyInUse" + }, + { + "target": "com.amazonaws.route53#NoSuchKeySigningKey" + } + ], + "traits": { + "smithy.api#documentation": "

Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC.\n\t\t\tThis operation changes the KSK status to INACTIVE.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/keysigningkey/{HostedZoneId}/{Name}/deactivate", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeactivateKeySigningKeyRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#SigningKeyName", + "traits": { + "smithy.api#documentation": "

A string used to identify a key-signing key (KSK).

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DeactivateKeySigningKeyResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#DelegationSet": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID that Amazon Route 53 assigns to a reusable delegation set.

" + } + }, + "CallerReference": { + "target": "com.amazonaws.route53#Nonce", + "traits": { + "smithy.api#documentation": "

The value that you specified for CallerReference when you created the\n\t\t\treusable delegation set.

" + } + }, + "NameServers": { + "target": "com.amazonaws.route53#DelegationSetNameServers", + "traits": { + "smithy.api#documentation": "

A complex type that contains a list of the authoritative name servers for a hosted\n\t\t\tzone or for a reusable delegation set.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that lists the name servers in a delegation set, as well as the\n\t\t\t\tCallerReference and the ID for the delegation set.

" + } + }, + "com.amazonaws.route53#DelegationSetAlreadyCreated": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A delegation set with the same owner and caller reference combination has already been\n\t\t\tcreated.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#DelegationSetAlreadyReusable": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified delegation set has already been marked as reusable.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#DelegationSetInUse": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified delegation contains associated hosted zones which must be deleted before\n\t\t\tthe reusable delegation set can be deleted.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#DelegationSetNameServers": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#xmlName": "NameServer" + } + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.route53#DelegationSetNotAvailable": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

You can create a hosted zone that has the same name as an existing hosted zone\n\t\t\t(example.com is common), but there is a limit to the number of hosted zones that have\n\t\t\tthe same name. If you get this error, Amazon Route 53 has reached that limit. If you own\n\t\t\tthe domain name and Route 53 generates this error, contact Customer Support.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#DelegationSetNotReusable": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A reusable delegation set with the specified ID does not exist.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#DelegationSets": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#DelegationSet", + "traits": { + "smithy.api#xmlName": "DelegationSet" + } + } + }, + "com.amazonaws.route53#DeleteCidrCollection": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteCidrCollectionRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteCidrCollectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#CidrCollectionInUseException" + }, + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchCidrCollectionException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a CIDR collection in the current Amazon Web Services account. The collection\n\t\t\tmust be empty before it can be deleted.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2013-04-01/cidrcollection/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeleteCidrCollectionRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "

The UUID of the collection to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DeleteCidrCollectionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#DeleteHealthCheck": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteHealthCheckRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteHealthCheckResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#HealthCheckInUse" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a health check.

\n \n

Amazon Route 53 does not prevent you from deleting a health check even if the\n\t\t\t\thealth check is associated with one or more resource record sets. If you delete a\n\t\t\t\thealth check and you don't update the associated resource record sets, the future\n\t\t\t\tstatus of the health check can't be predicted and may change. This will affect the\n\t\t\t\trouting of DNS queries for your DNS failover configuration. For more information,\n\t\t\t\tsee Replacing and Deleting Health Checks in the Amazon Route 53\n\t\t\t\t\tDeveloper Guide.

\n \n

If you're using Cloud Map and you configured Cloud Map to create a Route 53\n\t\t\thealth check when you register an instance, you can't use the Route 53\n\t\t\t\tDeleteHealthCheck command to delete the health check. The health check\n\t\t\tis deleted automatically when you deregister the instance; there can be a delay of\n\t\t\tseveral hours before the health check is deleted from Route 53.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2013-04-01/healthcheck/{HealthCheckId}", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeleteHealthCheckRequest": { + "type": "structure", + "members": { + "HealthCheckId": { + "target": "com.amazonaws.route53#HealthCheckId", + "traits": { + "smithy.api#documentation": "

The ID of the health check that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

This action deletes a health check.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DeleteHealthCheckResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

An empty element.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#DeleteHostedZone": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteHostedZoneRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteHostedZoneResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#HostedZoneNotEmpty" + }, + { + "target": "com.amazonaws.route53#InvalidDomainName" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a hosted zone.

\n

If the hosted zone was created by another service, such as Cloud Map, see\n\t\t\t\tDeleting Public Hosted Zones That Were Created by Another Service in the\n\t\t\t\t\tAmazon Route 53 Developer Guide for information\n\t\t\tabout how to delete it. (The process is the same for public and private hosted zones\n\t\t\tthat were created by another service.)

\n

If you want to keep your domain registration but you want to stop routing internet\n\t\t\ttraffic to your website or web application, we recommend that you delete resource record\n\t\t\tsets in the hosted zone instead of deleting the hosted zone.

\n \n

If you delete a hosted zone, you can't undelete it. You must create a new hosted\n\t\t\t\tzone and update the name servers for your domain registration, which can require up\n\t\t\t\tto 48 hours to take effect. (If you delegated responsibility for a subdomain to a\n\t\t\t\thosted zone and you delete the child hosted zone, you must update the name servers\n\t\t\t\tin the parent hosted zone.) In addition, if you delete a hosted zone, someone could\n\t\t\t\thijack the domain and route traffic to their own resources using your domain\n\t\t\t\tname.

\n \n

If you want to avoid the monthly charge for the hosted zone, you can transfer DNS\n\t\t\tservice for the domain to a free DNS service. When you transfer DNS service, you have to\n\t\t\tupdate the name servers for the domain registration. If the domain is registered with\n\t\t\t\tRoute 53, see UpdateDomainNameservers for information about how to replace Route 53 name servers with name servers for the new DNS service. If the domain is\n\t\t\tregistered with another registrar, use the method provided by the registrar to update\n\t\t\tname servers for the domain registration. For more information, perform an internet\n\t\t\tsearch on \"free DNS service.\"

\n

You can delete a hosted zone only if it contains only the default SOA record and NS\n\t\t\tresource record sets. If the hosted zone contains other resource record sets, you must\n\t\t\tdelete them before you can delete the hosted zone. If you try to delete a hosted zone\n\t\t\tthat contains other resource record sets, the request fails, and Route 53\n\t\t\treturns a HostedZoneNotEmpty error. For information about deleting records\n\t\t\tfrom your hosted zone, see ChangeResourceRecordSets.

\n

To verify that the hosted zone has been deleted, do one of the following:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2013-04-01/hostedzone/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeleteHostedZoneRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to delete a hosted zone.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DeleteHostedZoneResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#documentation": "

A complex type that contains the ID, the status, and the date and time of a request to\n\t\t\tdelete a hosted zone.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response to a DeleteHostedZone\n\t\t\trequest.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#DeleteKeySigningKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteKeySigningKeyRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteKeySigningKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + }, + { + "target": "com.amazonaws.route53#InvalidKMSArn" + }, + { + "target": "com.amazonaws.route53#InvalidSigningStatus" + }, + { + "target": "com.amazonaws.route53#NoSuchKeySigningKey" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a key-signing key (KSK). Before you can delete a KSK, you must deactivate it.\n\t\t\tThe KSK must be deactivated before you can delete it regardless of whether the hosted\n\t\t\tzone is enabled for DNSSEC signing.

\n

You can use DeactivateKeySigningKey to deactivate the key before you delete it.

\n

Use GetDNSSEC to verify that the KSK is in an INACTIVE\n\t\t\tstatus.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2013-04-01/keysigningkey/{HostedZoneId}/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeleteKeySigningKeyRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#SigningKeyName", + "traits": { + "smithy.api#documentation": "

A string used to identify a key-signing key (KSK).

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DeleteKeySigningKeyResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#DeleteQueryLoggingConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteQueryLoggingConfigRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteQueryLoggingConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchQueryLoggingConfig" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a configuration for DNS query logging. If you delete a configuration, Amazon\n\t\t\tRoute 53 stops sending query logs to CloudWatch Logs. Route 53 doesn't delete any logs\n\t\t\tthat are already in CloudWatch Logs.

\n

For more information about DNS query logs, see CreateQueryLoggingConfig.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2013-04-01/queryloggingconfig/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeleteQueryLoggingConfigRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#QueryLoggingConfigId", + "traits": { + "smithy.api#documentation": "

The ID of the configuration that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DeleteQueryLoggingConfigResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#DeleteReusableDelegationSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteReusableDelegationSetRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteReusableDelegationSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#DelegationSetInUse" + }, + { + "target": "com.amazonaws.route53#DelegationSetNotReusable" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchDelegationSet" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a reusable delegation set.

\n \n

You can delete a reusable delegation set only if it isn't associated with any\n\t\t\t\thosted zones.

\n \n

To verify that the reusable delegation set is not associated with any hosted zones,\n\t\t\tsubmit a GetReusableDelegationSet request and specify the ID of the reusable\n\t\t\tdelegation set that you want to delete.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2013-04-01/delegationset/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeleteReusableDelegationSetRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the reusable delegation set that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to delete a reusable delegation set.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DeleteReusableDelegationSetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

An empty element.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#DeleteTrafficPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteTrafficPolicyRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteTrafficPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicy" + }, + { + "target": "com.amazonaws.route53#TrafficPolicyInUse" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a traffic policy.

\n

When you delete a traffic policy, Route 53 sets a flag on the policy to indicate that\n\t\t\tit has been deleted. However, Route 53 never fully deletes the traffic policy. Note the\n\t\t\tfollowing:

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2013-04-01/trafficpolicy/{Id}/{Version}", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeleteTrafficPolicyInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteTrafficPolicyInstanceRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteTrafficPolicyInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a traffic policy instance and all of the resource record sets that Amazon\n\t\t\tRoute 53 created when you created the instance.

\n \n

In the Route 53 console, traffic policy instances are known as policy\n\t\t\t\trecords.

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2013-04-01/trafficpolicyinstance/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeleteTrafficPolicyInstanceRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyInstanceId", + "traits": { + "smithy.api#documentation": "

The ID of the traffic policy instance that you want to delete.

\n \n

When you delete a traffic policy instance, Amazon Route 53 also deletes all of the\n\t\t\t\tresource record sets that were created when you created the traffic policy\n\t\t\t\tinstance.

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to delete a specified traffic policy instance.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DeleteTrafficPolicyInstanceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

An empty element.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#DeleteTrafficPolicyRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

The ID of the traffic policy that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Version": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "

The version number of the traffic policy that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to delete a specified traffic policy version.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DeleteTrafficPolicyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

An empty element.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#DeleteVPCAssociationAuthorization": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteVPCAssociationAuthorizationRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteVPCAssociationAuthorizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidVPCId" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#VPCAssociationAuthorizationNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Removes authorization to submit an AssociateVPCWithHostedZone request to\n\t\t\tassociate a specified VPC with a hosted zone that was created by a different account.\n\t\t\tYou must use the account that created the hosted zone to submit a\n\t\t\t\tDeleteVPCAssociationAuthorization request.

\n \n

Sending this request only prevents the Amazon Web Services account that created the\n\t\t\t\tVPC from associating the VPC with the Amazon Route 53 hosted zone in the future. If\n\t\t\t\tthe VPC is already associated with the hosted zone,\n\t\t\t\t\tDeleteVPCAssociationAuthorization won't disassociate the VPC from\n\t\t\t\tthe hosted zone. If you want to delete an existing association, use\n\t\t\t\t\tDisassociateVPCFromHostedZone.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/deauthorizevpcassociation", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeleteVPCAssociationAuthorizationRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, the ID of the hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPC": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#documentation": "

When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, a complex type that includes the ID and region of the\n\t\t\tVPC.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the request to remove authorization to\n\t\t\tassociate a VPC that was created by one Amazon Web Services account with a hosted zone\n\t\t\tthat was created with a different Amazon Web Services account.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DeleteVPCAssociationAuthorizationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Empty response for the request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#Dimension": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53#DimensionField", + "traits": { + "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the name of one\n\t\t\tdimension.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.route53#DimensionField", + "traits": { + "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the value of one\n\t\t\tdimension.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, a complex type that\n\t\t\tcontains information about one dimension.

" + } + }, + "com.amazonaws.route53#DimensionField": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.route53#DimensionList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#Dimension", + "traits": { + "smithy.api#xmlName": "Dimension" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.route53#DisableHostedZoneDNSSEC": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DisableHostedZoneDNSSECRequest" + }, + "output": { + "target": "com.amazonaws.route53#DisableHostedZoneDNSSECResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#DNSSECNotFound" + }, + { + "target": "com.amazonaws.route53#InvalidArgument" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + }, + { + "target": "com.amazonaws.route53#InvalidKMSArn" + }, + { + "target": "com.amazonaws.route53#KeySigningKeyInParentDSRecord" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "

Disables DNSSEC signing in a specific hosted zone. This action does not deactivate any\n\t\t\tkey-signing keys (KSKs) that are active in the hosted zone.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/disable-dnssec", + "code": 200 + } + } + }, + "com.amazonaws.route53#DisableHostedZoneDNSSECRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DisableHostedZoneDNSSECResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#Disabled": { + "type": "boolean" + }, + "com.amazonaws.route53#DisassociateVPCComment": { + "type": "string" + }, + "com.amazonaws.route53#DisassociateVPCFromHostedZone": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DisassociateVPCFromHostedZoneRequest" + }, + "output": { + "target": "com.amazonaws.route53#DisassociateVPCFromHostedZoneResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidVPCId" + }, + { + "target": "com.amazonaws.route53#LastVPCAssociation" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#VPCAssociationNotFound" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53\n\t\t\tprivate hosted zone. Note the following:

\n \n \n

When revoking access, the hosted zone and the Amazon VPC must belong to\n\t\t\t\tthe same partition. A partition is a group of Amazon Web Services Regions. Each\n\t\t\t\t\tAmazon Web Services account is scoped to one partition.

\n

The following are the supported partitions:

\n \n

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/disassociatevpc", + "code": 200 + } + } + }, + "com.amazonaws.route53#DisassociateVPCFromHostedZoneRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the private hosted zone that you want to disassociate a VPC from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPC": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the VPC that you're disassociating from\n\t\t\tthe specified hosted zone.

", + "smithy.api#required": {} + } + }, + "Comment": { + "target": "com.amazonaws.route53#DisassociateVPCComment", + "traits": { + "smithy.api#documentation": "

\n Optional: A comment about the disassociation request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the VPC that you want to disassociate\n\t\t\tfrom a specified private hosted zone.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DisassociateVPCFromHostedZoneResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#documentation": "

A complex type that describes the changes made to the specified private hosted\n\t\t\tzone.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response information for the disassociate\n\t\t\trequest.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#EnableHostedZoneDNSSEC": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#EnableHostedZoneDNSSECRequest" + }, + "output": { + "target": "com.amazonaws.route53#EnableHostedZoneDNSSECResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#DNSSECNotFound" + }, + { + "target": "com.amazonaws.route53#HostedZonePartiallyDelegated" + }, + { + "target": "com.amazonaws.route53#InvalidArgument" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + }, + { + "target": "com.amazonaws.route53#InvalidKMSArn" + }, + { + "target": "com.amazonaws.route53#KeySigningKeyWithActiveStatusNotFound" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "

Enables DNSSEC signing in a specific hosted zone.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/enable-dnssec", + "code": 200 + } + } + }, + "com.amazonaws.route53#EnableHostedZoneDNSSECRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#EnableHostedZoneDNSSECResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#EnableSNI": { + "type": "boolean" + }, + "com.amazonaws.route53#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.route53#ErrorMessages": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#xmlName": "Message" + } + } + }, + "com.amazonaws.route53#EvaluationPeriods": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.route53#FailureThreshold": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.route53#FullyQualifiedDomainName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.route53#GeoLocation": { + "type": "structure", + "members": { + "ContinentCode": { + "target": "com.amazonaws.route53#GeoLocationContinentCode", + "traits": { + "smithy.api#documentation": "

The two-letter code for the continent.

\n

Amazon Route 53 supports the following continent codes:

\n \n

Constraint: Specifying ContinentCode with either CountryCode\n\t\t\tor SubdivisionCode returns an InvalidInput error.

" + } + }, + "CountryCode": { + "target": "com.amazonaws.route53#GeoLocationCountryCode", + "traits": { + "smithy.api#documentation": "

For geolocation resource record sets, the two-letter code for a country.

\n

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1\n\t\t\t\talpha-2.

\n

Route 53 also supports the country code UA for\n\t\t\tUkraine.

" + } + }, + "SubdivisionCode": { + "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", + "traits": { + "smithy.api#documentation": "

For geolocation resource record sets, the two-letter code for a state of the United\n\t\t\tStates. Route 53 doesn't support any other values for SubdivisionCode. For\n\t\t\ta list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United\n\t\t\tStates Postal Service website.

\n

If you specify subdivisioncode, you must also specify US for\n\t\t\t\tCountryCode.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about a geographic location.

" + } + }, + "com.amazonaws.route53#GeoLocationContinentCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, + "com.amazonaws.route53#GeoLocationContinentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.route53#GeoLocationCountryCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.route53#GeoLocationCountryName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53#GeoLocationDetails": { + "type": "structure", + "members": { + "ContinentCode": { + "target": "com.amazonaws.route53#GeoLocationContinentCode", + "traits": { + "smithy.api#documentation": "

The two-letter code for the continent.

" + } + }, + "ContinentName": { + "target": "com.amazonaws.route53#GeoLocationContinentName", + "traits": { + "smithy.api#documentation": "

The full name of the continent.

" + } + }, + "CountryCode": { + "target": "com.amazonaws.route53#GeoLocationCountryCode", + "traits": { + "smithy.api#documentation": "

The two-letter code for the country.

" + } + }, + "CountryName": { + "target": "com.amazonaws.route53#GeoLocationCountryName", + "traits": { + "smithy.api#documentation": "

The name of the country.

" + } + }, + "SubdivisionCode": { + "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", + "traits": { + "smithy.api#documentation": "

The code for the subdivision, such as a particular state within the United States. For\n\t\t\ta list of US state abbreviations, see Appendix B: Two–Letter State and\n\t\t\t\tPossession Abbreviations on the United States Postal Service website. For a\n\t\t\tlist of all supported subdivision codes, use the ListGeoLocations\n\t\t\tAPI.

" + } + }, + "SubdivisionName": { + "target": "com.amazonaws.route53#GeoLocationSubdivisionName", + "traits": { + "smithy.api#documentation": "

The full name of the subdivision. Route 53 currently supports only states in the\n\t\t\tUnited States.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the codes and full continent, country, and subdivision\n\t\t\tnames for the specified geolocation code.

" + } + }, + "com.amazonaws.route53#GeoLocationDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#GeoLocationDetails", + "traits": { + "smithy.api#xmlName": "GeoLocationDetails" + } + } + }, + "com.amazonaws.route53#GeoLocationSubdivisionCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + }, + "com.amazonaws.route53#GeoLocationSubdivisionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53#GeoProximityLocation": { + "type": "structure", + "members": { + "AWSRegion": { + "target": "com.amazonaws.route53#AWSRegion", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region the resource you are directing DNS traffic to, is in.

" + } + }, + "LocalZoneGroup": { + "target": "com.amazonaws.route53#LocalZoneGroup", + "traits": { + "smithy.api#documentation": "

\n\t\t\tSpecifies an Amazon Web Services Local Zone Group.\n\t\t

\n

A local Zone Group is usually the Local Zone code without the ending character. For example, \n\t\t\tif the Local Zone is us-east-1-bue-1a the Local Zone Group is us-east-1-bue-1.

\n

You can identify the Local Zones Group for a specific Local Zone by using the describe-availability-zones CLI command:

\n

This command returns: \"GroupName\": \"us-west-2-den-1\", specifying that the Local Zone us-west-2-den-1a \n\t\t\tbelongs to the Local Zone Group us-west-2-den-1.

" + } + }, + "Coordinates": { + "target": "com.amazonaws.route53#Coordinates", + "traits": { + "smithy.api#documentation": "

Contains the longitude and latitude for a geographic region.

" + } + }, + "Bias": { + "target": "com.amazonaws.route53#Bias", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe bias increases or decreases the size of the geographic region from which Route 53 routes traffic to a resource.\n\t\t

\n

To use Bias to change the size of the geographic region, specify the \n\t\t\tapplicable value for the bias:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

(Resource record sets only): A complex type that lets you specify where your resources are\n\t\t\tlocated. Only one of LocalZoneGroup, Coordinates, or\n\t\t\t\t\tAmazon Web ServicesRegion is allowed per request at a time.

\n

For more information about geoproximity routing, see Geoproximity routing in the\n\t\t\t\t\tAmazon Route 53 Developer Guide.

" + } + }, + "com.amazonaws.route53#GetAccountLimit": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetAccountLimitRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetAccountLimitResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the specified limit for the current account, for example, the maximum number of\n\t\t\thealth checks that you can create using the account.

\n

For the default limit, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide. To request a higher limit,\n\t\t\t\topen a case.

\n \n

You can also view account limits in Amazon Web Services Trusted Advisor. Sign in to\n\t\t\t\tthe Amazon Web Services Management Console and open the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/. Then choose Service limits in the navigation pane.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/accountlimit/{Type}", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetAccountLimitRequest": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.route53#AccountLimitType", + "traits": { + "smithy.api#documentation": "

The limit that you want to get. Valid values include the following:

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the request to create a hosted\n\t\t\tzone.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetAccountLimitResponse": { + "type": "structure", + "members": { + "Limit": { + "target": "com.amazonaws.route53#AccountLimit", + "traits": { + "smithy.api#documentation": "

The current setting for the specified limit. For example, if you specified\n\t\t\t\tMAX_HEALTH_CHECKS_BY_OWNER for the value of Type in the\n\t\t\trequest, the value of Limit is the maximum number of health checks that you\n\t\t\tcan create using the current account.

", + "smithy.api#required": {} + } + }, + "Count": { + "target": "com.amazonaws.route53#UsageCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The current number of entities that you have created of the specified type. For\n\t\t\texample, if you specified MAX_HEALTH_CHECKS_BY_OWNER for the value of\n\t\t\t\tType in the request, the value of Count is the current\n\t\t\tnumber of health checks that you have created using the current account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the requested limit.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetChange": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetChangeRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetChangeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchChange" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the current status of a change batch request. The status is one of the\n\t\t\tfollowing values:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/change/{Id}", + "code": 200 + }, + "smithy.waiters#waitable": { + "ResourceRecordSetsChanged": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ChangeInfo.Status", + "expected": "INSYNC", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.route53#GetChangeRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ChangeId", + "traits": { + "smithy.api#documentation": "

The ID of the change batch request. The value that you specify here is the value that\n\t\t\t\tChangeResourceRecordSets returned in the Id element when\n\t\t\tyou submitted the request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The input for a GetChange request.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetChangeResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the specified change batch.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the ChangeInfo element.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetCheckerIpRanges": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetCheckerIpRangesRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetCheckerIpRangesResponse" + }, + "traits": { + "smithy.api#documentation": "

Route 53 does not perform authorization for this API because it retrieves information\n\t\t\tthat is already available to the public.

\n \n

\n GetCheckerIpRanges still works, but we recommend that you download\n\t\t\t\tip-ranges.json, which includes IP address ranges for all Amazon Web Services\n\t\t\t\tservices. For more information, see IP Address Ranges\n\t\t\t\t\tof Amazon Route 53 Servers in the Amazon Route 53 Developer\n\t\t\t\t\tGuide.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/checkeripranges", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetCheckerIpRangesRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Empty request.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetCheckerIpRangesResponse": { + "type": "structure", + "members": { + "CheckerIpRanges": { + "target": "com.amazonaws.route53#CheckerIpRanges", + "traits": { + "smithy.api#documentation": "

A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route\n\t\t\t53 health checkers.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the CheckerIpRanges element.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetDNSSEC": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetDNSSECRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetDNSSECResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidArgument" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about DNSSEC for a specific hosted zone, including the key-signing\n\t\t\tkeys (KSKs) in the hosted zone.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/dnssec", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetDNSSECRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

A unique string used to identify a hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetDNSSECResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.route53#DNSSECStatus", + "traits": { + "smithy.api#documentation": "

A string representing the status of DNSSEC.

", + "smithy.api#required": {} + } + }, + "KeySigningKeys": { + "target": "com.amazonaws.route53#KeySigningKeys", + "traits": { + "smithy.api#documentation": "

The key-signing keys (KSKs) in your account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetGeoLocation": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetGeoLocationRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetGeoLocationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchGeoLocation" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about whether a specified geographic location is supported for Amazon\n\t\t\tRoute 53 geolocation resource record sets.

\n

Route 53 does not perform authorization for this API because it retrieves information\n\t\t\tthat is already available to the public.

\n

Use the following syntax to determine whether a continent is supported for\n\t\t\tgeolocation:

\n

\n GET /2013-04-01/geolocation?continentcode=two-letter abbreviation for\n\t\t\t\t\ta continent\n \n

\n

Use the following syntax to determine whether a country is supported for\n\t\t\tgeolocation:

\n

\n GET /2013-04-01/geolocation?countrycode=two-character country\n\t\t\t\t\tcode\n \n

\n

Use the following syntax to determine whether a subdivision of a country is supported\n\t\t\tfor geolocation:

\n

\n GET /2013-04-01/geolocation?countrycode=two-character country\n\t\t\t\t\tcode&subdivisioncode=subdivision\n\t\t\tcode\n \n

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/geolocation", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetGeoLocationRequest": { + "type": "structure", + "members": { + "ContinentCode": { + "target": "com.amazonaws.route53#GeoLocationContinentCode", + "traits": { + "smithy.api#documentation": "

For geolocation resource record sets, a two-letter abbreviation that identifies a\n\t\t\tcontinent. Amazon Route 53 supports the following continent codes:

\n ", + "smithy.api#httpQuery": "continentcode" + } + }, + "CountryCode": { + "target": "com.amazonaws.route53#GeoLocationCountryCode", + "traits": { + "smithy.api#documentation": "

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1\n\t\t\t\talpha-2.

\n

Route 53 also supports the country code UA for\n\t\t\tUkraine.

", + "smithy.api#httpQuery": "countrycode" + } + }, + "SubdivisionCode": { + "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", + "traits": { + "smithy.api#documentation": "

The code for the subdivision, such as a particular state within the United States. For\n\t\t\ta list of US state abbreviations, see Appendix B: Two–Letter State and\n\t\t\t\tPossession Abbreviations on the United States Postal Service website. For a\n\t\t\tlist of all supported subdivision codes, use the ListGeoLocations\n\t\t\tAPI.

", + "smithy.api#httpQuery": "subdivisioncode" + } + } + }, + "traits": { + "smithy.api#documentation": "

A request for information about whether a specified geographic location is supported\n\t\t\tfor Amazon Route 53 geolocation resource record sets.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetGeoLocationResponse": { + "type": "structure", + "members": { + "GeoLocationDetails": { + "target": "com.amazonaws.route53#GeoLocationDetails", + "traits": { + "smithy.api#documentation": "

A complex type that contains the codes and full continent, country, and subdivision\n\t\t\tnames for the specified geolocation code.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response information for the specified geolocation\n\t\t\tcode.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetHealthCheck": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetHealthCheckRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetHealthCheckResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#IncompatibleVersion" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a specified health check.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/healthcheck/{HealthCheckId}", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetHealthCheckCount": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetHealthCheckCountRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetHealthCheckCountResponse" + }, + "traits": { + "smithy.api#documentation": "

Retrieves the number of health checks that are associated with the current Amazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/healthcheckcount", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetHealthCheckCountRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

A request for the number of health checks that are associated with the current Amazon Web Services account.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetHealthCheckCountResponse": { + "type": "structure", + "members": { + "HealthCheckCount": { + "target": "com.amazonaws.route53#HealthCheckCount", + "traits": { + "smithy.api#documentation": "

The number of health checks associated with the current Amazon Web Services account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response to a GetHealthCheckCount\n\t\t\trequest.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetHealthCheckLastFailureReason": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetHealthCheckLastFailureReasonRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetHealthCheckLastFailureReasonResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the reason that a specified health check failed most recently.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/healthcheck/{HealthCheckId}/lastfailurereason", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetHealthCheckLastFailureReasonRequest": { + "type": "structure", + "members": { + "HealthCheckId": { + "target": "com.amazonaws.route53#HealthCheckId", + "traits": { + "smithy.api#documentation": "

The ID for the health check for which you want the last failure reason. When you\n\t\t\tcreated the health check, CreateHealthCheck returned the ID in the\n\t\t\tresponse, in the HealthCheckId element.

\n \n

If you want to get the last failure reason for a calculated health check, you must\n\t\t\t\tuse the Amazon Route 53 console or the CloudWatch console. You can't use\n\t\t\t\t\tGetHealthCheckLastFailureReason for a calculated health\n\t\t\t\tcheck.

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A request for the reason that a health check failed most recently.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetHealthCheckLastFailureReasonResponse": { + "type": "structure", + "members": { + "HealthCheckObservations": { + "target": "com.amazonaws.route53#HealthCheckObservations", + "traits": { + "smithy.api#documentation": "

A list that contains one Observation element for each Amazon Route 53\n\t\t\thealth checker that is reporting a last failure reason.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response to a\n\t\t\t\tGetHealthCheckLastFailureReason request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetHealthCheckRequest": { + "type": "structure", + "members": { + "HealthCheckId": { + "target": "com.amazonaws.route53#HealthCheckId", + "traits": { + "smithy.api#documentation": "

The identifier that Amazon Route 53 assigned to the health check when you created it.\n\t\t\tWhen you add or update a resource record set, you use this value to specify which health\n\t\t\tcheck to use. The value can be up to 64 characters long.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to get information about a specified health check.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetHealthCheckResponse": { + "type": "structure", + "members": { + "HealthCheck": { + "target": "com.amazonaws.route53#HealthCheck", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about one health check that is associated\n\t\t\twith the current Amazon Web Services account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response to a GetHealthCheck\n\t\t\trequest.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetHealthCheckStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetHealthCheckStatusRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetHealthCheckStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + } + ], + "traits": { + "smithy.api#documentation": "

Gets status of a specified health check.

\n \n

This API is intended for use during development to diagnose behavior. It doesn’t\n\t\t\t\tsupport production use-cases with high query rates that require immediate and\n\t\t\t\tactionable responses.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/healthcheck/{HealthCheckId}/status", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetHealthCheckStatusRequest": { + "type": "structure", + "members": { + "HealthCheckId": { + "target": "com.amazonaws.route53#HealthCheckId", + "traits": { + "smithy.api#documentation": "

The ID for the health check that you want the current status for. When you created the\n\t\t\thealth check, CreateHealthCheck returned the ID in the response, in the\n\t\t\t\tHealthCheckId element.

\n \n

If you want to check the status of a calculated health check, you must use the\n\t\t\t\tAmazon Route 53 console or the CloudWatch console. You can't use\n\t\t\t\t\tGetHealthCheckStatus to get the status of a calculated health\n\t\t\t\tcheck.

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to get the status for a health check.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetHealthCheckStatusResponse": { + "type": "structure", + "members": { + "HealthCheckObservations": { + "target": "com.amazonaws.route53#HealthCheckObservations", + "traits": { + "smithy.api#documentation": "

A list that contains one HealthCheckObservation element for each Amazon\n\t\t\tRoute 53 health checker that is reporting a status about the health check\n\t\t\tendpoint.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response to a GetHealthCheck\n\t\t\trequest.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetHostedZone": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetHostedZoneRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetHostedZoneResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a specified hosted zone including the four name servers\n\t\t\tassigned to the hosted zone.

", + "smithy.api#examples": [ + { + "title": "To get information about a hosted zone", + "documentation": "The following example gets information about the Z3M3LMPEXAMPLE hosted zone.", + "input": { + "Id": "Z3M3LMPEXAMPLE" + }, + "output": { + "HostedZone": { + "ResourceRecordSetCount": 8, + "CallerReference": "C741617D-04E4-F8DE-B9D7-0D150FC61C2E", + "Config": { + "PrivateZone": false + }, + "Id": "/hostedzone/Z3M3LMPEXAMPLE", + "Name": "myawsbucket.com." + }, + "DelegationSet": { + "NameServers": [ + "ns-2048.awsdns-64.com", + "ns-2049.awsdns-65.net", + "ns-2050.awsdns-66.org", + "ns-2051.awsdns-67.co.uk" + ] + } + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/hostedzone/{Id}", + "code": 200 + }, + "smithy.test#smokeTests": [ + { + "id": "GetHostedZoneFailure", + "params": { + "Id": "fake-zone" + }, + "vendorParams": { + "region": "us-east-1" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "failure": {} + } + } + ] + } + }, + "com.amazonaws.route53#GetHostedZoneCount": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetHostedZoneCountRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetHostedZoneCountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the number of hosted zones that are associated with the current Amazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/hostedzonecount", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetHostedZoneCountRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

A request to retrieve a count of all the hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetHostedZoneCountResponse": { + "type": "structure", + "members": { + "HostedZoneCount": { + "target": "com.amazonaws.route53#HostedZoneCount", + "traits": { + "smithy.api#documentation": "

The total number of public and private hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response to a GetHostedZoneCount\n\t\t\trequest.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetHostedZoneLimit": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetHostedZoneLimitRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetHostedZoneLimitResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#HostedZoneNotPrivate" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the specified limit for a specified hosted zone, for example, the maximum number\n\t\t\tof records that you can create in the hosted zone.

\n

For the default limit, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide. To request a higher limit,\n\t\t\t\topen a case.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/hostedzonelimit/{HostedZoneId}/{Type}", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetHostedZoneLimitRequest": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.route53#HostedZoneLimitType", + "traits": { + "smithy.api#documentation": "

The limit that you want to get. Valid values include the following:

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that you want to get a limit for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the request to create a hosted\n\t\t\tzone.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetHostedZoneLimitResponse": { + "type": "structure", + "members": { + "Limit": { + "target": "com.amazonaws.route53#HostedZoneLimit", + "traits": { + "smithy.api#documentation": "

The current setting for the specified limit. For example, if you specified\n\t\t\t\tMAX_RRSETS_BY_ZONE for the value of Type in the request,\n\t\t\tthe value of Limit is the maximum number of records that you can create in\n\t\t\tthe specified hosted zone.

", + "smithy.api#required": {} + } + }, + "Count": { + "target": "com.amazonaws.route53#UsageCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The current number of entities that you have created of the specified type. For\n\t\t\texample, if you specified MAX_RRSETS_BY_ZONE for the value of\n\t\t\t\tType in the request, the value of Count is the current\n\t\t\tnumber of records that you have created in the specified hosted zone.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the requested limit.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetHostedZoneRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that you want to get information about.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to get information about a specified hosted zone.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetHostedZoneResponse": { + "type": "structure", + "members": { + "HostedZone": { + "target": "com.amazonaws.route53#HostedZone", + "traits": { + "smithy.api#documentation": "

A complex type that contains general information about the specified hosted\n\t\t\tzone.

", + "smithy.api#required": {} + } + }, + "DelegationSet": { + "target": "com.amazonaws.route53#DelegationSet", + "traits": { + "smithy.api#documentation": "

A complex type that lists the Amazon Route 53 name servers for the specified hosted\n\t\t\tzone.

" + } + }, + "VPCs": { + "target": "com.amazonaws.route53#VPCs", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the VPCs that are associated with the\n\t\t\tspecified hosted zone.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contain the response to a GetHostedZone\n\t\t\trequest.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetQueryLoggingConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetQueryLoggingConfigRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetQueryLoggingConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchQueryLoggingConfig" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a specified configuration for DNS query logging.

\n

For more information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS\n\t\t\tQueries.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/queryloggingconfig/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetQueryLoggingConfigRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#QueryLoggingConfigId", + "traits": { + "smithy.api#documentation": "

The ID of the configuration for DNS query logging that you want to get information\n\t\t\tabout.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetQueryLoggingConfigResponse": { + "type": "structure", + "members": { + "QueryLoggingConfig": { + "target": "com.amazonaws.route53#QueryLoggingConfig", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the query logging configuration that\n\t\t\tyou specified in a GetQueryLoggingConfig request.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetReusableDelegationSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetReusableDelegationSetRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetReusableDelegationSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#DelegationSetNotReusable" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchDelegationSet" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about a specified reusable delegation set, including the four\n\t\t\tname servers that are assigned to the delegation set.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/delegationset/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetReusableDelegationSetLimit": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetReusableDelegationSetLimitRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetReusableDelegationSetLimitResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchDelegationSet" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the maximum number of hosted zones that you can associate with the specified\n\t\t\treusable delegation set.

\n

For the default limit, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide. To request a higher limit,\n\t\t\t\topen a case.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/reusabledelegationsetlimit/{DelegationSetId}/{Type}", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetReusableDelegationSetLimitRequest": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.route53#ReusableDelegationSetLimitType", + "traits": { + "smithy.api#documentation": "

Specify MAX_ZONES_BY_REUSABLE_DELEGATION_SET to get the maximum number of\n\t\t\thosted zones that you can associate with the specified reusable delegation set.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DelegationSetId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the delegation set that you want to get the limit for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the request to create a hosted\n\t\t\tzone.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetReusableDelegationSetLimitResponse": { + "type": "structure", + "members": { + "Limit": { + "target": "com.amazonaws.route53#ReusableDelegationSetLimit", + "traits": { + "smithy.api#documentation": "

The current setting for the limit on hosted zones that you can associate with the\n\t\t\tspecified reusable delegation set.

", + "smithy.api#required": {} + } + }, + "Count": { + "target": "com.amazonaws.route53#UsageCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The current number of hosted zones that you can associate with the specified reusable\n\t\t\tdelegation set.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the requested limit.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetReusableDelegationSetRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the reusable delegation set that you want to get a list of name servers\n\t\t\tfor.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to get information about a specified reusable delegation set.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetReusableDelegationSetResponse": { + "type": "structure", + "members": { + "DelegationSet": { + "target": "com.amazonaws.route53#DelegationSet", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the reusable delegation set.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response to the GetReusableDelegationSet\n\t\t\trequest.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetTrafficPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetTrafficPolicyRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetTrafficPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicy" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a specific traffic policy version.

\n

For information about how of deleting a traffic policy affects the response from\n\t\t\t\tGetTrafficPolicy, see DeleteTrafficPolicy.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/trafficpolicy/{Id}/{Version}", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetTrafficPolicyInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetTrafficPolicyInstanceRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetTrafficPolicyInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a specified traffic policy instance.

\n \n

\n\t\t\t\tUse GetTrafficPolicyInstance with the id of new traffic policy instance to confirm that the \n\t\t\t\tCreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request completed successfully. \n\t\t\t\tFor more information, see the State response\n\t\t\t\telement.

\n \n \n

In the Route 53 console, traffic policy instances are known as policy\n\t\t\t\trecords.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/trafficpolicyinstance/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetTrafficPolicyInstanceCount": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetTrafficPolicyInstanceCountRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetTrafficPolicyInstanceCountResponse" + }, + "traits": { + "smithy.api#documentation": "

Gets the number of traffic policy instances that are associated with the current\n\t\t\t\tAmazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/trafficpolicyinstancecount", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetTrafficPolicyInstanceCountRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

Request to get the number of traffic policy instances that are associated with the\n\t\t\tcurrent Amazon Web Services account.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetTrafficPolicyInstanceCountResponse": { + "type": "structure", + "members": { + "TrafficPolicyInstanceCount": { + "target": "com.amazonaws.route53#TrafficPolicyInstanceCount", + "traits": { + "smithy.api#documentation": "

The number of traffic policy instances that are associated with the current Amazon Web Services account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the resource record sets that Amazon\n\t\t\tRoute 53 created based on a specified traffic policy.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetTrafficPolicyInstanceRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyInstanceId", + "traits": { + "smithy.api#documentation": "

The ID of the traffic policy instance that you want to get information about.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Gets information about a specified traffic policy instance.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetTrafficPolicyInstanceResponse": { + "type": "structure", + "members": { + "TrafficPolicyInstance": { + "target": "com.amazonaws.route53#TrafficPolicyInstance", + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for the traffic policy instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the resource record sets that Amazon\n\t\t\tRoute 53 created based on a specified traffic policy.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetTrafficPolicyRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

The ID of the traffic policy that you want to get information about.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Version": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "

The version number of the traffic policy that you want to get information\n\t\t\tabout.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Gets information about a specific traffic policy version.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetTrafficPolicyResponse": { + "type": "structure", + "members": { + "TrafficPolicy": { + "target": "com.amazonaws.route53#TrafficPolicy", + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for the specified traffic policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response information for the request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#HealthCheck": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#HealthCheckId", + "traits": { + "smithy.api#documentation": "

The identifier that Amazon Route 53 assigned to the health check when you created it.\n\t\t\tWhen you add or update a resource record set, you use this value to specify which health\n\t\t\tcheck to use. The value can be up to 64 characters long.

", + "smithy.api#required": {} + } + }, + "CallerReference": { + "target": "com.amazonaws.route53#HealthCheckNonce", + "traits": { + "smithy.api#documentation": "

A unique string that you specified when you created the health check.

", + "smithy.api#required": {} + } + }, + "LinkedService": { + "target": "com.amazonaws.route53#LinkedService", + "traits": { + "smithy.api#documentation": "

If the health check was created by another service, the service that created the\n\t\t\thealth check. When a health check is created by another service, you can't edit or\n\t\t\tdelete it using Amazon Route 53.

" + } + }, + "HealthCheckConfig": { + "target": "com.amazonaws.route53#HealthCheckConfig", + "traits": { + "smithy.api#documentation": "

A complex type that contains detailed information about one health check.

", + "smithy.api#required": {} + } + }, + "HealthCheckVersion": { + "target": "com.amazonaws.route53#HealthCheckVersion", + "traits": { + "smithy.api#documentation": "

The version of the health check. You can optionally pass this value in a call to\n\t\t\t\tUpdateHealthCheck to prevent overwriting another change to the health\n\t\t\tcheck.

", + "smithy.api#required": {} + } + }, + "CloudWatchAlarmConfiguration": { + "target": "com.amazonaws.route53#CloudWatchAlarmConfiguration", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the CloudWatch alarm that Amazon Route\n\t\t\t53 is monitoring for this health check.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about one health check that is associated\n\t\t\twith the current Amazon Web Services account.

" + } + }, + "com.amazonaws.route53#HealthCheckAlreadyExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The health check you're attempting to create already exists. Amazon Route 53 returns\n\t\t\tthis error when you submit a request that has the following values:

\n ", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.route53#HealthCheckConfig": { + "type": "structure", + "members": { + "IPAddress": { + "target": "com.amazonaws.route53#IPAddress", + "traits": { + "smithy.api#documentation": "

The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform\n\t\t\thealth checks on. If you don't specify a value for IPAddress, Route 53\n\t\t\tsends a DNS request to resolve the domain name that you specify in\n\t\t\t\tFullyQualifiedDomainName at the interval that you specify in\n\t\t\t\tRequestInterval. Using an IP address returned by DNS, Route 53 then\n\t\t\tchecks the health of the endpoint.

\n

Use one of the following formats for the value of IPAddress:

\n \n

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP\n\t\t\taddress, associate it with your EC2 instance, and specify the Elastic IP address for\n\t\t\t\tIPAddress. This ensures that the IP address of your instance will never\n\t\t\tchange.

\n

For more information, see FullyQualifiedDomainName.

\n

Constraints: Route 53 can't check the health of endpoints for which the IP address is\n\t\t\tin local, private, non-routable, or multicast ranges. For more information about IP\n\t\t\taddresses for which you can't create health checks, see the following documents:

\n \n

When the value of Type is CALCULATED or\n\t\t\t\tCLOUDWATCH_METRIC, omit IPAddress.

" + } + }, + "Port": { + "target": "com.amazonaws.route53#Port", + "traits": { + "smithy.api#documentation": "

The port on the endpoint that you want Amazon Route 53 to perform health checks\n\t\t\ton.

\n \n

Don't specify a value for Port when you specify a value for\n\t\t\t\t\tType of CLOUDWATCH_METRIC or\n\t\t\t\tCALCULATED.

\n " + } + }, + "Type": { + "target": "com.amazonaws.route53#HealthCheckType", + "traits": { + "smithy.api#documentation": "

The type of health check that you want to create, which indicates how Amazon Route 53\n\t\t\tdetermines whether an endpoint is healthy.

\n \n

You can't change the value of Type after you create a health\n\t\t\t\tcheck.

\n \n

You can create the following types of health checks:

\n \n

For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the\n\t\t\t\tAmazon Route 53 Developer Guide.

", + "smithy.api#required": {} + } + }, + "ResourcePath": { + "target": "com.amazonaws.route53#ResourcePath", + "traits": { + "smithy.api#documentation": "

The path, if any, that you want Amazon Route 53 to request when performing health\n\t\t\tchecks. The path can be any value for which your endpoint will return an HTTP status\n\t\t\tcode of 2xx or 3xx when the endpoint is healthy, for example, the file\n\t\t\t/docs/route53-health-check.html. You can also include query string parameters, for\n\t\t\texample, /welcome.html?language=jp&login=y.

" + } + }, + "FullyQualifiedDomainName": { + "target": "com.amazonaws.route53#FullyQualifiedDomainName", + "traits": { + "smithy.api#documentation": "

Amazon Route 53 behavior depends on whether you specify a value for\n\t\t\t\tIPAddress.

\n

\n If you specify a value for\n IPAddress:

\n

Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and\n\t\t\tpasses the value of FullyQualifiedDomainName in the Host\n\t\t\theader for all health checks except TCP health checks. This is typically the fully\n\t\t\tqualified DNS name of the endpoint on which you want Route 53 to perform health\n\t\t\tchecks.

\n

When Route 53 checks the health of an endpoint, here is how it constructs the\n\t\t\t\tHost header:

\n \n

If you don't specify a value for FullyQualifiedDomainName, Route 53\n\t\t\tsubstitutes the value of IPAddress in the Host header in each\n\t\t\tof the preceding cases.

\n

\n If you don't specify a value for\n IPAddress:

\n

Route 53 sends a DNS request to the domain that you specify for\n\t\t\t\tFullyQualifiedDomainName at the interval that you specify for\n\t\t\t\tRequestInterval. Using an IPv4 address that DNS returns, Route 53 then\n\t\t\tchecks the health of the endpoint.

\n \n

If you don't specify a value for IPAddress, Route 53 uses only IPv4\n\t\t\t\tto send health checks to the endpoint. If there's no resource record set with a type\n\t\t\t\tof A for the name that you specify for FullyQualifiedDomainName, the\n\t\t\t\thealth check fails with a \"DNS resolution failed\" error.

\n \n

If you want to check the health of weighted, latency, or failover resource record sets\n\t\t\tand you choose to specify the endpoint only by FullyQualifiedDomainName, we\n\t\t\trecommend that you create a separate health check for each endpoint. For example, create\n\t\t\ta health check for each HTTP server that is serving content for www.example.com. For the\n\t\t\tvalue of FullyQualifiedDomainName, specify the domain name of the server\n\t\t\t(such as us-east-2-www.example.com), not the name of the resource record sets\n\t\t\t(www.example.com).

\n \n

In this configuration, if you create a health check for which the value of\n\t\t\t\t\tFullyQualifiedDomainName matches the name of the resource record\n\t\t\t\tsets and you then associate the health check with those resource record sets, health\n\t\t\t\tcheck results will be unpredictable.

\n \n

In addition, if the value that you specify for Type is HTTP,\n\t\t\t\tHTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH,\n\t\t\tRoute 53 passes the value of FullyQualifiedDomainName in the\n\t\t\t\tHost header, as it does when you specify a value for\n\t\t\t\tIPAddress. If the value of Type is TCP, Route\n\t\t\t53 doesn't pass a Host header.

" + } + }, + "SearchString": { + "target": "com.amazonaws.route53#SearchString", + "traits": { + "smithy.api#documentation": "

If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH,\n\t\t\tthe string that you want Amazon Route 53 to search for in the response body from the\n\t\t\tspecified resource. If the string appears in the response body, Route 53 considers the\n\t\t\tresource healthy.

\n

Route 53 considers case when searching for SearchString in the response\n\t\t\tbody.

" + } + }, + "RequestInterval": { + "target": "com.amazonaws.route53#RequestInterval", + "traits": { + "smithy.api#documentation": "

The number of seconds between the time that Amazon Route 53 gets a response from your\n\t\t\tendpoint and the time that it sends the next health check request. Each Route 53 health\n\t\t\tchecker makes requests at this interval.

\n \n

You can't change the value of RequestInterval after you create a\n\t\t\t\thealth check.

\n \n

If you don't specify a value for RequestInterval, the default value is\n\t\t\t\t30 seconds.

" + } + }, + "FailureThreshold": { + "target": "com.amazonaws.route53#FailureThreshold", + "traits": { + "smithy.api#documentation": "

The number of consecutive health checks that an endpoint must pass or fail for Amazon\n\t\t\tRoute 53 to change the current status of the endpoint from unhealthy to healthy or vice\n\t\t\tversa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n

If you don't specify a value for FailureThreshold, the default value is\n\t\t\tthree health checks.

" + } + }, + "MeasureLatency": { + "target": "com.amazonaws.route53#MeasureLatency", + "traits": { + "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to measure the latency between health\n\t\t\tcheckers in multiple Amazon Web Services regions and your endpoint, and to display\n\t\t\tCloudWatch latency graphs on the Health Checks page in\n\t\t\tthe Route 53 console.

\n \n

You can't change the value of MeasureLatency after you create a\n\t\t\t\thealth check.

\n " + } + }, + "Inverted": { + "target": "com.amazonaws.route53#Inverted", + "traits": { + "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to invert the status of a health check, for\n\t\t\texample, to consider a health check unhealthy when it otherwise would be considered\n\t\t\thealthy.

" + } + }, + "Disabled": { + "target": "com.amazonaws.route53#Disabled", + "traits": { + "smithy.api#documentation": "

Stops Route 53 from performing health checks. When you disable a health check, here's\n\t\t\twhat happens:

\n \n

After you disable a health check, Route 53 considers the status of the health check to\n\t\t\talways be healthy. If you configured DNS failover, Route 53 continues to route traffic\n\t\t\tto the corresponding resources. If you want to stop routing traffic to a resource,\n\t\t\tchange the value of Inverted.

\n

Charges for a health check still apply when the health check is disabled. For more\n\t\t\tinformation, see Amazon Route 53\n\t\t\t\tPricing.

" + } + }, + "HealthThreshold": { + "target": "com.amazonaws.route53#HealthThreshold", + "traits": { + "smithy.api#documentation": "

The number of child health checks that are associated with a CALCULATED\n\t\t\thealth check that Amazon Route 53 must consider healthy for the CALCULATED\n\t\t\thealth check to be considered healthy. To specify the child health checks that you want\n\t\t\tto associate with a CALCULATED health check, use the ChildHealthChecks element.

\n

Note the following:

\n " + } + }, + "ChildHealthChecks": { + "target": "com.amazonaws.route53#ChildHealthCheckList", + "traits": { + "smithy.api#documentation": "

(CALCULATED Health Checks Only) A complex type that contains one\n\t\t\t\tChildHealthCheck element for each health check that you want to\n\t\t\tassociate with a CALCULATED health check.

" + } + }, + "EnableSNI": { + "target": "com.amazonaws.route53#EnableSNI", + "traits": { + "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to send the value of\n\t\t\t\tFullyQualifiedDomainName to the endpoint in the\n\t\t\t\tclient_hello message during TLS negotiation. This allows the endpoint\n\t\t\tto respond to HTTPS health check requests with the applicable SSL/TLS\n\t\t\tcertificate.

\n

Some endpoints require that HTTPS requests include the host name in the\n\t\t\t\tclient_hello message. If you don't enable SNI, the status of the health\n\t\t\tcheck will be SSL alert handshake_failure. A health check can also have\n\t\t\tthat status for other reasons. If SNI is enabled and you're still getting the error,\n\t\t\tcheck the SSL/TLS configuration on your endpoint and confirm that your certificate is\n\t\t\tvalid.

\n

The SSL/TLS certificate on your endpoint includes a domain name in the Common\n\t\t\t\tName field and possibly several more in the Subject Alternative\n\t\t\t\tNames field. One of the domain names in the certificate should match the\n\t\t\tvalue that you specify for FullyQualifiedDomainName. If the endpoint\n\t\t\tresponds to the client_hello message with a certificate that does not\n\t\t\tinclude the domain name that you specified in FullyQualifiedDomainName, a\n\t\t\thealth checker will retry the handshake. In the second attempt, the health checker will\n\t\t\tomit FullyQualifiedDomainName from the client_hello\n\t\t\tmessage.

" + } + }, + "Regions": { + "target": "com.amazonaws.route53#HealthCheckRegionList", + "traits": { + "smithy.api#documentation": "

A complex type that contains one Region element for each region from\n\t\t\twhich you want Amazon Route 53 health checkers to check the specified endpoint.

\n

If you don't specify any regions, Route 53 health checkers automatically performs\n\t\t\tchecks from all of the regions that are listed under Valid\n\t\t\t\tValues.

\n

If you update a health check to remove a region that has been performing health\n\t\t\tchecks, Route 53 will briefly continue to perform checks from that region to ensure that\n\t\t\tsome health checkers are always checking the endpoint (for example, if you replace three\n\t\t\tregions with four different regions).

" + } + }, + "AlarmIdentifier": { + "target": "com.amazonaws.route53#AlarmIdentifier", + "traits": { + "smithy.api#documentation": "

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53\n\t\t\thealth checkers to use to determine whether the specified health check is\n\t\t\thealthy.

" + } + }, + "InsufficientDataHealthStatus": { + "target": "com.amazonaws.route53#InsufficientDataHealthStatus", + "traits": { + "smithy.api#documentation": "

When CloudWatch has insufficient data about the metric to determine the alarm state,\n\t\t\tthe status that you want Amazon Route 53 to assign to the health check:

\n " + } + }, + "RoutingControlArn": { + "target": "com.amazonaws.route53#RoutingControlArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller\n\t\t\trouting control.

\n

For more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide..

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the health check.

" + } + }, + "com.amazonaws.route53#HealthCheckCount": { + "type": "long" + }, + "com.amazonaws.route53#HealthCheckId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + } + } + }, + "com.amazonaws.route53#HealthCheckInUse": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "

This error code is not in use.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#HealthCheckNonce": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53#HealthCheckObservation": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.route53#HealthCheckRegion", + "traits": { + "smithy.api#documentation": "

The region of the Amazon Route 53 health checker that provided the status in\n\t\t\t\tStatusReport.

" + } + }, + "IPAddress": { + "target": "com.amazonaws.route53#IPAddress", + "traits": { + "smithy.api#documentation": "

The IP address of the Amazon Route 53 health checker that provided the failure reason\n\t\t\tin StatusReport.

" + } + }, + "StatusReport": { + "target": "com.amazonaws.route53#StatusReport", + "traits": { + "smithy.api#documentation": "

A complex type that contains the last failure reason as reported by one Amazon Route\n\t\t\t53 health checker and the time of the failed health check.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the last failure reason as reported by one Amazon Route\n\t\t\t53 health checker.

" + } + }, + "com.amazonaws.route53#HealthCheckObservations": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#HealthCheckObservation", + "traits": { + "smithy.api#xmlName": "HealthCheckObservation" + } + } + }, + "com.amazonaws.route53#HealthCheckRegion": { + "type": "enum", + "members": { + "us_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-1" + } + }, + "us_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-1" + } + }, + "us_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-2" + } + }, + "eu_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-1" + } + }, + "ap_southeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-1" + } + }, + "ap_southeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-2" + } + }, + "ap_northeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-1" + } + }, + "sa_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sa-east-1" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53#HealthCheckRegionList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#HealthCheckRegion", + "traits": { + "smithy.api#xmlName": "Region" + } + }, + "traits": { + "smithy.api#length": { + "min": 3, + "max": 64 + } + } + }, + "com.amazonaws.route53#HealthCheckType": { + "type": "enum", + "members": { + "HTTP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP" + } + }, + "HTTPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPS" + } + }, + "HTTP_STR_MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP_STR_MATCH" + } + }, + "HTTPS_STR_MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPS_STR_MATCH" + } + }, + "TCP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TCP" + } + }, + "CALCULATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CALCULATED" + } + }, + "CLOUDWATCH_METRIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDWATCH_METRIC" + } + }, + "RECOVERY_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECOVERY_CONTROL" + } + } + } + }, + "com.amazonaws.route53#HealthCheckVersion": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.route53#HealthCheckVersionMismatch": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The value of HealthCheckVersion in the request doesn't match the value of\n\t\t\t\tHealthCheckVersion in the health check.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.route53#HealthChecks": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#HealthCheck", + "traits": { + "smithy.api#xmlName": "HealthCheck" + } + } + }, + "com.amazonaws.route53#HealthThreshold": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.route53#HostedZone": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID that Amazon Route 53 assigned to the hosted zone when you created it.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

The name of the domain. For public hosted zones, this is the name that you have\n\t\t\tregistered with your DNS registrar.

\n

For information about how to specify characters other than a-z,\n\t\t\t\t0-9, and - (hyphen) and how to specify internationalized\n\t\t\tdomain names, see CreateHostedZone.

", + "smithy.api#required": {} + } + }, + "CallerReference": { + "target": "com.amazonaws.route53#Nonce", + "traits": { + "smithy.api#documentation": "

The value that you specified for CallerReference when you created the\n\t\t\thosted zone.

", + "smithy.api#required": {} + } + }, + "Config": { + "target": "com.amazonaws.route53#HostedZoneConfig", + "traits": { + "smithy.api#documentation": "

A complex type that includes the Comment and PrivateZone\n\t\t\telements. If you omitted the HostedZoneConfig and Comment\n\t\t\telements from the request, the Config and Comment elements\n\t\t\tdon't appear in the response.

" + } + }, + "ResourceRecordSetCount": { + "target": "com.amazonaws.route53#HostedZoneRRSetCount", + "traits": { + "smithy.api#documentation": "

The number of resource record sets in the hosted zone.

" + } + }, + "LinkedService": { + "target": "com.amazonaws.route53#LinkedService", + "traits": { + "smithy.api#documentation": "

If the hosted zone was created by another service, the service that created the hosted\n\t\t\tzone. When a hosted zone is created by another service, you can't edit or delete it\n\t\t\tusing Route 53.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains general information about the hosted zone.

" + } + }, + "com.amazonaws.route53#HostedZoneAlreadyExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The hosted zone you're trying to create already exists. Amazon Route 53 returns this\n\t\t\terror when a hosted zone has already been created with the specified\n\t\t\t\tCallerReference.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.route53#HostedZoneConfig": { + "type": "structure", + "members": { + "Comment": { + "target": "com.amazonaws.route53#ResourceDescription", + "traits": { + "smithy.api#documentation": "

Any comments that you want to include about the hosted zone.

" + } + }, + "PrivateZone": { + "target": "com.amazonaws.route53#IsPrivateZone", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether this is a private hosted zone.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains an optional comment about your hosted zone. If you don't\n\t\t\twant to specify a comment, omit both the HostedZoneConfig and\n\t\t\t\tComment elements.

" + } + }, + "com.amazonaws.route53#HostedZoneCount": { + "type": "long" + }, + "com.amazonaws.route53#HostedZoneLimit": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.route53#HostedZoneLimitType", + "traits": { + "smithy.api#documentation": "

The limit that you requested. Valid values include the following:

\n ", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.route53#LimitValue", + "traits": { + "smithy.api#documentation": "

The current value for the limit that is specified by Type.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the type of limit that you specified in the request and\n\t\t\tthe current value for that limit.

" + } + }, + "com.amazonaws.route53#HostedZoneLimitType": { + "type": "enum", + "members": { + "MAX_RRSETS_BY_ZONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_RRSETS_BY_ZONE" + } + }, + "MAX_VPCS_ASSOCIATED_BY_ZONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_VPCS_ASSOCIATED_BY_ZONE" + } + } + } + }, + "com.amazonaws.route53#HostedZoneNotEmpty": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The hosted zone contains resource records that are not SOA or NS records.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#HostedZoneNotFound": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified HostedZone can't be found.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#HostedZoneNotPrivate": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified hosted zone is a public hosted zone, not a private hosted zone.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#HostedZoneOwner": { + "type": "structure", + "members": { + "OwningAccount": { + "target": "com.amazonaws.route53#AWSAccountID", + "traits": { + "smithy.api#documentation": "

If the hosted zone was created by an Amazon Web Services account, or was created by an\n\t\t\t\tAmazon Web Services service that creates hosted zones using the current account,\n\t\t\t\tOwningAccount contains the account ID of that account. For example,\n\t\t\twhen you use Cloud Map to create a hosted zone, Cloud Map creates the hosted\n\t\t\tzone using the current Amazon Web Services account.

" + } + }, + "OwningService": { + "target": "com.amazonaws.route53#HostedZoneOwningService", + "traits": { + "smithy.api#documentation": "

If an Amazon Web Services service uses its own account to create a hosted zone and\n\t\t\tassociate the specified VPC with that hosted zone, OwningService contains\n\t\t\tan abbreviation that identifies the service. For example, if Amazon Elastic File System\n\t\t\t(Amazon EFS) created a hosted zone and associated a VPC with the hosted zone, the value\n\t\t\tof OwningService is efs.amazonaws.com.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that identifies a hosted zone that a specified Amazon VPC is associated\n\t\t\twith and the owner of the hosted zone. If there is a value for\n\t\t\t\tOwningAccount, there is no value for OwningService, and\n\t\t\tvice versa.

" + } + }, + "com.amazonaws.route53#HostedZoneOwningService": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.route53#HostedZonePartiallyDelegated": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The hosted zone nameservers don't match the parent nameservers. The hosted zone and\n\t\t\tparent must have the same nameservers.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#HostedZoneRRSetCount": { + "type": "long" + }, + "com.amazonaws.route53#HostedZoneSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#HostedZoneSummary", + "traits": { + "smithy.api#xmlName": "HostedZoneSummary" + } + } + }, + "com.amazonaws.route53#HostedZoneSummary": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The Route 53 hosted zone ID of a private hosted zone that the specified VPC is\n\t\t\tassociated with.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

The name of the private hosted zone, such as example.com.

", + "smithy.api#required": {} + } + }, + "Owner": { + "target": "com.amazonaws.route53#HostedZoneOwner", + "traits": { + "smithy.api#documentation": "

The owner of a private hosted zone that the specified VPC is associated with. The\n\t\t\towner can be either an Amazon Web Services account or an Amazon Web Services\n\t\t\tservice.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

In the response to a ListHostedZonesByVPC request, the\n\t\t\t\tHostedZoneSummaries element contains one HostedZoneSummary\n\t\t\telement for each hosted zone that the specified Amazon VPC is associated with. Each\n\t\t\t\tHostedZoneSummary element contains the hosted zone name and ID, and\n\t\t\tinformation about who owns the hosted zone.

" + } + }, + "com.amazonaws.route53#HostedZoneType": { + "type": "enum", + "members": { + "PRIVATE_HOSTED_ZONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PrivateHostedZone" + } + } + } + }, + "com.amazonaws.route53#HostedZones": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#HostedZone", + "traits": { + "smithy.api#xmlName": "HostedZone" + } + } + }, + "com.amazonaws.route53#IPAddress": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 45 + }, + "smithy.api#pattern": "^(^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$)$" + } + }, + "com.amazonaws.route53#IPAddressCidr": { + "type": "string" + }, + "com.amazonaws.route53#IncompatibleVersion": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The resource you're trying to access is unsupported on this Amazon Route 53\n\t\t\tendpoint.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#InsufficientCloudWatchLogsResourcePolicy": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Amazon Route 53 doesn't have the permissions required to create log streams and send\n\t\t\tquery logs to log streams. Possible causes include the following:

\n ", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#InsufficientDataHealthStatus": { + "type": "enum", + "members": { + "Healthy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Healthy" + } + }, + "Unhealthy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unhealthy" + } + }, + "LastKnownStatus": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastKnownStatus" + } + } + } + }, + "com.amazonaws.route53#InvalidArgument": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Parameter name is not valid.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#InvalidChangeBatch": { + "type": "structure", + "members": { + "messages": { + "target": "com.amazonaws.route53#ErrorMessages", + "traits": { + "smithy.api#documentation": "

" + } + }, + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

This exception contains a list of messages that might contain one or more error\n\t\t\tmessages. Each error message indicates one error in the change batch.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#InvalidDomainName": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified domain name is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#InvalidInput": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The input is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#InvalidKMSArn": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC\n\t\t\tsigning.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#InvalidKeySigningKeyName": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The key-signing key (KSK) name that you specified isn't a valid name.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#InvalidKeySigningKeyStatus": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The key-signing key (KSK) status isn't valid or another KSK has the status\n\t\t\t\tINTERNAL_FAILURE.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#InvalidPaginationToken": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The value that you specified to get the second or subsequent page of results is\n\t\t\tinvalid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#InvalidSigningStatus": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Your hosted zone status isn't valid for this operation. In the hosted zone, change the\n\t\t\tstatus to enable DNSSEC or disable DNSSEC.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#InvalidTrafficPolicyDocument": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The format of the traffic policy document that you specified in the\n\t\t\t\tDocument element is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#InvalidVPCId": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The VPC ID that you specified either isn't a valid ID or the current account is not\n\t\t\tauthorized to access this VPC.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#Inverted": { + "type": "boolean" + }, + "com.amazonaws.route53#IsPrivateZone": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.route53#KeySigningKey": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53#SigningKeyName", + "traits": { + "smithy.api#documentation": "

A string used to identify a key-signing key (KSK). Name can include\n\t\t\tnumbers, letters, and underscores (_). Name must be unique for each\n\t\t\tkey-signing key in the same hosted zone.

" + } + }, + "KmsArn": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS). The KmsArn must be unique for each\n\t\t\tkey-signing key (KSK) in a single hosted zone.

\n

You must configure the customer managed key as follows:

\n
\n
Status
\n
\n

Enabled

\n
\n
Key spec
\n
\n

ECC_NIST_P256

\n
\n
Key usage
\n
\n

Sign and verify

\n
\n
Key policy
\n
\n

The key policy must give permission for the following actions:

\n
    \n
  • \n

    DescribeKey

    \n
    • \n
  • \n

    GetPublicKey

    \n
    • \n
  • \n

    Sign

    \n
    • \n
\n

The key policy must also include the Amazon Route 53 service in the\n\t\t\t\t\t\tprincipal for your account. Specify the following:

\n
    \n
  • \n

    \n \"Service\": \"dnssec-route53.amazonaws.com\"\n

    \n
    • \n
\n
\n
\n

For more information about working with the customer managed key in KMS, see Key Management Service\n\t\t\t\tconcepts.

" + } + }, + "Flag": { + "target": "com.amazonaws.route53#SigningKeyInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

An integer that specifies how the key is used. For key-signing key (KSK), this value\n\t\t\tis always 257.

" + } + }, + "SigningAlgorithmMnemonic": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

A string used to represent the signing algorithm. This value must follow the\n\t\t\tguidelines provided by RFC-8624 Section 3.1.

" + } + }, + "SigningAlgorithmType": { + "target": "com.amazonaws.route53#SigningKeyInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

An integer used to represent the signing algorithm. This value must follow the\n\t\t\tguidelines provided by RFC-8624 Section 3.1.

" + } + }, + "DigestAlgorithmMnemonic": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

A string used to represent the delegation signer digest algorithm. This value must\n\t\t\tfollow the guidelines provided by RFC-8624 Section 3.3.\n\t\t

" + } + }, + "DigestAlgorithmType": { + "target": "com.amazonaws.route53#SigningKeyInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

An integer used to represent the delegation signer digest algorithm. This value must\n\t\t\tfollow the guidelines provided by RFC-8624 Section\n\t\t\t3.3.

" + } + }, + "KeyTag": { + "target": "com.amazonaws.route53#SigningKeyTag", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

An integer used to identify the DNSSEC record for the domain name. The process used to\n\t\t\tcalculate the value is described in RFC-4034 Appendix B.

" + } + }, + "DigestValue": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are used to\n\t\t\tpublish the public key that resolvers can use to verify DNSSEC signatures that are used\n\t\t\tto secure certain kinds of information provided by the DNS system.

" + } + }, + "PublicKey": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.

" + } + }, + "DSRecord": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

A string that represents a delegation signer (DS) record.

" + } + }, + "DNSKEYRecord": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "

A string that represents a DNSKEY record.

" + } + }, + "Status": { + "target": "com.amazonaws.route53#SigningKeyStatus", + "traits": { + "smithy.api#documentation": "

A string that represents the current key-signing key (KSK) status.

\n

Status can have one of the following values:

\n
\n
ACTIVE
\n
\n

The KSK is being used for signing.

\n
\n
INACTIVE
\n
\n

The KSK is not being used for signing.

\n
\n
DELETING
\n
\n

The KSK is in the process of being deleted.

\n
\n
ACTION_NEEDED
\n
\n

There is a problem with the KSK that requires you to take action to\n\t\t\t\t\t\tresolve. For example, the customer managed key might have been deleted,\n\t\t\t\t\t\tor the permissions for the customer managed key might have been\n\t\t\t\t\t\tchanged.

\n
\n
INTERNAL_FAILURE
\n
\n

There was an error during a request. Before you can continue to work with\n\t\t\t\t\t\tDNSSEC signing, including actions that involve this KSK, you must correct\n\t\t\t\t\t\tthe problem. For example, you may need to activate or deactivate the\n\t\t\t\t\t\tKSK.

\n
\n
" + } + }, + "StatusMessage": { + "target": "com.amazonaws.route53#SigningKeyStatusMessage", + "traits": { + "smithy.api#documentation": "

The status message provided for the following key-signing key (KSK) statuses:\n\t\t\t\tACTION_NEEDED or INTERNAL_FAILURE. The status message\n\t\t\tincludes information about what the problem might be and steps that you can take to\n\t\t\tcorrect the issue.

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.route53#TimeStamp", + "traits": { + "smithy.api#documentation": "

The date when the key-signing key (KSK) was created.

" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.route53#TimeStamp", + "traits": { + "smithy.api#documentation": "

The last time that the key-signing key (KSK) was changed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A key-signing key (KSK) is a complex type that represents a public/private key pair.\n\t\t\tThe private key is used to generate a digital signature for the zone signing key (ZSK).\n\t\t\tThe public key is stored in the DNS and is used to authenticate the ZSK. A KSK is always\n\t\t\tassociated with a hosted zone; it cannot exist by itself.

" + } + }, + "com.amazonaws.route53#KeySigningKeyAlreadyExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You've already created a key-signing key (KSK) with this name or with the same customer managed key ARN.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.route53#KeySigningKeyInParentDSRecord": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The key-signing key (KSK) is specified in a parent DS record.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#KeySigningKeyInUse": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The key-signing key (KSK) that you specified can't be deactivated because it's the\n\t\t\tonly KSK for a currently-enabled DNSSEC. Disable DNSSEC signing, or add or enable\n\t\t\tanother KSK.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#KeySigningKeyWithActiveStatusNotFound": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

A key-signing key (KSK) with ACTIVE status wasn't found.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#KeySigningKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#KeySigningKey" + } + }, + "com.amazonaws.route53#LastVPCAssociation": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The VPC that you're trying to disassociate from the private hosted zone is the last\n\t\t\tVPC that is associated with the hosted zone. Amazon Route 53 doesn't support\n\t\t\tdisassociating the last VPC from a hosted zone.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#Latitude": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6 + }, + "smithy.api#pattern": "^[-+]?[0-9]{1,2}(\\.[0-9]{0,2})?$" + } + }, + "com.amazonaws.route53#LimitValue": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.route53#LimitsExceeded": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This operation can't be completed because the current account has reached the\n\t\t\tlimit on the resource you are trying to create. To request a higher limit, create a case with the Amazon Web Services Support\n\t\t\tCenter.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#LinkedService": { + "type": "structure", + "members": { + "ServicePrincipal": { + "target": "com.amazonaws.route53#ServicePrincipal", + "traits": { + "smithy.api#documentation": "

If the health check or hosted zone was created by another service, the service that\n\t\t\tcreated the resource. When a resource is created by another service, you can't edit or\n\t\t\tdelete it using Amazon Route 53.

" + } + }, + "Description": { + "target": "com.amazonaws.route53#ResourceDescription", + "traits": { + "smithy.api#documentation": "

If the health check or hosted zone was created by another service, an optional\n\t\t\tdescription that can be provided by the other service. When a resource is created by\n\t\t\tanother service, you can't edit or delete it using Amazon Route 53.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

If a health check or hosted zone was created by another service,\n\t\t\t\tLinkedService is a complex type that describes the service that created\n\t\t\tthe resource. When a resource is created by another service, you can't edit or delete it\n\t\t\tusing Amazon Route 53.

" + } + }, + "com.amazonaws.route53#ListCidrBlocks": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListCidrBlocksRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListCidrBlocksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchCidrCollectionException" + }, + { + "target": "com.amazonaws.route53#NoSuchCidrLocationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a paginated list of location objects and their CIDR blocks.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/cidrcollection/{CollectionId}/cidrblocks", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CidrBlocks", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.route53#ListCidrBlocksRequest": { + "type": "structure", + "members": { + "CollectionId": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "

The UUID of the CIDR collection.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LocationName": { + "target": "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed", + "traits": { + "smithy.api#documentation": "

The name of the CIDR collection location.

", + "smithy.api#httpQuery": "location" + } + }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

", + "smithy.api#httpQuery": "nexttoken" + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Maximum number of results you want returned.

", + "smithy.api#httpQuery": "maxresults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListCidrBlocksResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n

If no value is provided, the listing of results starts from the beginning.

" + } + }, + "CidrBlocks": { + "target": "com.amazonaws.route53#CidrBlockSummaries", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the CIDR blocks.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListCidrCollections": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListCidrCollectionsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListCidrCollectionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a paginated list of CIDR collections in the Amazon Web Services account\n\t\t\t(metadata only).

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/cidrcollection", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CidrCollections", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.route53#ListCidrCollectionsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n

If no value is provided, the listing of results starts from the beginning.

", + "smithy.api#httpQuery": "nexttoken" + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of CIDR collections to return in the response.

", + "smithy.api#httpQuery": "maxresults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListCidrCollectionsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n

If no value is provided, the listing of results starts from the beginning.

" + } + }, + "CidrCollections": { + "target": "com.amazonaws.route53#CollectionSummaries", + "traits": { + "smithy.api#documentation": "

A complex type with information about the CIDR collection.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListCidrLocations": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListCidrLocationsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListCidrLocationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchCidrCollectionException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a paginated list of CIDR locations for the given collection (metadata only,\n\t\t\tdoes not include CIDR blocks).

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/cidrcollection/{CollectionId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CidrLocations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.route53#ListCidrLocationsRequest": { + "type": "structure", + "members": { + "CollectionId": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "

The CIDR collection ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n

If no value is provided, the listing of results starts from the beginning.

", + "smithy.api#httpQuery": "nexttoken" + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of CIDR collection locations to return in the response.

", + "smithy.api#httpQuery": "maxresults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListCidrLocationsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n

If no value is provided, the listing of results starts from the beginning.

" + } + }, + "CidrLocations": { + "target": "com.amazonaws.route53#LocationSummaries", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the list of CIDR locations.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListGeoLocations": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListGeoLocationsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListGeoLocationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of supported geographic locations.

\n

Countries are listed first, and continents are listed last. If Amazon Route 53\n\t\t\tsupports subdivisions for a country (for example, states or provinces), the subdivisions\n\t\t\tfor that country are listed in alphabetical order immediately after the corresponding\n\t\t\tcountry.

\n

Route 53 does not perform authorization for this API because it retrieves information\n\t\t\tthat is already available to the public.

\n

For a list of supported geolocation codes, see the GeoLocation data\n\t\t\ttype.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/geolocations", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListGeoLocationsRequest": { + "type": "structure", + "members": { + "StartContinentCode": { + "target": "com.amazonaws.route53#GeoLocationContinentCode", + "traits": { + "smithy.api#documentation": "

The code for the continent with which you want to start listing locations that Amazon\n\t\t\tRoute 53 supports for geolocation. If Route 53 has already returned a page or more of\n\t\t\tresults, if IsTruncated is true, and if NextContinentCode from\n\t\t\tthe previous response has a value, enter that value in startcontinentcode\n\t\t\tto return the next page of results.

\n

Include startcontinentcode only if you want to list continents. Don't\n\t\t\tinclude startcontinentcode when you're listing countries or countries with\n\t\t\ttheir subdivisions.

", + "smithy.api#httpQuery": "startcontinentcode" + } + }, + "StartCountryCode": { + "target": "com.amazonaws.route53#GeoLocationCountryCode", + "traits": { + "smithy.api#documentation": "

The code for the country with which you want to start listing locations that Amazon\n\t\t\tRoute 53 supports for geolocation. If Route 53 has already returned a page or more of\n\t\t\tresults, if IsTruncated is true, and if\n\t\t\t\tNextCountryCode from the previous response has a value, enter that\n\t\t\tvalue in startcountrycode to return the next page of results.

", + "smithy.api#httpQuery": "startcountrycode" + } + }, + "StartSubdivisionCode": { + "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", + "traits": { + "smithy.api#documentation": "

The code for the state of the United States with which you want to start listing\n\t\t\tlocations that Amazon Route 53 supports for geolocation. If Route 53 has already\n\t\t\treturned a page or more of results, if IsTruncated is true,\n\t\t\tand if NextSubdivisionCode from the previous response has a value, enter\n\t\t\tthat value in startsubdivisioncode to return the next page of\n\t\t\tresults.

\n

To list subdivisions (U.S. states), you must include both\n\t\t\t\tstartcountrycode and startsubdivisioncode.

", + "smithy.api#httpQuery": "startsubdivisioncode" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

(Optional) The maximum number of geolocations to be included in the response body for this\n\t\t\trequest. If more than maxitems geolocations remain to be listed, then the\n\t\t\tvalue of the IsTruncated element in the response is\n\t\t\ttrue.

", + "smithy.api#httpQuery": "maxitems" + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to get a list of geographic locations that Amazon Route 53 supports for\n\t\t\tgeolocation resource record sets.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListGeoLocationsResponse": { + "type": "structure", + "members": { + "GeoLocationDetailsList": { + "target": "com.amazonaws.route53#GeoLocationDetailsList", + "traits": { + "smithy.api#documentation": "

A complex type that contains one GeoLocationDetails element for each\n\t\t\tlocation that Amazon Route 53 supports for geolocation.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates whether more locations remain to be listed after the last\n\t\t\tlocation in this response. If so, the value of IsTruncated is\n\t\t\t\ttrue. To get more values, submit another request and include the values\n\t\t\tof NextContinentCode, NextCountryCode, and\n\t\t\t\tNextSubdivisionCode in the startcontinentcode,\n\t\t\t\tstartcountrycode, and startsubdivisioncode, as\n\t\t\tapplicable.

", + "smithy.api#required": {} + } + }, + "NextContinentCode": { + "target": "com.amazonaws.route53#GeoLocationContinentCode", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, you can make a follow-up request to\n\t\t\tdisplay more locations. Enter the value of NextContinentCode in the\n\t\t\t\tstartcontinentcode parameter in another ListGeoLocations\n\t\t\trequest.

" + } + }, + "NextCountryCode": { + "target": "com.amazonaws.route53#GeoLocationCountryCode", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, you can make a follow-up request to\n\t\t\tdisplay more locations. Enter the value of NextCountryCode in the\n\t\t\t\tstartcountrycode parameter in another ListGeoLocations\n\t\t\trequest.

" + } + }, + "NextSubdivisionCode": { + "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, you can make a follow-up request to\n\t\t\tdisplay more locations. Enter the value of NextSubdivisionCode in the\n\t\t\t\tstartsubdivisioncode parameter in another ListGeoLocations\n\t\t\trequest.

" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The value that you specified for MaxItems in the request.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type containing the response information for the request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListHealthChecks": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListHealthChecksRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListHealthChecksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#IncompatibleVersion" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieve a list of the health checks that are associated with the current Amazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/healthcheck", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "items": "HealthChecks", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.route53#ListHealthChecksRequest": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more health checks. To get another group, submit another\n\t\t\t\tListHealthChecks request.

\n

For the value of marker, specify the value of NextMarker\n\t\t\tfrom the previous response, which is the ID of the first health check that Amazon Route\n\t\t\t53 will return if you submit another request.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more health checks to get.

", + "smithy.api#httpQuery": "marker" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of health checks that you want ListHealthChecks to\n\t\t\treturn in response to the current request. Amazon Route 53 returns a maximum of 1000\n\t\t\titems. If you set MaxItems to a value greater than 1000, Route 53 returns\n\t\t\tonly the first 1000 health checks.

", + "smithy.api#httpQuery": "maxitems" + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to retrieve a list of the health checks that are associated with the current\n\t\t\t\tAmazon Web Services account.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListHealthChecksResponse": { + "type": "structure", + "members": { + "HealthChecks": { + "target": "com.amazonaws.route53#HealthChecks", + "traits": { + "smithy.api#documentation": "

A complex type that contains one HealthCheck element for each health\n\t\t\tcheck that is associated with the current Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "

For the second and subsequent calls to ListHealthChecks,\n\t\t\t\tMarker is the value that you specified for the marker\n\t\t\tparameter in the previous request.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more health checks to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of health checks by submitting\n\t\t\tanother ListHealthChecks request and specifying the value of\n\t\t\t\tNextMarker in the marker parameter.

", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, the value of NextMarker\n\t\t\tidentifies the first health check that Amazon Route 53 returns if you submit another\n\t\t\t\tListHealthChecks request and specify the value of\n\t\t\t\tNextMarker in the marker parameter.

" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListHealthChecks that produced the current response.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response to a ListHealthChecks\n\t\t\trequest.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListHostedZones": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListHostedZonesRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListHostedZonesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#DelegationSetNotReusable" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchDelegationSet" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of the public and private hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account. The response includes a HostedZones\n\t\t\tchild element for each hosted zone.

\n

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of\n\t\t\thosted zones, you can use the maxitems parameter to list them in groups of\n\t\t\tup to 100.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/hostedzone", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "items": "HostedZones", + "pageSize": "MaxItems" + }, + "smithy.test#smokeTests": [ + { + "id": "ListHostedZonesSuccess", + "params": {}, + "vendorParams": { + "region": "us-east-1" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] + } + }, + "com.amazonaws.route53#ListHostedZonesByName": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListHostedZonesByNameRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListHostedZonesByNameResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidDomainName" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of your hosted zones in lexicographic order. The response includes a\n\t\t\t\tHostedZones child element for each hosted zone created by the current\n\t\t\t\tAmazon Web Services account.

\n

\n ListHostedZonesByName sorts hosted zones by name with the labels\n\t\t\treversed. For example:

\n

\n com.example.www.\n

\n

Note the trailing dot, which can change the sort order in some circumstances.

\n

If the domain name includes escape characters or Punycode,\n\t\t\t\tListHostedZonesByName alphabetizes the domain name using the escaped or\n\t\t\tPunycoded value, which is the format that Amazon Route 53 saves in its database. For\n\t\t\texample, to create a hosted zone for exämple.com, you specify ex\\344mple.com for\n\t\t\tthe domain name. ListHostedZonesByName alphabetizes it as:

\n

\n com.ex\\344mple.\n

\n

The labels are reversed and alphabetized using the escaped value. For more information\n\t\t\tabout valid domain name formats, including internationalized domain names, see DNS\n\t\t\t\tDomain Name Format in the Amazon Route 53 Developer\n\t\t\t\tGuide.

\n

Route 53 returns up to 100 items in each response. If you have a lot of hosted zones,\n\t\t\tuse the MaxItems parameter to list them in groups of up to 100. The\n\t\t\tresponse includes values that help navigate from one group of MaxItems\n\t\t\thosted zones to the next:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/hostedzonesbyname", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListHostedZonesByNameRequest": { + "type": "structure", + "members": { + "DNSName": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

(Optional) For your first request to ListHostedZonesByName, include the\n\t\t\t\tdnsname parameter only if you want to specify the name of the first\n\t\t\thosted zone in the response. If you don't include the dnsname parameter,\n\t\t\tAmazon Route 53 returns all of the hosted zones that were created by the current Amazon Web Services account, in ASCII order. For subsequent requests, include both\n\t\t\t\tdnsname and hostedzoneid parameters. For\n\t\t\t\tdnsname, specify the value of NextDNSName from the\n\t\t\tprevious response.

", + "smithy.api#httpQuery": "dnsname" + } + }, + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

(Optional) For your first request to ListHostedZonesByName, do not\n\t\t\tinclude the hostedzoneid parameter.

\n

If you have more hosted zones than the value of maxitems,\n\t\t\t\tListHostedZonesByName returns only the first maxitems\n\t\t\thosted zones. To get the next group of maxitems hosted zones, submit\n\t\t\tanother request to ListHostedZonesByName and include both\n\t\t\t\tdnsname and hostedzoneid parameters. For the value of\n\t\t\t\thostedzoneid, specify the value of the NextHostedZoneId\n\t\t\telement from the previous response.

", + "smithy.api#httpQuery": "hostedzoneid" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of hosted zones to be included in the response body for this\n\t\t\trequest. If you have more than maxitems hosted zones, then the value of the\n\t\t\t\tIsTruncated element in the response is true, and the values of\n\t\t\t\tNextDNSName and NextHostedZoneId specify the first hosted\n\t\t\tzone in the next group of maxitems hosted zones.

", + "smithy.api#httpQuery": "maxitems" + } + } + }, + "traits": { + "smithy.api#documentation": "

Retrieves a list of the public and private hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account in ASCII order by domain name.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListHostedZonesByNameResponse": { + "type": "structure", + "members": { + "HostedZones": { + "target": "com.amazonaws.route53#HostedZones", + "traits": { + "smithy.api#documentation": "

A complex type that contains general information about the hosted zone.

", + "smithy.api#required": {} + } + }, + "DNSName": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

For the second and subsequent calls to ListHostedZonesByName,\n\t\t\t\tDNSName is the value that you specified for the dnsname\n\t\t\tparameter in the request that produced the current response.

" + } + }, + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID that Amazon Route 53 assigned to the hosted zone when you created it.

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more hosted zones to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of maxitems hosted zones\n\t\t\tby calling ListHostedZonesByName again and specifying the values of\n\t\t\t\tNextDNSName and NextHostedZoneId elements in the\n\t\t\t\tdnsname and hostedzoneid parameters.

", + "smithy.api#required": {} + } + }, + "NextDNSName": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, the value of NextDNSName is the name\n\t\t\tof the first hosted zone in the next group of maxitems hosted zones. Call\n\t\t\t\tListHostedZonesByName again and specify the value of\n\t\t\t\tNextDNSName and NextHostedZoneId in the\n\t\t\t\tdnsname and hostedzoneid parameters, respectively.

\n

This element is present only if IsTruncated is true.

" + } + }, + "NextHostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, the value of\n\t\t\t\tNextHostedZoneId identifies the first hosted zone in the next group of\n\t\t\t\tmaxitems hosted zones. Call ListHostedZonesByName again\n\t\t\tand specify the value of NextDNSName and NextHostedZoneId in\n\t\t\tthe dnsname and hostedzoneid parameters, respectively.

\n

This element is present only if IsTruncated is true.

" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListHostedZonesByName that produced the current response.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response information for the request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListHostedZonesByVPC": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListHostedZonesByVPCRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListHostedZonesByVPCResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidPaginationToken" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the private hosted zones that a specified VPC is associated with, regardless\n\t\t\tof which Amazon Web Services account or Amazon Web Services service owns the hosted zones.\n\t\t\tThe HostedZoneOwner structure in the response contains one of the following\n\t\t\tvalues:

\n \n \n

When listing private hosted zones, the hosted zone and the Amazon VPC must\n\t\t\t\tbelong to the same partition where the hosted zones were created. A partition is a\n\t\t\t\tgroup of Amazon Web Services Regions. Each Amazon Web Services account is scoped to\n\t\t\t\tone partition.

\n

The following are the supported partitions:

\n \n

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/hostedzonesbyvpc", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListHostedZonesByVPCRequest": { + "type": "structure", + "members": { + "VPCId": { + "target": "com.amazonaws.route53#VPCId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon VPC that you want to list hosted zones for.

", + "smithy.api#httpQuery": "vpcid", + "smithy.api#required": {} + } + }, + "VPCRegion": { + "target": "com.amazonaws.route53#VPCRegion", + "traits": { + "smithy.api#documentation": "

For the Amazon VPC that you specified for VPCId, the Amazon Web Services\n\t\t\tRegion that you created the VPC in.

", + "smithy.api#httpQuery": "vpcregion", + "smithy.api#required": {} + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return.\n\t\t\tIf the specified VPC is associated with more than MaxItems hosted zones,\n\t\t\tthe response includes a NextToken element. NextToken contains\n\t\t\tan encrypted token that identifies the first hosted zone that Route 53 will return if\n\t\t\tyou submit another request.

", + "smithy.api#httpQuery": "maxitems" + } + }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

If the previous response included a NextToken element, the specified VPC\n\t\t\tis associated with more hosted zones. To get more hosted zones, submit another\n\t\t\t\tListHostedZonesByVPC request.

\n

For the value of NextToken, specify the value of NextToken\n\t\t\tfrom the previous response.

\n

If the previous response didn't include a NextToken element, there are no\n\t\t\tmore hosted zones to get.

", + "smithy.api#httpQuery": "nexttoken" + } + } + }, + "traits": { + "smithy.api#documentation": "

Lists all the private hosted zones that a specified VPC is associated with, regardless\n\t\t\tof which Amazon Web Services account created the hosted zones.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListHostedZonesByVPCResponse": { + "type": "structure", + "members": { + "HostedZoneSummaries": { + "target": "com.amazonaws.route53#HostedZoneSummaries", + "traits": { + "smithy.api#documentation": "

A list that contains one HostedZoneSummary element for each hosted zone\n\t\t\tthat the specified Amazon VPC is associated with. Each HostedZoneSummary\n\t\t\telement contains the hosted zone name and ID, and information about who owns the hosted\n\t\t\tzone.

", + "smithy.api#required": {} + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The value that you specified for MaxItems in the most recent\n\t\t\t\tListHostedZonesByVPC request.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

The value that you will use for NextToken in the next\n\t\t\t\tListHostedZonesByVPC request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListHostedZonesRequest": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more hosted zones. To get more hosted zones, submit\n\t\t\tanother ListHostedZones request.

\n

For the value of marker, specify the value of NextMarker\n\t\t\tfrom the previous response, which is the ID of the first hosted zone that Amazon Route\n\t\t\t53 will return if you submit another request.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more hosted zones to get.

", + "smithy.api#httpQuery": "marker" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return.\n\t\t\tIf you have more than maxitems hosted zones, the value of\n\t\t\t\tIsTruncated in the response is true, and the value of\n\t\t\t\tNextMarker is the hosted zone ID of the first hosted zone that Route 53\n\t\t\twill return if you submit another request.

", + "smithy.api#httpQuery": "maxitems" + } + }, + "DelegationSetId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

If you're using reusable delegation sets and you want to list all of the hosted zones\n\t\t\tthat are associated with a reusable delegation set, specify the ID of that reusable\n\t\t\tdelegation set.

", + "smithy.api#httpQuery": "delegationsetid" + } + }, + "HostedZoneType": { + "target": "com.amazonaws.route53#HostedZoneType", + "traits": { + "smithy.api#documentation": "

\n\t\t\t(Optional) Specifies if the hosted zone is private.\n\t\t

", + "smithy.api#httpQuery": "hostedzonetype" + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to retrieve a list of the public and private hosted zones that are\n\t\t\tassociated with the current Amazon Web Services account.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListHostedZonesResponse": { + "type": "structure", + "members": { + "HostedZones": { + "target": "com.amazonaws.route53#HostedZones", + "traits": { + "smithy.api#documentation": "

A complex type that contains general information about the hosted zone.

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "

For the second and subsequent calls to ListHostedZones,\n\t\t\t\tMarker is the value that you specified for the marker\n\t\t\tparameter in the request that produced the current response.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag indicating whether there are more hosted zones to be listed. If the response\n\t\t\twas truncated, you can get more hosted zones by submitting another\n\t\t\t\tListHostedZones request and specifying the value of\n\t\t\t\tNextMarker in the marker parameter.

", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, the value of NextMarker\n\t\t\tidentifies the first hosted zone in the next group of hosted zones. Submit another\n\t\t\t\tListHostedZones request, and specify the value of\n\t\t\t\tNextMarker from the response in the marker\n\t\t\tparameter.

\n

This element is present only if IsTruncated is true.

" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListHostedZones that produced the current response.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListQueryLoggingConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListQueryLoggingConfigsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListQueryLoggingConfigsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidPaginationToken" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the configurations for DNS query logging that are associated with the current\n\t\t\t\tAmazon Web Services account or the configuration that is associated with a specified\n\t\t\thosted zone.

\n

For more information about DNS query logs, see CreateQueryLoggingConfig. Additional information, including the format of\n\t\t\tDNS query logs, appears in Logging DNS Queries in\n\t\t\tthe Amazon Route 53 Developer Guide.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/queryloggingconfig", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "QueryLoggingConfigs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.route53#ListQueryLoggingConfigsRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

(Optional) If you want to list the query logging configuration that is associated with\n\t\t\ta hosted zone, specify the ID in HostedZoneId.

\n

If you don't specify a hosted zone ID, ListQueryLoggingConfigs returns\n\t\t\tall of the configurations that are associated with the current Amazon Web Services account.

", + "smithy.api#httpQuery": "hostedzoneid" + } + }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

(Optional) If the current Amazon Web Services account has more than\n\t\t\t\tMaxResults query logging configurations, use NextToken to\n\t\t\tget the second and subsequent pages of results.

\n

For the first ListQueryLoggingConfigs request, omit this value.

\n

For the second and subsequent requests, get the value of NextToken from\n\t\t\tthe previous response and specify that value for NextToken in the\n\t\t\trequest.

", + "smithy.api#httpQuery": "nexttoken" + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

(Optional) The maximum number of query logging configurations that you want Amazon\n\t\t\tRoute 53 to return in response to the current request. If the current Amazon Web Services account has more than MaxResults configurations, use the\n\t\t\tvalue of NextToken in the response to get the next page of results.

\n

If you don't specify a value for MaxResults, Route 53 returns up to 100\n\t\t\tconfigurations.

", + "smithy.api#httpQuery": "maxresults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListQueryLoggingConfigsResponse": { + "type": "structure", + "members": { + "QueryLoggingConfigs": { + "target": "com.amazonaws.route53#QueryLoggingConfigs", + "traits": { + "smithy.api#documentation": "

An array that contains one QueryLoggingConfig element for each configuration for DNS query logging\n\t\t\tthat is associated with the current Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

If a response includes the last of the query logging configurations that are\n\t\t\tassociated with the current Amazon Web Services account, NextToken doesn't\n\t\t\tappear in the response.

\n

If a response doesn't include the last of the configurations, you can get more\n\t\t\tconfigurations by submitting another ListQueryLoggingConfigs request. Get the value of NextToken\n\t\t\tthat Amazon Route 53 returned in the previous response and include it in\n\t\t\t\tNextToken in the next request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListResourceRecordSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListResourceRecordSetsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListResourceRecordSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the resource record sets in a specified hosted zone.

\n

\n ListResourceRecordSets returns up to 300 resource record sets at a time\n\t\t\tin ASCII order, beginning at a position specified by the name and\n\t\t\t\ttype elements.

\n

\n Sort order\n

\n

\n ListResourceRecordSets sorts results first by DNS name with the labels\n\t\t\treversed, for example:

\n

\n com.example.www.\n

\n

Note the trailing dot, which can change the sort order when the record name contains\n\t\t\tcharacters that appear before . (decimal 46) in the ASCII table. These\n\t\t\tcharacters include the following: ! \" # $ % & ' ( ) * + , -\n

\n

When multiple records have the same DNS name, ListResourceRecordSets\n\t\t\tsorts results by the record type.

\n

\n Specifying where to start listing records\n

\n

You can use the name and type elements to specify the resource record set that the\n\t\t\tlist begins with:

\n
\n
If you do not specify Name or Type
\n
\n

The results begin with the first resource record set that the hosted zone\n\t\t\t\t\t\tcontains.

\n
\n
If you specify Name but not Type
\n
\n

The results begin with the first resource record set in the list whose\n\t\t\t\t\t\tname is greater than or equal to Name.

\n
\n
If you specify Type but not Name
\n
\n

Amazon Route 53 returns the InvalidInput error.

\n
\n
If you specify both Name and Type
\n
\n

The results begin with the first resource record set in the list whose\n\t\t\t\t\t\tname is greater than or equal to Name, and whose type is\n\t\t\t\t\t\tgreater than or equal to Type.

\n
\n
\n

\n Resource record sets that are PENDING\n

\n

This action returns the most current version of the records. This includes records\n\t\t\tthat are PENDING, and that are not yet available on all Route 53 DNS\n\t\t\tservers.

\n

\n Changing resource record sets\n

\n

To ensure that you get an accurate listing of the resource record sets for a hosted\n\t\t\tzone at a point in time, do not submit a ChangeResourceRecordSets request\n\t\t\twhile you're paging through the results of a ListResourceRecordSets\n\t\t\trequest. If you do, some pages may display results without the latest changes while\n\t\t\tother pages display results with the latest changes.

\n

\n Displaying the next page of results\n

\n

If a ListResourceRecordSets command returns more than one page of\n\t\t\tresults, the value of IsTruncated is true. To display the next\n\t\t\tpage of results, get the values of NextRecordName,\n\t\t\t\tNextRecordType, and NextRecordIdentifier (if any) from the\n\t\t\tresponse. Then submit another ListResourceRecordSets request, and specify\n\t\t\tthose values for StartRecordName, StartRecordType, and\n\t\t\t\tStartRecordIdentifier.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/rrset", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListResourceRecordSetsRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that contains the resource record sets that you want to\n\t\t\tlist.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StartRecordName": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

The first name in the lexicographic ordering of resource record sets that you want to\n\t\t\tlist. If the specified record name doesn't exist, the results begin with the first\n\t\t\tresource record set that has a name greater than the value of name.

", + "smithy.api#httpQuery": "name" + } + }, + "StartRecordType": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

The type of resource record set to begin the record listing from.

\n

Valid values for basic resource record sets: A | AAAA |\n\t\t\t\tCAA | CNAME | MX | NAPTR |\n\t\t\t\tNS | PTR | SOA | SPF |\n\t\t\t\tSRV | TXT\n

\n

Values for weighted, latency, geolocation, and failover resource record sets:\n\t\t\t\tA | AAAA | CAA | CNAME |\n\t\t\t\tMX | NAPTR | PTR | SPF |\n\t\t\t\tSRV | TXT\n

\n

Values for alias resource record sets:

\n \n

Constraint: Specifying type without specifying name returns\n\t\t\tan InvalidInput error.

", + "smithy.api#httpQuery": "type" + } + }, + "StartRecordIdentifier": { + "target": "com.amazonaws.route53#ResourceRecordSetIdentifier", + "traits": { + "smithy.api#documentation": "

\n Resource record sets that have a routing policy other than\n\t\t\t\tsimple: If results were truncated for a given DNS name and type, specify\n\t\t\tthe value of NextRecordIdentifier from the previous response to get the\n\t\t\tnext resource record set that has the current DNS name and type.

", + "smithy.api#httpQuery": "identifier" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

(Optional) The maximum number of resource records sets to include in the response body\n\t\t\tfor this request. If the response includes more than maxitems resource\n\t\t\trecord sets, the value of the IsTruncated element in the response is\n\t\t\t\ttrue, and the values of the NextRecordName and\n\t\t\t\tNextRecordType elements in the response identify the first resource\n\t\t\trecord set in the next group of maxitems resource record sets.

", + "smithy.api#httpQuery": "maxitems" + } + } + }, + "traits": { + "smithy.api#documentation": "

A request for the resource record sets that are associated with a specified hosted\n\t\t\tzone.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListResourceRecordSetsResponse": { + "type": "structure", + "members": { + "ResourceRecordSets": { + "target": "com.amazonaws.route53#ResourceRecordSets", + "traits": { + "smithy.api#documentation": "

Information about multiple resource record sets.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether more resource record sets remain to be listed. If your\n\t\t\tresults were truncated, you can make a follow-up pagination request by using the\n\t\t\t\tNextRecordName element.

", + "smithy.api#required": {} + } + }, + "NextRecordName": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

If the results were truncated, the name of the next record in the list.

\n

This element is present only if IsTruncated is true.

" + } + }, + "NextRecordType": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

If the results were truncated, the type of the next record in the list.

\n

This element is present only if IsTruncated is true.

" + } + }, + "NextRecordIdentifier": { + "target": "com.amazonaws.route53#ResourceRecordSetIdentifier", + "traits": { + "smithy.api#documentation": "

\n Resource record sets that have a routing policy other than\n\t\t\t\tsimple: If results were truncated for a given DNS name and type, the\n\t\t\tvalue of SetIdentifier for the next resource record set that has the\n\t\t\tcurrent DNS name and type.

\n

For information about routing policies, see Choosing a Routing\n\t\t\t\tPolicy in the Amazon Route 53 Developer Guide.

" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of records you requested.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains list information for the resource record set.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListReusableDelegationSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListReusableDelegationSetsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListReusableDelegationSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of the reusable delegation sets that are associated with the current\n\t\t\t\tAmazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/delegationset", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListReusableDelegationSetsRequest": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more reusable delegation sets. To get another group,\n\t\t\tsubmit another ListReusableDelegationSets request.

\n

For the value of marker, specify the value of NextMarker\n\t\t\tfrom the previous response, which is the ID of the first reusable delegation set that\n\t\t\tAmazon Route 53 will return if you submit another request.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more reusable delegation sets to get.

", + "smithy.api#httpQuery": "marker" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of reusable delegation sets that you want Amazon Route 53 to return in the\n\t\t\tresponse to this request. If you specify a value greater than 100, Route 53 returns only\n\t\t\tthe first 100 reusable delegation sets.

", + "smithy.api#httpQuery": "maxitems" + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to get a list of the reusable delegation sets that are associated with the\n\t\t\tcurrent Amazon Web Services account.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListReusableDelegationSetsResponse": { + "type": "structure", + "members": { + "DelegationSets": { + "target": "com.amazonaws.route53#DelegationSets", + "traits": { + "smithy.api#documentation": "

A complex type that contains one DelegationSet element for each reusable\n\t\t\tdelegation set that was created by the current Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "

For the second and subsequent calls to ListReusableDelegationSets,\n\t\t\t\tMarker is the value that you specified for the marker\n\t\t\tparameter in the request that produced the current response.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more reusable delegation sets to be\n\t\t\tlisted.

", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, the value of NextMarker\n\t\t\tidentifies the next reusable delegation set that Amazon Route 53 will return if you\n\t\t\tsubmit another ListReusableDelegationSets request and specify the value of\n\t\t\t\tNextMarker in the marker parameter.

" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListReusableDelegationSets that produced the current response.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the reusable delegation sets that are\n\t\t\tassociated with the current Amazon Web Services account.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" + }, + { + "target": "com.amazonaws.route53#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists tags for one health check or hosted zone.

\n

For information about using tags for cost allocation, see Using Cost Allocation\n\t\t\t\tTags in the Billing and Cost Management User Guide.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/tags/{ResourceType}/{ResourceId}", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.route53#TagResourceType", + "traits": { + "smithy.api#documentation": "

The type of the resource.

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.route53#TagResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the resource for which you want to retrieve tags.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type containing information about a request for a list of the tags that are\n\t\t\tassociated with an individual resource.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "ResourceTagSet": { + "target": "com.amazonaws.route53#ResourceTagSet", + "traits": { + "smithy.api#documentation": "

A ResourceTagSet containing tags associated with the specified\n\t\t\tresource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the health checks or hosted zones for\n\t\t\twhich you want to list tags.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListTagsForResources": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListTagsForResourcesRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListTagsForResourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" + }, + { + "target": "com.amazonaws.route53#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists tags for up to 10 health checks or hosted zones.

\n

For information about using tags for cost allocation, see Using Cost Allocation\n\t\t\t\tTags in the Billing and Cost Management User Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/tags/{ResourceType}", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListTagsForResourcesRequest": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.route53#TagResourceType", + "traits": { + "smithy.api#documentation": "

The type of the resources.

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceIds": { + "target": "com.amazonaws.route53#TagResourceIdList", + "traits": { + "smithy.api#documentation": "

A complex type that contains the ResourceId element for each resource for which you\n\t\t\twant to get a list of tags.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the health checks or hosted zones for\n\t\t\twhich you want to list tags.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListTagsForResourcesResponse": { + "type": "structure", + "members": { + "ResourceTagSets": { + "target": "com.amazonaws.route53#ResourceTagSetList", + "traits": { + "smithy.api#documentation": "

A list of ResourceTagSets containing tags associated with the specified\n\t\t\tresources.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type containing tags for the specified resources.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListTrafficPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListTrafficPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListTrafficPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about the latest version for every traffic policy that is associated\n\t\t\twith the current Amazon Web Services account. Policies are listed in the order that they\n\t\t\twere created in.

\n

For information about how of deleting a traffic policy affects the response from\n\t\t\t\tListTrafficPolicies, see DeleteTrafficPolicy.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/trafficpolicies", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListTrafficPoliciesRequest": { + "type": "structure", + "members": { + "TrafficPolicyIdMarker": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

(Conditional) For your first request to ListTrafficPolicies, don't\n\t\t\tinclude the TrafficPolicyIdMarker parameter.

\n

If you have more traffic policies than the value of MaxItems,\n\t\t\t\tListTrafficPolicies returns only the first MaxItems\n\t\t\ttraffic policies. To get the next group of policies, submit another request to\n\t\t\t\tListTrafficPolicies. For the value of\n\t\t\t\tTrafficPolicyIdMarker, specify the value of\n\t\t\t\tTrafficPolicyIdMarker that was returned in the previous\n\t\t\tresponse.

", + "smithy.api#httpQuery": "trafficpolicyid" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

(Optional) The maximum number of traffic policies that you want Amazon Route 53 to\n\t\t\treturn in response to this request. If you have more than MaxItems traffic\n\t\t\tpolicies, the value of IsTruncated in the response is true,\n\t\t\tand the value of TrafficPolicyIdMarker is the ID of the first traffic\n\t\t\tpolicy that Route 53 will return if you submit another request.

", + "smithy.api#httpQuery": "maxitems" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the information about the request to list the traffic\n\t\t\tpolicies that are associated with the current Amazon Web Services account.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListTrafficPoliciesResponse": { + "type": "structure", + "members": { + "TrafficPolicySummaries": { + "target": "com.amazonaws.route53#TrafficPolicySummaries", + "traits": { + "smithy.api#documentation": "

A list that contains one TrafficPolicySummary element for each traffic\n\t\t\tpolicy that was created by the current Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more traffic policies to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of traffic policies by submitting\n\t\t\tanother ListTrafficPolicies request and specifying the value of\n\t\t\t\tTrafficPolicyIdMarker in the TrafficPolicyIdMarker request\n\t\t\tparameter.

", + "smithy.api#required": {} + } + }, + "TrafficPolicyIdMarker": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated is true,\n\t\t\t\tTrafficPolicyIdMarker is the ID of the first traffic policy in the next\n\t\t\tgroup of MaxItems traffic policies.

", + "smithy.api#required": {} + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The value that you specified for the MaxItems parameter in the\n\t\t\t\tListTrafficPolicies request that produced the current response.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response information for the request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListTrafficPolicyInstancesRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListTrafficPolicyInstancesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about the traffic policy instances that you created by using the\n\t\t\tcurrent Amazon Web Services account.

\n \n

After you submit an UpdateTrafficPolicyInstance request, there's a\n\t\t\t\tbrief delay while Amazon Route 53 creates the resource record sets that are\n\t\t\t\tspecified in the traffic policy definition. For more information, see the\n\t\t\t\t\tState response element.

\n \n

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic\n\t\t\tpolicy instances, you can use the MaxItems parameter to list them in groups\n\t\t\tof up to 100.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/trafficpolicyinstances", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZone": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZoneRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZoneResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about the traffic policy instances that you created in a specified\n\t\t\thosted zone.

\n \n

After you submit a CreateTrafficPolicyInstance or an\n\t\t\t\t\tUpdateTrafficPolicyInstance request, there's a brief delay while\n\t\t\t\tAmazon Route 53 creates the resource record sets that are specified in the traffic\n\t\t\t\tpolicy definition. For more information, see the State response\n\t\t\t\telement.

\n \n

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic\n\t\t\tpolicy instances, you can use the MaxItems parameter to list them in groups\n\t\t\tof up to 100.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/trafficpolicyinstances/hostedzone", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZoneRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that you want to list traffic policy instances for.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "TrafficPolicyInstanceNameMarker": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated in the previous response is true, you have\n\t\t\tmore traffic policy instances. To get more traffic policy instances, submit another\n\t\t\t\tListTrafficPolicyInstances request. For the value of\n\t\t\t\ttrafficpolicyinstancename, specify the value of\n\t\t\t\tTrafficPolicyInstanceNameMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", + "smithy.api#httpQuery": "trafficpolicyinstancename" + } + }, + "TrafficPolicyInstanceTypeMarker": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated in the previous response is true, you have\n\t\t\tmore traffic policy instances. To get more traffic policy instances, submit another\n\t\t\t\tListTrafficPolicyInstances request. For the value of\n\t\t\t\ttrafficpolicyinstancetype, specify the value of\n\t\t\t\tTrafficPolicyInstanceTypeMarker from the previous response, which is\n\t\t\tthe type of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", + "smithy.api#httpQuery": "trafficpolicyinstancetype" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of traffic policy instances to be included in the response body for\n\t\t\tthis request. If you have more than MaxItems traffic policy instances, the\n\t\t\tvalue of the IsTruncated element in the response is true, and\n\t\t\tthe values of HostedZoneIdMarker,\n\t\t\t\tTrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker represent the first traffic policy\n\t\t\tinstance that Amazon Route 53 will return if you submit another request.

", + "smithy.api#httpQuery": "maxitems" + } + } + }, + "traits": { + "smithy.api#documentation": "

A request for the traffic policy instances that you created in a specified hosted\n\t\t\tzone.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZoneResponse": { + "type": "structure", + "members": { + "TrafficPolicyInstances": { + "target": "com.amazonaws.route53#TrafficPolicyInstances", + "traits": { + "smithy.api#documentation": "

A list that contains one TrafficPolicyInstance element for each traffic\n\t\t\tpolicy instance that matches the elements in the request.

", + "smithy.api#required": {} + } + }, + "TrafficPolicyInstanceNameMarker": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceNameMarker is the name of the first traffic policy\n\t\t\tinstance in the next group of traffic policy instances.

" + } + }, + "TrafficPolicyInstanceTypeMarker": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, TrafficPolicyInstanceTypeMarker is\n\t\t\tthe DNS type of the resource record sets that are associated with the first traffic\n\t\t\tpolicy instance in the next group of traffic policy instances.

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more traffic policy instances to be listed. If\n\t\t\tthe response was truncated, you can get the next group of traffic policy instances by\n\t\t\tsubmitting another ListTrafficPolicyInstancesByHostedZone request and\n\t\t\tspecifying the values of HostedZoneIdMarker,\n\t\t\t\tTrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker in the corresponding request\n\t\t\tparameters.

", + "smithy.api#required": {} + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The value that you specified for the MaxItems parameter in the\n\t\t\t\tListTrafficPolicyInstancesByHostedZone request that produced the\n\t\t\tcurrent response.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response information for the request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicy" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about the traffic policy instances that you created by using a\n\t\t\tspecify traffic policy version.

\n \n

After you submit a CreateTrafficPolicyInstance or an\n\t\t\t\t\tUpdateTrafficPolicyInstance request, there's a brief delay while\n\t\t\t\tAmazon Route 53 creates the resource record sets that are specified in the traffic\n\t\t\t\tpolicy definition. For more information, see the State response\n\t\t\t\telement.

\n \n

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic\n\t\t\tpolicy instances, you can use the MaxItems parameter to list them in groups\n\t\t\tof up to 100.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/trafficpolicyinstances/trafficpolicy", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyRequest": { + "type": "structure", + "members": { + "TrafficPolicyId": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

The ID of the traffic policy for which you want to list traffic policy\n\t\t\tinstances.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "TrafficPolicyVersion": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "

The version of the traffic policy for which you want to list traffic policy instances.\n\t\t\tThe version must be associated with the traffic policy that is specified by\n\t\t\t\tTrafficPolicyId.

", + "smithy.api#httpQuery": "version", + "smithy.api#required": {} + } + }, + "HostedZoneIdMarker": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstancesByPolicy\n\t\t\trequest.

\n

For the value of hostedzoneid, specify the value of\n\t\t\t\tHostedZoneIdMarker from the previous response, which is the hosted zone\n\t\t\tID of the first traffic policy instance that Amazon Route 53 will return if you submit\n\t\t\tanother request.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", + "smithy.api#httpQuery": "hostedzoneid" + } + }, + "TrafficPolicyInstanceNameMarker": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstancesByPolicy\n\t\t\trequest.

\n

For the value of trafficpolicyinstancename, specify the value of\n\t\t\t\tTrafficPolicyInstanceNameMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance that Amazon Route 53 will return if you\n\t\t\tsubmit another request.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", + "smithy.api#httpQuery": "trafficpolicyinstancename" + } + }, + "TrafficPolicyInstanceTypeMarker": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstancesByPolicy\n\t\t\trequest.

\n

For the value of trafficpolicyinstancetype, specify the value of\n\t\t\t\tTrafficPolicyInstanceTypeMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance that Amazon Route 53 will return if you\n\t\t\tsubmit another request.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", + "smithy.api#httpQuery": "trafficpolicyinstancetype" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of traffic policy instances to be included in the response body for\n\t\t\tthis request. If you have more than MaxItems traffic policy instances, the\n\t\t\tvalue of the IsTruncated element in the response is true, and\n\t\t\tthe values of HostedZoneIdMarker,\n\t\t\t\tTrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker represent the first traffic policy\n\t\t\tinstance that Amazon Route 53 will return if you submit another request.

", + "smithy.api#httpQuery": "maxitems" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the information about the request to list your traffic\n\t\t\tpolicy instances.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyResponse": { + "type": "structure", + "members": { + "TrafficPolicyInstances": { + "target": "com.amazonaws.route53#TrafficPolicyInstances", + "traits": { + "smithy.api#documentation": "

A list that contains one TrafficPolicyInstance element for each traffic\n\t\t\tpolicy instance that matches the elements in the request.

", + "smithy.api#required": {} + } + }, + "HostedZoneIdMarker": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, HostedZoneIdMarker is\n\t\t\tthe ID of the hosted zone of the first traffic policy instance in the next group of\n\t\t\ttraffic policy instances.

" + } + }, + "TrafficPolicyInstanceNameMarker": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceNameMarker is the name of the first traffic policy\n\t\t\tinstance in the next group of MaxItems traffic policy instances.

" + } + }, + "TrafficPolicyInstanceTypeMarker": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceTypeMarker is the DNS type of the resource record\n\t\t\tsets that are associated with the first traffic policy instance in the next group of\n\t\t\t\tMaxItems traffic policy instances.

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more traffic policy instances to be listed. If\n\t\t\tthe response was truncated, you can get the next group of traffic policy instances by\n\t\t\tcalling ListTrafficPolicyInstancesByPolicy again and specifying the values\n\t\t\tof the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker,\n\t\t\tand TrafficPolicyInstanceTypeMarker elements in the corresponding request\n\t\t\tparameters.

", + "smithy.api#required": {} + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The value that you specified for the MaxItems parameter in the call to\n\t\t\t\tListTrafficPolicyInstancesByPolicy that produced the current\n\t\t\tresponse.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response information for the request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstancesRequest": { + "type": "structure", + "members": { + "HostedZoneIdMarker": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstances request. For\n\t\t\tthe value of HostedZoneId, specify the value of\n\t\t\t\tHostedZoneIdMarker from the previous response, which is the hosted zone\n\t\t\tID of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", + "smithy.api#httpQuery": "hostedzoneid" + } + }, + "TrafficPolicyInstanceNameMarker": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstances request. For\n\t\t\tthe value of trafficpolicyinstancename, specify the value of\n\t\t\t\tTrafficPolicyInstanceNameMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", + "smithy.api#httpQuery": "trafficpolicyinstancename" + } + }, + "TrafficPolicyInstanceTypeMarker": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstances request. For\n\t\t\tthe value of trafficpolicyinstancetype, specify the value of\n\t\t\t\tTrafficPolicyInstanceTypeMarker from the previous response, which is\n\t\t\tthe type of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", + "smithy.api#httpQuery": "trafficpolicyinstancetype" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of traffic policy instances that you want Amazon Route 53 to return\n\t\t\tin response to a ListTrafficPolicyInstances request. If you have more than\n\t\t\t\tMaxItems traffic policy instances, the value of the\n\t\t\t\tIsTruncated element in the response is true, and the\n\t\t\tvalues of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker,\n\t\t\tand TrafficPolicyInstanceTypeMarker represent the first traffic policy\n\t\t\tinstance in the next group of MaxItems traffic policy instances.

", + "smithy.api#httpQuery": "maxitems" + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to get information about the traffic policy instances that you created by\n\t\t\tusing the current Amazon Web Services account.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstancesResponse": { + "type": "structure", + "members": { + "TrafficPolicyInstances": { + "target": "com.amazonaws.route53#TrafficPolicyInstances", + "traits": { + "smithy.api#documentation": "

A list that contains one TrafficPolicyInstance element for each traffic\n\t\t\tpolicy instance that matches the elements in the request.

", + "smithy.api#required": {} + } + }, + "HostedZoneIdMarker": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, HostedZoneIdMarker is\n\t\t\tthe ID of the hosted zone of the first traffic policy instance that Route 53 will return\n\t\t\tif you submit another ListTrafficPolicyInstances request.

" + } + }, + "TrafficPolicyInstanceNameMarker": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceNameMarker is the name of the first traffic policy\n\t\t\tinstance that Route 53 will return if you submit another\n\t\t\t\tListTrafficPolicyInstances request.

" + } + }, + "TrafficPolicyInstanceTypeMarker": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceTypeMarker is the DNS type of the resource record\n\t\t\tsets that are associated with the first traffic policy instance that Amazon Route 53\n\t\t\twill return if you submit another ListTrafficPolicyInstances request.\n\t\t

" + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more traffic policy instances to be listed. If\n\t\t\tthe response was truncated, you can get more traffic policy instances by calling\n\t\t\t\tListTrafficPolicyInstances again and specifying the values of the\n\t\t\t\tHostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker in the corresponding request\n\t\t\tparameters.

", + "smithy.api#required": {} + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The value that you specified for the MaxItems parameter in the call to\n\t\t\t\tListTrafficPolicyInstances that produced the current response.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response information for the request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListTrafficPolicyVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListTrafficPolicyVersionsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListTrafficPolicyVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicy" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about all of the versions for a specified traffic policy.

\n

Traffic policy versions are listed in numerical order by\n\t\t\tVersionNumber.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/trafficpolicies/{Id}/versions", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListTrafficPolicyVersionsRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

Specify the value of Id of the traffic policy for which you want to list\n\t\t\tall versions.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TrafficPolicyVersionMarker": { + "target": "com.amazonaws.route53#TrafficPolicyVersionMarker", + "traits": { + "smithy.api#documentation": "

For your first request to ListTrafficPolicyVersions, don't include the\n\t\t\t\tTrafficPolicyVersionMarker parameter.

\n

If you have more traffic policy versions than the value of MaxItems,\n\t\t\t\tListTrafficPolicyVersions returns only the first group of\n\t\t\t\tMaxItems versions. To get more traffic policy versions, submit another\n\t\t\t\tListTrafficPolicyVersions request. For the value of\n\t\t\t\tTrafficPolicyVersionMarker, specify the value of\n\t\t\t\tTrafficPolicyVersionMarker in the previous response.

", + "smithy.api#httpQuery": "trafficpolicyversion" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of traffic policy versions that you want Amazon Route 53 to include\n\t\t\tin the response body for this request. If the specified traffic policy has more than\n\t\t\t\tMaxItems versions, the value of IsTruncated in the\n\t\t\tresponse is true, and the value of the\n\t\t\t\tTrafficPolicyVersionMarker element is the ID of the first version that\n\t\t\tRoute 53 will return if you submit another request.

", + "smithy.api#httpQuery": "maxitems" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the information about the request to list your traffic\n\t\t\tpolicies.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListTrafficPolicyVersionsResponse": { + "type": "structure", + "members": { + "TrafficPolicies": { + "target": "com.amazonaws.route53#TrafficPolicies", + "traits": { + "smithy.api#documentation": "

A list that contains one TrafficPolicy element for each traffic policy\n\t\t\tversion that is associated with the specified traffic policy.

", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that indicates whether there are more traffic policies to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of traffic policies by submitting\n\t\t\tanother ListTrafficPolicyVersions request and specifying the value of\n\t\t\t\tNextMarker in the marker parameter.

", + "smithy.api#required": {} + } + }, + "TrafficPolicyVersionMarker": { + "target": "com.amazonaws.route53#TrafficPolicyVersionMarker", + "traits": { + "smithy.api#documentation": "

If IsTruncated is true, the value of\n\t\t\t\tTrafficPolicyVersionMarker identifies the first traffic policy that\n\t\t\tAmazon Route 53 will return if you submit another request. Call\n\t\t\t\tListTrafficPolicyVersions again and specify the value of\n\t\t\t\tTrafficPolicyVersionMarker in the\n\t\t\t\tTrafficPolicyVersionMarker request parameter.

\n

This element is present only if IsTruncated is true.

", + "smithy.api#required": {} + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the\n\t\t\t\tListTrafficPolicyVersions request that produced the current\n\t\t\tresponse.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response information for the request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListVPCAssociationAuthorizations": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListVPCAssociationAuthorizationsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListVPCAssociationAuthorizationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidPaginationToken" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a list of the VPCs that were created by other accounts and that can be associated\n\t\t\twith a specified hosted zone because you've submitted one or more\n\t\t\t\tCreateVPCAssociationAuthorization requests.

\n

The response includes a VPCs element with a VPC child\n\t\t\telement for each VPC that can be associated with the hosted zone.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/authorizevpcassociation", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListVPCAssociationAuthorizationsRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone for which you want a list of VPCs that can be associated\n\t\t\twith the hosted zone.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

\n Optional: If a response includes a NextToken\n\t\t\telement, there are more VPCs that can be associated with the specified hosted zone. To\n\t\t\tget the next page of results, submit another request, and include the value of\n\t\t\t\tNextToken from the response in the nexttoken parameter in\n\t\t\tanother ListVPCAssociationAuthorizations request.

", + "smithy.api#httpQuery": "nexttoken" + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

\n Optional: An integer that specifies the maximum number of VPCs\n\t\t\tthat you want Amazon Route 53 to return. If you don't specify a value for\n\t\t\t\tMaxResults, Route 53 returns up to 50 VPCs per page.

", + "smithy.api#httpQuery": "maxresults" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about that can be associated with your hosted\n\t\t\tzone.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListVPCAssociationAuthorizationsResponse": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that you can associate the listed VPCs with.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

When the response includes a NextToken element, there are more VPCs that\n\t\t\tcan be associated with the specified hosted zone. To get the next page of VPCs, submit\n\t\t\tanother ListVPCAssociationAuthorizations request, and include the value of\n\t\t\tthe NextToken element from the response in the nexttoken\n\t\t\trequest parameter.

" + } + }, + "VPCs": { + "target": "com.amazonaws.route53#VPCs", + "traits": { + "smithy.api#documentation": "

The list of VPCs that are authorized to be associated with the specified hosted\n\t\t\tzone.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response information for the request.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#LocalZoneGroup": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53#LocationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#LocationSummary" + } + }, + "com.amazonaws.route53#LocationSummary": { + "type": "structure", + "members": { + "LocationName": { + "target": "com.amazonaws.route53#CidrLocationNameDefaultAllowed", + "traits": { + "smithy.api#documentation": "

A string that specifies a location name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the CIDR location.

" + } + }, + "com.amazonaws.route53#Longitude": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 7 + }, + "smithy.api#pattern": "^[-+]?[0-9]{1,3}(\\.[0-9]{0,2})?$" + } + }, + "com.amazonaws.route53#MeasureLatency": { + "type": "boolean" + }, + "com.amazonaws.route53#Message": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.route53#MetricName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.route53#Nameserver": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.route53#Namespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.route53#NoSuchChange": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

A change with the specified change ID does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchCidrCollectionException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The CIDR collection you specified, doesn't exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchCidrLocationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The CIDR collection location doesn't match any locations in your account.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchCloudWatchLogsLogGroup": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

There is no CloudWatch Logs log group with the specified ARN.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchDelegationSet": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A reusable delegation set with the specified ID does not exist.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#NoSuchGeoLocation": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Amazon Route 53 doesn't support the specified geographic location. For a list of\n\t\t\tsupported geolocation codes, see the GeoLocation data\n\t\t\ttype.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchHealthCheck": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

No health check exists with the specified ID.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchHostedZone": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

No hosted zone exists with the ID that you specified.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchKeySigningKey": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified key-signing key (KSK) doesn't exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchQueryLoggingConfig": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

There is no DNS query logging configuration with the specified ID.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchTrafficPolicy": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

No traffic policy exists with the specified ID.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchTrafficPolicyInstance": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

No traffic policy instance exists with the specified ID.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#Nonce": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.route53#NotAuthorizedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Associating the specified VPC with the specified hosted zone has not been\n\t\t\tauthorized.

", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + }, + "com.amazonaws.route53#PageMarker": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + } + } + }, + "com.amazonaws.route53#PageTruncated": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.route53#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.route53#Period": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60 + } + } + }, + "com.amazonaws.route53#Port": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 65535 + } + } + }, + "com.amazonaws.route53#PriorRequestNotComplete": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

If Amazon Route 53 can't process a request before the next request arrives, it will\n\t\t\treject subsequent requests for the same hosted zone and return an HTTP 400\n\t\t\t\terror (Bad request). If Route 53 returns this error repeatedly\n\t\t\tfor the same request, we recommend that you wait, in intervals of increasing duration,\n\t\t\tbefore you try the request again.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#PublicZoneVPCAssociation": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

You're trying to associate a VPC with a public hosted zone. Amazon Route 53 doesn't\n\t\t\tsupport associating a VPC with a public hosted zone.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#QueryLoggingConfig": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#QueryLoggingConfigId", + "traits": { + "smithy.api#documentation": "

The ID for a configuration for DNS query logging.

", + "smithy.api#required": {} + } + }, + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that CloudWatch Logs is logging queries for.

", + "smithy.api#required": {} + } + }, + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.route53#CloudWatchLogsLogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53\n\t\t\tis publishing logs to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about a configuration for DNS query\n\t\t\tlogging.

" + } + }, + "com.amazonaws.route53#QueryLoggingConfigAlreadyExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You can create only one query logging configuration for a hosted zone, and a query\n\t\t\tlogging configuration already exists for this hosted zone.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.route53#QueryLoggingConfigId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + } + } + }, + "com.amazonaws.route53#QueryLoggingConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#QueryLoggingConfig", + "traits": { + "smithy.api#xmlName": "QueryLoggingConfig" + } + } + }, + "com.amazonaws.route53#RData": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4000 + } + } + }, + "com.amazonaws.route53#RRType": { + "type": "enum", + "members": { + "SOA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOA" + } + }, + "A": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A" + } + }, + "TXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TXT" + } + }, + "NS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NS" + } + }, + "CNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CNAME" + } + }, + "MX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MX" + } + }, + "NAPTR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAPTR" + } + }, + "PTR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PTR" + } + }, + "SRV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SRV" + } + }, + "SPF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPF" + } + }, + "AAAA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AAAA" + } + }, + "CAA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CAA" + } + }, + "DS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DS" + } + } + } + }, + "com.amazonaws.route53#RecordData": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#RecordDataEntry", + "traits": { + "smithy.api#xmlName": "RecordDataEntry" + } + } + }, + "com.amazonaws.route53#RecordDataEntry": { + "type": "string", + "traits": { + "smithy.api#documentation": "

A value that Amazon Route 53 returned for this resource record set. A\n\t\t\t\tRecordDataEntry element is one of the following:

\n ", + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "com.amazonaws.route53#RequestInterval": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 10, + "max": 30 + } + } + }, + "com.amazonaws.route53#ResettableElementName": { + "type": "enum", + "members": { + "FullyQualifiedDomainName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FullyQualifiedDomainName" + } + }, + "Regions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Regions" + } + }, + "ResourcePath": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourcePath" + } + }, + "ChildHealthChecks": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ChildHealthChecks" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53#ResettableElementNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#ResettableElementName", + "traits": { + "smithy.api#xmlName": "ResettableElementName" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + } + } + }, + "com.amazonaws.route53#ResourceDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.route53#ResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + } + } + }, + "com.amazonaws.route53#ResourcePath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.route53#ResourceRecord": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.route53#RData", + "traits": { + "smithy.api#documentation": "

The current or new DNS record value, not to exceed 4,000 characters. In the case of a\n\t\t\t\tDELETE action, if the current value does not match the actual value, an\n\t\t\terror is returned. For descriptions about how to format Value for different\n\t\t\trecord types, see Supported DNS Resource\n\t\t\t\tRecord Types in the Amazon Route 53 Developer\n\t\t\tGuide.

\n

You can specify more than one value for all record types except CNAME and\n\t\t\t\tSOA.

\n \n

If you're creating an alias resource record set, omit Value.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information specific to the resource record.

\n \n

If you're creating an alias resource record set, omit\n\t\t\t\tResourceRecord.

\n " + } + }, + "com.amazonaws.route53#ResourceRecordSet": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

For ChangeResourceRecordSets requests, the name of the record that you\n\t\t\twant to create, update, or delete. For ListResourceRecordSets responses,\n\t\t\tthe name of a record in the specified hosted zone.

\n

\n ChangeResourceRecordSets Only\n

\n

Enter a fully qualified domain name, for example, www.example.com. You\n\t\t\tcan optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53\n\t\t\tassumes that the domain name that you specify is fully qualified. This means that Route\n\t\t\t53 treats www.example.com (without a trailing dot) and\n\t\t\t\twww.example.com. (with a trailing dot) as identical.

\n

For information about how to specify characters other than a-z,\n\t\t\t\t0-9, and - (hyphen) and how to specify internationalized\n\t\t\tdomain names, see DNS Domain Name\n\t\t\t\tFormat in the Amazon Route 53 Developer Guide.

\n

You can use the asterisk (*) wildcard to replace the leftmost label in a domain name,\n\t\t\tfor example, *.example.com. Note the following:

\n ", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

The DNS record type. For information about different record types and how data is\n\t\t\tencoded for them, see Supported DNS Resource\n\t\t\t\tRecord Types in the Amazon Route 53 Developer\n\t\t\tGuide.

\n

Valid values for basic resource record sets: A | AAAA |\n\t\t\t\tCAA | CNAME | DS |MX |\n\t\t\t\tNAPTR | NS | PTR | SOA |\n\t\t\t\tSPF | SRV | TXT\n

\n

Values for weighted, latency, geolocation, and failover resource record sets:\n\t\t\t\tA | AAAA | CAA | CNAME |\n\t\t\t\tMX | NAPTR | PTR | SPF |\n\t\t\t\tSRV | TXT. When creating a group of weighted, latency,\n\t\t\tgeolocation, or failover resource record sets, specify the same value for all of the\n\t\t\tresource record sets in the group.

\n

Valid values for multivalue answer resource record sets: A |\n\t\t\t\tAAAA | MX | NAPTR | PTR |\n\t\t\t\tSPF | SRV | TXT\n

\n \n

SPF records were formerly used to verify the identity of the sender of email\n\t\t\t\tmessages. However, we no longer recommend that you create resource record sets for\n\t\t\t\twhich the value of Type is SPF. RFC 7208, Sender\n\t\t\t\t\tPolicy Framework (SPF) for Authorizing Use of Domains in Email, Version\n\t\t\t\t\t1, has been updated to say, \"...[I]ts existence and mechanism defined\n\t\t\t\tin [RFC4408] have led to some interoperability issues. Accordingly, its use is no\n\t\t\t\tlonger appropriate for SPF version 1; implementations are not to use it.\" In RFC\n\t\t\t\t7208, see section 14.1, The SPF DNS Record Type.

\n \n

Values for alias resource record sets:

\n ", + "smithy.api#required": {} + } + }, + "SetIdentifier": { + "target": "com.amazonaws.route53#ResourceRecordSetIdentifier", + "traits": { + "smithy.api#documentation": "

\n Resource record sets that have a routing policy other than\n\t\t\t\tsimple: An identifier that differentiates among multiple resource record\n\t\t\tsets that have the same combination of name and type, such as multiple weighted resource\n\t\t\trecord sets named acme.example.com that have a type of A. In a group of resource record\n\t\t\tsets that have the same name and type, the value of SetIdentifier must be\n\t\t\tunique for each resource record set.

\n

For information about routing policies, see Choosing a Routing\n\t\t\t\tPolicy in the Amazon Route 53 Developer Guide.

" + } + }, + "Weight": { + "target": "com.amazonaws.route53#ResourceRecordSetWeight", + "traits": { + "smithy.api#documentation": "

\n Weighted resource record sets only: Among resource record sets\n\t\t\tthat have the same combination of DNS name and type, a value that determines the\n\t\t\tproportion of DNS queries that Amazon Route 53 responds to using the current resource\n\t\t\trecord set. Route 53 calculates the sum of the weights for the resource record sets that\n\t\t\thave the same combination of DNS name and type. Route 53 then responds to queries based\n\t\t\ton the ratio of a resource's weight to the total. Note the following:

\n " + } + }, + "Region": { + "target": "com.amazonaws.route53#ResourceRecordSetRegion", + "traits": { + "smithy.api#documentation": "

\n Latency-based resource record sets only: The Amazon EC2 Region\n\t\t\twhere you created the resource that this resource record set refers to. The resource\n\t\t\ttypically is an Amazon Web Services resource, such as an EC2 instance or an ELB load\n\t\t\tbalancer, and is referred to by an IP address or a DNS domain name, depending on the\n\t\t\trecord type.

\n

When Amazon Route 53 receives a DNS query for a domain name and type for which you\n\t\t\thave created latency resource record sets, Route 53 selects the latency resource record\n\t\t\tset that has the lowest latency between the end user and the associated Amazon EC2\n\t\t\tRegion. Route 53 then returns the value that is associated with the selected resource\n\t\t\trecord set.

\n

Note the following:

\n " + } + }, + "GeoLocation": { + "target": "com.amazonaws.route53#GeoLocation", + "traits": { + "smithy.api#documentation": "

\n Geolocation resource record sets only: A complex type that lets you\n\t\t\tcontrol how Amazon Route 53 responds to DNS queries based on the geographic origin of\n\t\t\tthe query. For example, if you want all queries from Africa to be routed to a web server\n\t\t\twith an IP address of 192.0.2.111, create a resource record set with a\n\t\t\t\tType of A and a ContinentCode of\n\t\t\t\tAF.

\n

If you create separate resource record sets for overlapping geographic regions (for\n\t\t\texample, one resource record set for a continent and one for a country on the same\n\t\t\tcontinent), priority goes to the smallest geographic region. This allows you to route\n\t\t\tmost queries for a continent to one resource and to route queries for a country on that\n\t\t\tcontinent to a different resource.

\n

You can't create two geolocation resource record sets that specify the same geographic\n\t\t\tlocation.

\n

The value * in the CountryCode element matches all\n\t\t\tgeographic locations that aren't specified in other geolocation resource record sets\n\t\t\tthat have the same values for the Name and Type\n\t\t\telements.

\n \n

Geolocation works by mapping IP addresses to locations. However, some IP addresses\n\t\t\t\taren't mapped to geographic locations, so even if you create geolocation resource\n\t\t\t\trecord sets that cover all seven continents, Route 53 will receive some DNS queries\n\t\t\t\tfrom locations that it can't identify. We recommend that you create a resource\n\t\t\t\trecord set for which the value of CountryCode is *. Two\n\t\t\t\tgroups of queries are routed to the resource that you specify in this record:\n\t\t\t\tqueries that come from locations for which you haven't created geolocation resource\n\t\t\t\trecord sets and queries from IP addresses that aren't mapped to a location. If you\n\t\t\t\tdon't create a * resource record set, Route 53 returns a \"no answer\"\n\t\t\t\tresponse for queries from those locations.

\n \n

You can't create non-geolocation resource record sets that have the same values for\n\t\t\tthe Name and Type elements as geolocation resource record\n\t\t\tsets.

" + } + }, + "Failover": { + "target": "com.amazonaws.route53#ResourceRecordSetFailover", + "traits": { + "smithy.api#documentation": "

\n Failover resource record sets only: To configure failover, you\n\t\t\tadd the Failover element to two resource record sets. For one resource\n\t\t\trecord set, you specify PRIMARY as the value for Failover; for\n\t\t\tthe other resource record set, you specify SECONDARY. In addition, you\n\t\t\tinclude the HealthCheckId element and specify the health check that you\n\t\t\twant Amazon Route 53 to perform for each resource record set.

\n

Except where noted, the following failover behaviors assume that you have included the\n\t\t\t\tHealthCheckId element in both resource record sets:

\n \n

You can't create non-failover resource record sets that have the same values for the\n\t\t\t\tName and Type elements as failover resource record\n\t\t\tsets.

\n

For failover alias resource record sets, you must also include the\n\t\t\t\tEvaluateTargetHealth element and set the value to true.

\n

For more information about configuring failover for Route 53, see the following topics\n\t\t\tin the Amazon Route 53 Developer Guide:

\n " + } + }, + "MultiValueAnswer": { + "target": "com.amazonaws.route53#ResourceRecordSetMultiValueAnswer", + "traits": { + "smithy.api#documentation": "

\n Multivalue answer resource record sets only: To route traffic\n\t\t\tapproximately randomly to multiple resources, such as web servers, create one multivalue\n\t\t\tanswer record for each resource and specify true for\n\t\t\t\tMultiValueAnswer. Note the following:

\n \n

You can't create multivalue answer alias records.

" + } + }, + "TTL": { + "target": "com.amazonaws.route53#TTL", + "traits": { + "smithy.api#documentation": "

The resource record cache time to live (TTL), in seconds. Note the following:

\n " + } + }, + "ResourceRecords": { + "target": "com.amazonaws.route53#ResourceRecords", + "traits": { + "smithy.api#documentation": "

Information about the resource records to act upon.

\n \n

If you're creating an alias resource record set, omit\n\t\t\t\tResourceRecords.

\n " + } + }, + "AliasTarget": { + "target": "com.amazonaws.route53#AliasTarget", + "traits": { + "smithy.api#documentation": "

\n Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that\n\t\t\tyou want to route traffic to.

\n

If you're creating resource records sets for a private hosted zone, note the\n\t\t\tfollowing:

\n " + } + }, + "HealthCheckId": { + "target": "com.amazonaws.route53#HealthCheckId", + "traits": { + "smithy.api#documentation": "

If you want Amazon Route 53 to return this resource record set in response to a DNS\n\t\t\tquery only when the status of a health check is healthy, include the\n\t\t\t\tHealthCheckId element and specify the ID of the applicable health\n\t\t\tcheck.

\n

Route 53 determines whether a resource record set is healthy based on one of the\n\t\t\tfollowing:

\n \n \n

Route 53 doesn't check the health of the endpoint that is specified in the\n\t\t\t\tresource record set, for example, the endpoint specified by the IP address in the\n\t\t\t\t\tValue element. When you add a HealthCheckId element to\n\t\t\t\ta resource record set, Route 53 checks the health of the endpoint that you specified\n\t\t\t\tin the health check.

\n \n

For more information, see the following topics in the Amazon Route 53\n\t\t\t\tDeveloper Guide:

\n \n

\n When to Specify HealthCheckId\n

\n

Specifying a value for HealthCheckId is useful only when Route 53 is\n\t\t\tchoosing between two or more resource record sets to respond to a DNS query, and you\n\t\t\twant Route 53 to base the choice in part on the status of a health check. Configuring\n\t\t\thealth checks makes sense only in the following configurations:

\n \n

\n Geolocation Routing\n

\n

For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for\n\t\t\ta resource record set for the larger, associated geographic region. For example, suppose\n\t\t\tyou have resource record sets for a state in the United States, for the entire United\n\t\t\tStates, for North America, and a resource record set that has * for\n\t\t\t\tCountryCode is *, which applies to all locations. If the\n\t\t\tendpoint for the state resource record set is unhealthy, Route 53 checks for healthy\n\t\t\tresource record sets in the following order until it finds a resource record set for\n\t\t\twhich the endpoint is healthy:

\n \n

\n Specifying the Health Check Endpoint by Domain\n\t\t\tName\n

\n

If your health checks specify the endpoint only by domain name, we recommend that you\n\t\t\tcreate a separate health check for each endpoint. For example, create a health check for\n\t\t\teach HTTP server that is serving content for www.example.com.\n\t\t\tFor the value of FullyQualifiedDomainName, specify the domain name of the\n\t\t\tserver (such as us-east-2-www.example.com), not the name of the resource\n\t\t\trecord sets (www.example.com).

\n \n

Health check results will be unpredictable if you do the following:

\n \n " + } + }, + "TrafficPolicyInstanceId": { + "target": "com.amazonaws.route53#TrafficPolicyInstanceId", + "traits": { + "smithy.api#documentation": "

When you create a traffic policy instance, Amazon Route 53 automatically creates a\n\t\t\tresource record set. TrafficPolicyInstanceId is the ID of the traffic\n\t\t\tpolicy instance that Route 53 created this resource record set for.

\n \n

To delete the resource record set that is associated with a traffic policy\n\t\t\t\tinstance, use DeleteTrafficPolicyInstance. Route 53 will delete the\n\t\t\t\tresource record set automatically. If you delete the resource record set by using\n\t\t\t\t\tChangeResourceRecordSets, Route 53 doesn't automatically delete the\n\t\t\t\ttraffic policy instance, and you'll continue to be charged for it even though it's\n\t\t\t\tno longer in use.

\n " + } + }, + "CidrRoutingConfig": { + "target": "com.amazonaws.route53#CidrRoutingConfig" + }, + "GeoProximityLocation": { + "target": "com.amazonaws.route53#GeoProximityLocation", + "traits": { + "smithy.api#documentation": "

\n GeoproximityLocation resource record sets only: A complex type that lets you control how\n\t\t\t\tRoute 53 responds to DNS queries based on the geographic origin of the\n\t\t\tquery and your resources.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the resource record set to create or delete.

" + } + }, + "com.amazonaws.route53#ResourceRecordSetFailover": { + "type": "enum", + "members": { + "PRIMARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIMARY" + } + }, + "SECONDARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECONDARY" + } + } + } + }, + "com.amazonaws.route53#ResourceRecordSetIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.route53#ResourceRecordSetMultiValueAnswer": { + "type": "boolean" + }, + "com.amazonaws.route53#ResourceRecordSetRegion": { + "type": "enum", + "members": { + "us_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-1" + } + }, + "us_east_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-2" + } + }, + "us_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-1" + } + }, + "us_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-2" + } + }, + "ca_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca-central-1" + } + }, + "eu_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-1" + } + }, + "eu_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-2" + } + }, + "eu_west_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-3" + } + }, + "eu_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-1" + } + }, + "eu_central_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-2" + } + }, + "ap_southeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-1" + } + }, + "ap_southeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-2" + } + }, + "ap_southeast_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-3" + } + }, + "ap_northeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-1" + } + }, + "ap_northeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-2" + } + }, + "ap_northeast_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-3" + } + }, + "eu_north_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-north-1" + } + }, + "sa_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sa-east-1" + } + }, + "cn_north_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cn-north-1" + } + }, + "cn_northwest_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cn-northwest-1" + } + }, + "ap_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-east-1" + } + }, + "me_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "me-south-1" + } + }, + "me_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "me-central-1" + } + }, + "ap_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-1" + } + }, + "ap_south_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-2" + } + }, + "af_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "af-south-1" + } + }, + "eu_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-south-1" + } + }, + "eu_south_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-south-2" + } + }, + "ap_southeast_4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-4" + } + }, + "il_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "il-central-1" + } + }, + "ca_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca-west-1" + } + }, + "ap_southeast_5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-5" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53#ResourceRecordSetWeight": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.route53#ResourceRecordSets": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#ResourceRecordSet", + "traits": { + "smithy.api#xmlName": "ResourceRecordSet" + } + } + }, + "com.amazonaws.route53#ResourceRecords": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#ResourceRecord", + "traits": { + "smithy.api#xmlName": "ResourceRecord" + } + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.route53#ResourceTagSet": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.route53#TagResourceType", + "traits": { + "smithy.api#documentation": "

The type of the resource.

\n " + } + }, + "ResourceId": { + "target": "com.amazonaws.route53#TagResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the specified resource.

" + } + }, + "Tags": { + "target": "com.amazonaws.route53#TagList", + "traits": { + "smithy.api#documentation": "

The tags associated with the specified resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type containing a resource and its associated tags.

" + } + }, + "com.amazonaws.route53#ResourceTagSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#ResourceTagSet", + "traits": { + "smithy.api#xmlName": "ResourceTagSet" + } + } + }, + "com.amazonaws.route53#ResourceURI": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.route53#ReusableDelegationSetLimit": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.route53#ReusableDelegationSetLimitType", + "traits": { + "smithy.api#documentation": "

The limit that you requested: MAX_ZONES_BY_REUSABLE_DELEGATION_SET, the\n\t\t\tmaximum number of hosted zones that you can associate with the specified reusable\n\t\t\tdelegation set.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.route53#LimitValue", + "traits": { + "smithy.api#documentation": "

The current value for the MAX_ZONES_BY_REUSABLE_DELEGATION_SET\n\t\t\tlimit.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the type of limit that you specified in the request and\n\t\t\tthe current value for that limit.

" + } + }, + "com.amazonaws.route53#ReusableDelegationSetLimitType": { + "type": "enum", + "members": { + "MAX_ZONES_BY_REUSABLE_DELEGATION_SET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_ZONES_BY_REUSABLE_DELEGATION_SET" + } + } + } + }, + "com.amazonaws.route53#RoutingControlArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.route53#SearchString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.route53#ServeSignature": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.route53#ServicePrincipal": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.route53#SigningKeyInteger": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.route53#SigningKeyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 128 + } + } + }, + "com.amazonaws.route53#SigningKeyStatus": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 150 + } + } + }, + "com.amazonaws.route53#SigningKeyStatusMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "com.amazonaws.route53#SigningKeyString": { + "type": "string" + }, + "com.amazonaws.route53#SigningKeyTag": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 65536 + } + } + }, + "com.amazonaws.route53#Statistic": { + "type": "enum", + "members": { + "Average": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Average" + } + }, + "Sum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Sum" + } + }, + "SampleCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SampleCount" + } + }, + "Maximum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Maximum" + } + }, + "Minimum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Minimum" + } + } + } + }, + "com.amazonaws.route53#Status": { + "type": "string" + }, + "com.amazonaws.route53#StatusReport": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.route53#Status", + "traits": { + "smithy.api#documentation": "

A description of the status of the health check endpoint as reported by one of the\n\t\t\tAmazon Route 53 health checkers.

" + } + }, + "CheckedTime": { + "target": "com.amazonaws.route53#TimeStamp", + "traits": { + "smithy.api#documentation": "

The date and time that the health checker performed the health check in ISO 8601 format and Coordinated\n\t\t\tUniversal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z\n\t\t\trepresents March 27, 2017 at 17:48:16.751 UTC.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the status that one Amazon Route 53 health checker\n\t\t\treports and the time of the health check.

" + } + }, + "com.amazonaws.route53#SubnetMask": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.route53#TTL": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 2147483647 + } + } + }, + "com.amazonaws.route53#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.route53#TagKey", + "traits": { + "smithy.api#documentation": "

The value of Key depends on the operation that you want to\n\t\t\tperform:

\n " + } + }, + "Value": { + "target": "com.amazonaws.route53#TagValue", + "traits": { + "smithy.api#documentation": "

The value of Value depends on the operation that you want to\n\t\t\tperform:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about a tag that you want to add or edit for\n\t\t\tthe specified health check or hosted zone.

" + } + }, + "com.amazonaws.route53#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.route53#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#TagKey", + "traits": { + "smithy.api#xmlName": "Key" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.route53#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#Tag", + "traits": { + "smithy.api#xmlName": "Tag" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.route53#TagResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + } + } + }, + "com.amazonaws.route53#TagResourceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#TagResourceId", + "traits": { + "smithy.api#xmlName": "ResourceId" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.route53#TagResourceType": { + "type": "enum", + "members": { + "healthcheck": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "healthcheck" + } + }, + "hostedzone": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hostedzone" + } + } + } + }, + "com.amazonaws.route53#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.route53#TestDNSAnswer": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#TestDNSAnswerRequest" + }, + "output": { + "target": "com.amazonaws.route53#TestDNSAnswerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the value that Amazon Route 53 returns in response to a DNS request for a\n\t\t\tspecified record name and type. You can optionally specify the IP address of a DNS\n\t\t\tresolver, an EDNS0 client subnet IP address, and a subnet mask.

\n

This call only supports querying public hosted zones.

\n \n

The TestDnsAnswer returns information similar to what you would expect from the answer\n\t\t\tsection of the dig command. Therefore, if you query for the name\n\t\t\tservers of a subdomain that point to the parent name servers, those will not be\n\t\t\treturned.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/testdnsanswer", + "code": 200 + } + } + }, + "com.amazonaws.route53#TestDNSAnswerRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that you want Amazon Route 53 to simulate a query\n\t\t\tfor.

", + "smithy.api#httpQuery": "hostedzoneid", + "smithy.api#required": {} + } + }, + "RecordName": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

The name of the resource record set that you want Amazon Route 53 to simulate a query\n\t\t\tfor.

", + "smithy.api#httpQuery": "recordname", + "smithy.api#required": {} + } + }, + "RecordType": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

The type of the resource record set.

", + "smithy.api#httpQuery": "recordtype", + "smithy.api#required": {} + } + }, + "ResolverIP": { + "target": "com.amazonaws.route53#IPAddress", + "traits": { + "smithy.api#documentation": "

If you want to simulate a request from a specific DNS resolver, specify the IP address\n\t\t\tfor that resolver. If you omit this value, TestDnsAnswer uses the IP\n\t\t\taddress of a DNS resolver in the Amazon Web Services US East (N. Virginia) Region\n\t\t\t\t(us-east-1).

", + "smithy.api#httpQuery": "resolverip" + } + }, + "EDNS0ClientSubnetIP": { + "target": "com.amazonaws.route53#IPAddress", + "traits": { + "smithy.api#documentation": "

If the resolver that you specified for resolverip supports EDNS0, specify the IPv4 or\n\t\t\tIPv6 address of a client in the applicable location, for example,\n\t\t\t\t192.0.2.44 or 2001:db8:85a3::8a2e:370:7334.

", + "smithy.api#httpQuery": "edns0clientsubnetip" + } + }, + "EDNS0ClientSubnetMask": { + "target": "com.amazonaws.route53#SubnetMask", + "traits": { + "smithy.api#documentation": "

If you specify an IP address for edns0clientsubnetip, you can optionally\n\t\t\tspecify the number of bits of the IP address that you want the checking tool to include\n\t\t\tin the DNS query. For example, if you specify 192.0.2.44 for\n\t\t\t\tedns0clientsubnetip and 24 for\n\t\t\t\tedns0clientsubnetmask, the checking tool will simulate a request from\n\t\t\t192.0.2.0/24. The default value is 24 bits for IPv4 addresses and 64 bits for IPv6\n\t\t\taddresses.

\n

The range of valid values depends on whether edns0clientsubnetip is an\n\t\t\tIPv4 or an IPv6 address:

\n ", + "smithy.api#httpQuery": "edns0clientsubnetmask" + } + } + }, + "traits": { + "smithy.api#documentation": "

Gets the value that Amazon Route 53 returns in response to a DNS request for a\n\t\t\tspecified record name and type. You can optionally specify the IP address of a DNS\n\t\t\tresolver, an EDNS0 client subnet IP address, and a subnet mask.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#TestDNSAnswerResponse": { + "type": "structure", + "members": { + "Nameserver": { + "target": "com.amazonaws.route53#Nameserver", + "traits": { + "smithy.api#documentation": "

The Amazon Route 53 name server used to respond to the request.

", + "smithy.api#required": {} + } + }, + "RecordName": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

The name of the resource record set that you submitted a request for.

", + "smithy.api#required": {} + } + }, + "RecordType": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

The type of the resource record set that you submitted a request for.

", + "smithy.api#required": {} + } + }, + "RecordData": { + "target": "com.amazonaws.route53#RecordData", + "traits": { + "smithy.api#documentation": "

A list that contains values that Amazon Route 53 returned for this resource record\n\t\t\tset.

", + "smithy.api#required": {} + } + }, + "ResponseCode": { + "target": "com.amazonaws.route53#DNSRCode", + "traits": { + "smithy.api#documentation": "

A code that indicates whether the request is valid or not. The most common response\n\t\t\tcode is NOERROR, meaning that the request is valid. If the response is not\n\t\t\tvalid, Amazon Route 53 returns a response code that describes the error. For a list of\n\t\t\tpossible response codes, see DNS RCODES on the IANA website.

", + "smithy.api#required": {} + } + }, + "Protocol": { + "target": "com.amazonaws.route53#TransportProtocol", + "traits": { + "smithy.api#documentation": "

The protocol that Amazon Route 53 used to respond to the request, either\n\t\t\t\tUDP or TCP.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response to a TestDNSAnswer request.\n\t\t

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#Threshold": { + "type": "double" + }, + "com.amazonaws.route53#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The limit on the number of requests per second was exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#TimeStamp": { + "type": "timestamp" + }, + "com.amazonaws.route53#TooManyHealthChecks": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

This health check can't be created because the current account has reached the limit\n\t\t\ton the number of active health checks.

\n

For information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n

For information about how to get the current limit for an account, see GetAccountLimit. To request a higher limit, create a case with the Amazon Web Services Support\n\t\t\tCenter.

\n

You have reached the maximum number of active health checks for an Amazon Web Services account. To request a higher limit, create a case with the Amazon Web Services Support\n\t\t\tCenter.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#TooManyHostedZones": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This operation can't be completed either because the current account has reached the\n\t\t\tlimit on the number of hosted zones or because you've reached the limit on the number of\n\t\t\thosted zones that can be associated with a reusable delegation set.

\n

For information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n

To get the current limit on hosted zones that can be created by an account, see GetAccountLimit.

\n

To get the current limit on hosted zones that can be associated with a reusable\n\t\t\tdelegation set, see GetReusableDelegationSetLimit.

\n

To request a higher limit, create a\n\t\t\t\tcase with the Amazon Web Services Support Center.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#TooManyKeySigningKeys": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You've reached the limit for the number of key-signing keys (KSKs). Remove at least\n\t\t\tone KSK, and then try again.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#TooManyTrafficPolicies": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This traffic policy can't be created because the current account has reached the limit\n\t\t\ton the number of traffic policies.

\n

For information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n

To get the current limit for an account, see GetAccountLimit.

\n

To request a higher limit, create a\n\t\t\t\tcase with the Amazon Web Services Support Center.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#TooManyTrafficPolicyInstances": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This traffic policy instance can't be created because the current account has reached\n\t\t\tthe limit on the number of traffic policy instances.

\n

For information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n

For information about how to get the current limit for an account, see GetAccountLimit.

\n

To request a higher limit, create a\n\t\t\t\tcase with the Amazon Web Services Support Center.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#TooManyTrafficPolicyVersionsForCurrentPolicy": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This traffic policy version can't be created because you've reached the limit of 1000\n\t\t\ton the number of versions that you can create for the current traffic policy.

\n

To create more traffic policy versions, you can use GetTrafficPolicy\n\t\t\tto get the traffic policy document for a specified traffic policy version, and then use\n\t\t\t\tCreateTrafficPolicy to create a new traffic policy using the traffic policy\n\t\t\tdocument.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#TooManyVPCAssociationAuthorizations": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

You've created the maximum number of authorizations that can be created for the\n\t\t\tspecified hosted zone. To authorize another VPC to be associated with the hosted zone,\n\t\t\tsubmit a DeleteVPCAssociationAuthorization request to remove an existing\n\t\t\tauthorization. To get a list of existing authorizations, submit a\n\t\t\t\tListVPCAssociationAuthorizations request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#TrafficPolicies": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#TrafficPolicy", + "traits": { + "smithy.api#xmlName": "TrafficPolicy" + } + } + }, + "com.amazonaws.route53#TrafficPolicy": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

The ID that Amazon Route 53 assigned to a traffic policy when you created it.

", + "smithy.api#required": {} + } + }, + "Version": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "

The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic\n\t\t\tpolicy, the value of Version is always 1.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#TrafficPolicyName", + "traits": { + "smithy.api#documentation": "

The name that you specified when you created the traffic policy.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

The DNS type of the resource record sets that Amazon Route 53 creates when you use a\n\t\t\ttraffic policy to create a traffic policy instance.

", + "smithy.api#required": {} + } + }, + "Document": { + "target": "com.amazonaws.route53#TrafficPolicyDocument", + "traits": { + "smithy.api#documentation": "

The definition of a traffic policy in JSON format. You specify the JSON document to\n\t\t\tuse for a new traffic policy in the CreateTrafficPolicy request. For more\n\t\t\tinformation about the JSON format, see Traffic Policy Document Format.

", + "smithy.api#required": {} + } + }, + "Comment": { + "target": "com.amazonaws.route53#TrafficPolicyComment", + "traits": { + "smithy.api#documentation": "

The comment that you specify in the CreateTrafficPolicy request, if\n\t\t\tany.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for a traffic policy.

" + } + }, + "com.amazonaws.route53#TrafficPolicyAlreadyExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A traffic policy that has the same value for Name already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.route53#TrafficPolicyComment": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.route53#TrafficPolicyDocument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 102400 + } + } + }, + "com.amazonaws.route53#TrafficPolicyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + } + } + }, + "com.amazonaws.route53#TrafficPolicyInUse": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

One or more traffic policy instances were created by using the specified traffic\n\t\t\tpolicy.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#TrafficPolicyInstance": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyInstanceId", + "traits": { + "smithy.api#documentation": "

The ID that Amazon Route 53 assigned to the new traffic policy instance.

", + "smithy.api#required": {} + } + }, + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the hosted zone that Amazon Route 53 created resource record sets in.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "

The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries\n\t\t\tby using the resource record sets that are associated with this traffic policy instance.\n\t\t

", + "smithy.api#required": {} + } + }, + "TTL": { + "target": "com.amazonaws.route53#TTL", + "traits": { + "smithy.api#documentation": "

The TTL that Amazon Route 53 assigned to all of the resource record sets that it\n\t\t\tcreated in the specified hosted zone.

", + "smithy.api#required": {} + } + }, + "State": { + "target": "com.amazonaws.route53#TrafficPolicyInstanceState", + "traits": { + "smithy.api#documentation": "

The value of State is one of the following values:

\n
\n
Applied
\n
\n

Amazon Route 53 has finished creating resource record sets, and changes\n\t\t\t\t\t\thave propagated to all Route 53 edge locations.

\n
\n
Creating
\n
\n

Route 53 is creating the resource record sets. Use\n\t\t\t\t\t\t\tGetTrafficPolicyInstance to confirm that the\n\t\t\t\t\t\t\tCreateTrafficPolicyInstance request completed\n\t\t\t\t\t\tsuccessfully.

\n
\n
Failed
\n
\n

Route 53 wasn't able to create or update the resource record sets. When\n\t\t\t\t\t\tthe value of State is Failed, see\n\t\t\t\t\t\t\tMessage for an explanation of what caused the request to\n\t\t\t\t\t\tfail.

\n
\n
", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.route53#Message", + "traits": { + "smithy.api#documentation": "

If State is Failed, an explanation of the reason for the\n\t\t\tfailure. If State is another value, Message is empty.

", + "smithy.api#required": {} + } + }, + "TrafficPolicyId": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

The ID of the traffic policy that Amazon Route 53 used to create resource record sets\n\t\t\tin the specified hosted zone.

", + "smithy.api#required": {} + } + }, + "TrafficPolicyVersion": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "

The version of the traffic policy that Amazon Route 53 used to create resource record\n\t\t\tsets in the specified hosted zone.

", + "smithy.api#required": {} + } + }, + "TrafficPolicyType": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

The DNS type that Amazon Route 53 assigned to all of the resource record sets that it\n\t\t\tcreated for this traffic policy instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for the new traffic policy instance.

" + } + }, + "com.amazonaws.route53#TrafficPolicyInstanceAlreadyExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

There is already a traffic policy instance with the specified ID.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.route53#TrafficPolicyInstanceCount": { + "type": "integer" + }, + "com.amazonaws.route53#TrafficPolicyInstanceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + } + } + }, + "com.amazonaws.route53#TrafficPolicyInstanceState": { + "type": "string" + }, + "com.amazonaws.route53#TrafficPolicyInstances": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#TrafficPolicyInstance", + "traits": { + "smithy.api#xmlName": "TrafficPolicyInstance" + } + } + }, + "com.amazonaws.route53#TrafficPolicyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "com.amazonaws.route53#TrafficPolicySummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#TrafficPolicySummary", + "traits": { + "smithy.api#xmlName": "TrafficPolicySummary" + } + } + }, + "com.amazonaws.route53#TrafficPolicySummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

The ID that Amazon Route 53 assigned to the traffic policy when you created it.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#TrafficPolicyName", + "traits": { + "smithy.api#documentation": "

The name that you specified for the traffic policy when you created it.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "

The DNS type of the resource record sets that Amazon Route 53 creates when you use a\n\t\t\ttraffic policy to create a traffic policy instance.

", + "smithy.api#required": {} + } + }, + "LatestVersion": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "

The version number of the latest version of the traffic policy.

", + "smithy.api#required": {} + } + }, + "TrafficPolicyCount": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "

The number of traffic policies that are associated with the current Amazon Web Services account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the latest version of one traffic\n\t\t\tpolicy that is associated with the current Amazon Web Services account.

" + } + }, + "com.amazonaws.route53#TrafficPolicyVersion": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.route53#TrafficPolicyVersionMarker": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4 + } + } + }, + "com.amazonaws.route53#TransportProtocol": { + "type": "string" + }, + "com.amazonaws.route53#UUID": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$" + } + }, + "com.amazonaws.route53#UpdateHealthCheck": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#UpdateHealthCheckRequest" + }, + "output": { + "target": "com.amazonaws.route53#UpdateHealthCheckResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#HealthCheckVersionMismatch" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing health check. Note that some values can't be updated.

\n

For more information about updating health checks, see Creating,\n\t\t\t\tUpdating, and Deleting Health Checks in the Amazon Route 53\n\t\t\t\tDeveloper Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/healthcheck/{HealthCheckId}", + "code": 200 + } + } + }, + "com.amazonaws.route53#UpdateHealthCheckRequest": { + "type": "structure", + "members": { + "HealthCheckId": { + "target": "com.amazonaws.route53#HealthCheckId", + "traits": { + "smithy.api#documentation": "

The ID for the health check for which you want detailed information. When you created\n\t\t\tthe health check, CreateHealthCheck returned the ID in the response, in the\n\t\t\t\tHealthCheckId element.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "HealthCheckVersion": { + "target": "com.amazonaws.route53#HealthCheckVersion", + "traits": { + "smithy.api#documentation": "

A sequential counter that Amazon Route 53 sets to 1 when you create a\n\t\t\thealth check and increments by 1 each time you update settings for the health\n\t\t\tcheck.

\n

We recommend that you use GetHealthCheck or ListHealthChecks\n\t\t\tto get the current value of HealthCheckVersion for the health check that\n\t\t\tyou want to update, and that you include that value in your\n\t\t\t\tUpdateHealthCheck request. This prevents Route 53 from overwriting an\n\t\t\tintervening update:

\n " + } + }, + "IPAddress": { + "target": "com.amazonaws.route53#IPAddress", + "traits": { + "smithy.api#documentation": "

The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform\n\t\t\thealth checks on. If you don't specify a value for IPAddress, Route 53\n\t\t\tsends a DNS request to resolve the domain name that you specify in\n\t\t\t\tFullyQualifiedDomainName at the interval that you specify in\n\t\t\t\tRequestInterval. Using an IP address that is returned by DNS, Route 53\n\t\t\tthen checks the health of the endpoint.

\n

Use one of the following formats for the value of IPAddress:

\n \n

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP\n\t\t\taddress, associate it with your EC2 instance, and specify the Elastic IP address for\n\t\t\t\tIPAddress. This ensures that the IP address of your instance never\n\t\t\tchanges. For more information, see the applicable documentation:

\n \n \n

If a health check already has a value for IPAddress, you can change\n\t\t\t\tthe value. However, you can't update an existing health check to add or remove the\n\t\t\t\tvalue of IPAddress.

\n \n

For more information, see FullyQualifiedDomainName.

\n

Constraints: Route 53 can't check the health of endpoints for which the IP address is\n\t\t\tin local, private, non-routable, or multicast ranges. For more information about IP\n\t\t\taddresses for which you can't create health checks, see the following documents:

\n " + } + }, + "Port": { + "target": "com.amazonaws.route53#Port", + "traits": { + "smithy.api#documentation": "

The port on the endpoint that you want Amazon Route 53 to perform health checks\n\t\t\ton.

\n \n

Don't specify a value for Port when you specify a value for\n\t\t\t\t\tType of CLOUDWATCH_METRIC or\n\t\t\t\tCALCULATED.

\n " + } + }, + "ResourcePath": { + "target": "com.amazonaws.route53#ResourcePath", + "traits": { + "smithy.api#documentation": "

The path that you want Amazon Route 53 to request when performing health checks. The\n\t\t\tpath can be any value for which your endpoint will return an HTTP status code of 2xx or\n\t\t\t3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.\n\t\t\tYou can also include query string parameters, for example,\n\t\t\t\t/welcome.html?language=jp&login=y.

\n

Specify this value only if you want to change it.

" + } + }, + "FullyQualifiedDomainName": { + "target": "com.amazonaws.route53#FullyQualifiedDomainName", + "traits": { + "smithy.api#documentation": "

Amazon Route 53 behavior depends on whether you specify a value for\n\t\t\t\tIPAddress.

\n \n

If a health check already has a value for IPAddress, you can change\n\t\t\t\tthe value. However, you can't update an existing health check to add or remove the\n\t\t\t\tvalue of IPAddress.

\n \n

\n If you specify a value for\n IPAddress:

\n

Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes\n\t\t\tthe value of FullyQualifiedDomainName in the Host header for\n\t\t\tall health checks except TCP health checks. This is typically the fully qualified DNS\n\t\t\tname of the endpoint on which you want Route 53 to perform health checks.

\n

When Route 53 checks the health of an endpoint, here is how it constructs the\n\t\t\t\tHost header:

\n \n

If you don't specify a value for FullyQualifiedDomainName, Route 53\n\t\t\tsubstitutes the value of IPAddress in the Host header in each\n\t\t\tof the above cases.

\n

\n If you don't specify a value for\n IPAddress:

\n

If you don't specify a value for IPAddress, Route 53 sends a DNS request\n\t\t\tto the domain that you specify in FullyQualifiedDomainName at the interval\n\t\t\tyou specify in RequestInterval. Using an IPv4 address that is returned by\n\t\t\tDNS, Route 53 then checks the health of the endpoint.

\n

If you don't specify a value for IPAddress, you can’t update the health check to remove the FullyQualifiedDomainName; if you don’t specify a value for IPAddress on creation, a \n\t\t\tFullyQualifiedDomainName is required.

\n \n

If you don't specify a value for IPAddress, Route 53 uses only IPv4\n\t\t\t\tto send health checks to the endpoint. If there's no resource record set with a type\n\t\t\t\tof A for the name that you specify for FullyQualifiedDomainName, the\n\t\t\t\thealth check fails with a \"DNS resolution failed\" error.

\n \n

If you want to check the health of weighted, latency, or failover resource record sets\n\t\t\tand you choose to specify the endpoint only by FullyQualifiedDomainName, we\n\t\t\trecommend that you create a separate health check for each endpoint. For example, create\n\t\t\ta health check for each HTTP server that is serving content for www.example.com. For the\n\t\t\tvalue of FullyQualifiedDomainName, specify the domain name of the server\n\t\t\t(such as us-east-2-www.example.com), not the name of the resource record\n\t\t\tsets (www.example.com).

\n \n

In this configuration, if the value of FullyQualifiedDomainName\n\t\t\t\tmatches the name of the resource record sets and you then associate the health check\n\t\t\t\twith those resource record sets, health check results will be unpredictable.

\n \n

In addition, if the value of Type is HTTP,\n\t\t\t\tHTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH,\n\t\t\tRoute 53 passes the value of FullyQualifiedDomainName in the\n\t\t\t\tHost header, as it does when you specify a value for\n\t\t\t\tIPAddress. If the value of Type is TCP, Route\n\t\t\t53 doesn't pass a Host header.

" + } + }, + "SearchString": { + "target": "com.amazonaws.route53#SearchString", + "traits": { + "smithy.api#documentation": "

If the value of Type is HTTP_STR_MATCH or\n\t\t\t\tHTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for\n\t\t\tin the response body from the specified resource. If the string appears in the response\n\t\t\tbody, Route 53 considers the resource healthy. (You can't change the value of\n\t\t\t\tType when you update a health check.)

" + } + }, + "FailureThreshold": { + "target": "com.amazonaws.route53#FailureThreshold", + "traits": { + "smithy.api#documentation": "

The number of consecutive health checks that an endpoint must pass or fail for Amazon\n\t\t\tRoute 53 to change the current status of the endpoint from unhealthy to healthy or vice\n\t\t\tversa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n

If you don't specify a value for FailureThreshold, the default value is\n\t\t\tthree health checks.

" + } + }, + "Inverted": { + "target": "com.amazonaws.route53#Inverted", + "traits": { + "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to invert the status of a health check, for\n\t\t\texample, to consider a health check unhealthy when it otherwise would be considered\n\t\t\thealthy.

" + } + }, + "Disabled": { + "target": "com.amazonaws.route53#Disabled", + "traits": { + "smithy.api#documentation": "

Stops Route 53 from performing health checks. When you disable a health check, here's\n\t\t\twhat happens:

\n \n

After you disable a health check, Route 53 considers the status of the health check to\n\t\t\talways be healthy. If you configured DNS failover, Route 53 continues to route traffic\n\t\t\tto the corresponding resources. If you want to stop routing traffic to a resource,\n\t\t\tchange the value of Inverted.

\n

Charges for a health check still apply when the health check is disabled. For more\n\t\t\tinformation, see Amazon Route 53\n\t\t\t\tPricing.

" + } + }, + "HealthThreshold": { + "target": "com.amazonaws.route53#HealthThreshold", + "traits": { + "smithy.api#documentation": "

The number of child health checks that are associated with a CALCULATED\n\t\t\thealth that Amazon Route 53 must consider healthy for the CALCULATED health\n\t\t\tcheck to be considered healthy. To specify the child health checks that you want to\n\t\t\tassociate with a CALCULATED health check, use the\n\t\t\t\tChildHealthChecks and ChildHealthCheck elements.

\n

Note the following:

\n " + } + }, + "ChildHealthChecks": { + "target": "com.amazonaws.route53#ChildHealthCheckList", + "traits": { + "smithy.api#documentation": "

A complex type that contains one ChildHealthCheck element for each health\n\t\t\tcheck that you want to associate with a CALCULATED health check.

" + } + }, + "EnableSNI": { + "target": "com.amazonaws.route53#EnableSNI", + "traits": { + "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to send the value of\n\t\t\t\tFullyQualifiedDomainName to the endpoint in the\n\t\t\t\tclient_hello message during TLS negotiation. This allows\n\t\t\tthe endpoint to respond to HTTPS health check requests with the applicable\n\t\t\tSSL/TLS certificate.

\n

Some endpoints require that HTTPS requests include the host name in the\n\t\t\t\tclient_hello message. If you don't enable SNI, the status of the health\n\t\t\tcheck will be SSL alert handshake_failure. A health check can also have\n\t\t\tthat status for other reasons. If SNI is enabled and you're still getting the error,\n\t\t\tcheck the SSL/TLS configuration on your endpoint and confirm that your certificate is\n\t\t\tvalid.

\n

The SSL/TLS certificate on your endpoint includes a domain name in the Common\n\t\t\t\tName field and possibly several more in the Subject Alternative\n\t\t\t\tNames field. One of the domain names in the certificate should match the\n\t\t\tvalue that you specify for FullyQualifiedDomainName. If the endpoint\n\t\t\tresponds to the client_hello message with a certificate that does not\n\t\t\tinclude the domain name that you specified in FullyQualifiedDomainName, a\n\t\t\thealth checker will retry the handshake. In the second attempt, the health checker will\n\t\t\tomit FullyQualifiedDomainName from the client_hello\n\t\t\tmessage.

" + } + }, + "Regions": { + "target": "com.amazonaws.route53#HealthCheckRegionList", + "traits": { + "smithy.api#documentation": "

A complex type that contains one Region element for each region that you\n\t\t\twant Amazon Route 53 health checkers to check the specified endpoint from.

" + } + }, + "AlarmIdentifier": { + "target": "com.amazonaws.route53#AlarmIdentifier", + "traits": { + "smithy.api#documentation": "

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53\n\t\t\thealth checkers to use to determine whether the specified health check is\n\t\t\thealthy.

" + } + }, + "InsufficientDataHealthStatus": { + "target": "com.amazonaws.route53#InsufficientDataHealthStatus", + "traits": { + "smithy.api#documentation": "

When CloudWatch has insufficient data about the metric to determine the alarm state,\n\t\t\tthe status that you want Amazon Route 53 to assign to the health check:

\n " + } + }, + "ResetElements": { + "target": "com.amazonaws.route53#ResettableElementNameList", + "traits": { + "smithy.api#documentation": "

A complex type that contains one ResettableElementName element for each\n\t\t\telement that you want to reset to the default value. Valid values for\n\t\t\t\tResettableElementName include the following:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about a request to update a health\n\t\t\tcheck.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#UpdateHealthCheckResponse": { + "type": "structure", + "members": { + "HealthCheck": { + "target": "com.amazonaws.route53#HealthCheck", + "traits": { + "smithy.api#documentation": "

A complex type that contains the response to an UpdateHealthCheck\n\t\t\trequest.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response to the UpdateHealthCheck\n\t\t\trequest.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#UpdateHostedZoneComment": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#UpdateHostedZoneCommentRequest" + }, + "output": { + "target": "com.amazonaws.route53#UpdateHostedZoneCommentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the comment for a specified hosted zone.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/hostedzone/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#UpdateHostedZoneCommentRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the hosted zone that you want to update the comment for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Comment": { + "target": "com.amazonaws.route53#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The new comment for the hosted zone. If you don't specify a value for\n\t\t\t\tComment, Amazon Route 53 deletes the existing value of the\n\t\t\t\tComment element, if any.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A request to update the comment for a hosted zone.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#UpdateHostedZoneCommentResponse": { + "type": "structure", + "members": { + "HostedZone": { + "target": "com.amazonaws.route53#HostedZone", + "traits": { + "smithy.api#documentation": "

A complex type that contains the response to the UpdateHostedZoneComment\n\t\t\trequest.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response to the UpdateHostedZoneComment\n\t\t\trequest.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#UpdateTrafficPolicyComment": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#UpdateTrafficPolicyCommentRequest" + }, + "output": { + "target": "com.amazonaws.route53#UpdateTrafficPolicyCommentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicy" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the comment for a specified traffic policy version.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/trafficpolicy/{Id}/{Version}", + "code": 200 + } + } + }, + "com.amazonaws.route53#UpdateTrafficPolicyCommentRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

The value of Id for the traffic policy that you want to update the\n\t\t\tcomment for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Version": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "

The value of Version for the traffic policy that you want to update the\n\t\t\tcomment for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Comment": { + "target": "com.amazonaws.route53#TrafficPolicyComment", + "traits": { + "smithy.api#documentation": "

The new comment for the specified traffic policy and version.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the traffic policy that you want to\n\t\t\tupdate the comment for.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#UpdateTrafficPolicyCommentResponse": { + "type": "structure", + "members": { + "TrafficPolicy": { + "target": "com.amazonaws.route53#TrafficPolicy", + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for the specified traffic policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains the response information for the traffic policy.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#UpdateTrafficPolicyInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#UpdateTrafficPolicyInstanceRequest" + }, + "output": { + "target": "com.amazonaws.route53#UpdateTrafficPolicyInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConflictingTypes" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicy" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" + } + ], + "traits": { + "smithy.api#documentation": "\n

After you submit a UpdateTrafficPolicyInstance request, there's a brief delay while Route 53 creates the resource record sets \n\t\t\tthat are specified in the traffic policy definition. Use GetTrafficPolicyInstance with the id of updated traffic policy instance confirm \n\t\t\tthat the \n\t\t\tUpdateTrafficPolicyInstance request completed successfully. For more information, see the State response element.

\n \n

Updates the resource record sets in a specified hosted zone that were created based on\n\t\t\tthe settings in a specified traffic policy version.

\n

When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS\n\t\t\tqueries for the root resource record set name (such as example.com) while it replaces\n\t\t\tone group of resource record sets with another. Route 53 performs the following\n\t\t\toperations:

\n
    \n
  1. \n

    Route 53 creates a new group of resource record sets based on the specified\n\t\t\t\t\ttraffic policy. This is true regardless of how significant the differences are\n\t\t\t\t\tbetween the existing resource record sets and the new resource record sets.\n\t\t\t\t

    \n
    2. \n
  2. \n

    When all of the new resource record sets have been created, Route 53 starts to\n\t\t\t\t\trespond to DNS queries for the root resource record set name (such as\n\t\t\t\t\texample.com) by using the new resource record sets.

    \n
    3. \n
  3. \n

    Route 53 deletes the old group of resource record sets that are associated\n\t\t\t\t\twith the root resource record set name.

    \n
    4. \n
", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/trafficpolicyinstance/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#UpdateTrafficPolicyInstanceRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyInstanceId", + "traits": { + "smithy.api#documentation": "

The ID of the traffic policy instance that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TTL": { + "target": "com.amazonaws.route53#TTL", + "traits": { + "smithy.api#documentation": "

The TTL that you want Amazon Route 53 to assign to all of the updated resource record\n\t\t\tsets.

", + "smithy.api#required": {} + } + }, + "TrafficPolicyId": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

The ID of the traffic policy that you want Amazon Route 53 to use to update resource\n\t\t\trecord sets for the specified traffic policy instance.

", + "smithy.api#required": {} + } + }, + "TrafficPolicyVersion": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "

The version of the traffic policy that you want Amazon Route 53 to use to update\n\t\t\tresource record sets for the specified traffic policy instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the resource record sets that you want\n\t\t\tto update based on a specified traffic policy instance.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#UpdateTrafficPolicyInstanceResponse": { + "type": "structure", + "members": { + "TrafficPolicyInstance": { + "target": "com.amazonaws.route53#TrafficPolicyInstance", + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for the updated traffic policy instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the resource record sets that Amazon\n\t\t\tRoute 53 created based on a specified traffic policy.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#UsageCount": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.route53#VPC": { + "type": "structure", + "members": { + "VPCRegion": { + "target": "com.amazonaws.route53#VPCRegion", + "traits": { + "smithy.api#documentation": "

(Private hosted zones only) The region that an Amazon VPC was created\n\t\t\tin.

" + } + }, + "VPCId": { + "target": "com.amazonaws.route53#VPCId" + } + }, + "traits": { + "smithy.api#documentation": "

(Private hosted zones only) A complex type that contains information about an Amazon VPC.

\n

If you associate a private hosted zone with an Amazon VPC when you make a\n\t\t\t\tCreateHostedZone\n\t\t\trequest, the following parameters are also required.

" + } + }, + "com.amazonaws.route53#VPCAssociationAuthorizationNotFound": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The VPC that you specified is not authorized to be associated with the hosted\n\t\t\tzone.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#VPCAssociationNotFound": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The specified VPC or hosted zone weren't found.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified VPC and hosted zone are not currently associated.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#VPCId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

(Private hosted zones only) The ID of an Amazon VPC.

", + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.route53#VPCRegion": { + "type": "enum", + "members": { + "us_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-1" + } + }, + "us_east_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-2" + } + }, + "us_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-1" + } + }, + "us_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-2" + } + }, + "eu_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-1" + } + }, + "eu_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-2" + } + }, + "eu_west_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-3" + } + }, + "eu_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-1" + } + }, + "eu_central_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-2" + } + }, + "ap_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-east-1" + } + }, + "me_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "me-south-1" + } + }, + "us_gov_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-gov-west-1" + } + }, + "us_gov_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-gov-east-1" + } + }, + "us_iso_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-iso-east-1" + } + }, + "us_iso_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-iso-west-1" + } + }, + "us_isob_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-isob-east-1" + } + }, + "me_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "me-central-1" + } + }, + "ap_southeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-1" + } + }, + "ap_southeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-2" + } + }, + "ap_southeast_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-3" + } + }, + "ap_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-1" + } + }, + "ap_south_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-2" + } + }, + "ap_northeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-1" + } + }, + "ap_northeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-2" + } + }, + "ap_northeast_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-3" + } + }, + "eu_north_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-north-1" + } + }, + "sa_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sa-east-1" + } + }, + "ca_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca-central-1" + } + }, + "cn_north_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cn-north-1" + } + }, + "af_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "af-south-1" + } + }, + "eu_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-south-1" + } + }, + "eu_south_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-south-2" + } + }, + "ap_southeast_4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-4" + } + }, + "il_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "il-central-1" + } + }, + "ca_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca-west-1" + } + }, + "ap_southeast_5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-5" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53#VPCs": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#xmlName": "VPC" + } + }, + "traits": { + "smithy.api#documentation": "

(Private hosted zones only) A list of VPC elements.

", + "smithy.api#length": { + "min": 1 + } } - } - ] - } - }, - "com.amazonaws.route53#GetHostedZoneCount": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetHostedZoneCountRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetHostedZoneCountResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves the number of hosted zones that are associated with the current Amazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/hostedzonecount", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetHostedZoneCountRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

A request to retrieve a count of all the hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetHostedZoneCountResponse": { - "type": "structure", - "members": { - "HostedZoneCount": { - "target": "com.amazonaws.route53#HostedZoneCount", - "traits": { - "smithy.api#documentation": "

The total number of public and private hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response to a GetHostedZoneCount\n\t\t\trequest.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetHostedZoneLimit": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetHostedZoneLimitRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetHostedZoneLimitResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#HostedZoneNotPrivate" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the specified limit for a specified hosted zone, for example, the maximum number\n\t\t\tof records that you can create in the hosted zone.

\n

For the default limit, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide. To request a higher limit,\n\t\t\t\topen a case.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/hostedzonelimit/{HostedZoneId}/{Type}", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetHostedZoneLimitRequest": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.route53#HostedZoneLimitType", - "traits": { - "smithy.api#documentation": "

The limit that you want to get. Valid values include the following:

\n ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that you want to get a limit for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the request to create a hosted\n\t\t\tzone.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetHostedZoneLimitResponse": { - "type": "structure", - "members": { - "Limit": { - "target": "com.amazonaws.route53#HostedZoneLimit", - "traits": { - "smithy.api#documentation": "

The current setting for the specified limit. For example, if you specified\n\t\t\t\tMAX_RRSETS_BY_ZONE for the value of Type in the request,\n\t\t\tthe value of Limit is the maximum number of records that you can create in\n\t\t\tthe specified hosted zone.

", - "smithy.api#required": {} - } - }, - "Count": { - "target": "com.amazonaws.route53#UsageCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The current number of entities that you have created of the specified type. For\n\t\t\texample, if you specified MAX_RRSETS_BY_ZONE for the value of\n\t\t\t\tType in the request, the value of Count is the current\n\t\t\tnumber of records that you have created in the specified hosted zone.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the requested limit.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetHostedZoneRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that you want to get information about.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A request to get information about a specified hosted zone.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetHostedZoneResponse": { - "type": "structure", - "members": { - "HostedZone": { - "target": "com.amazonaws.route53#HostedZone", - "traits": { - "smithy.api#documentation": "

A complex type that contains general information about the specified hosted\n\t\t\tzone.

", - "smithy.api#required": {} - } - }, - "DelegationSet": { - "target": "com.amazonaws.route53#DelegationSet", - "traits": { - "smithy.api#documentation": "

A complex type that lists the Amazon Route 53 name servers for the specified hosted\n\t\t\tzone.

" - } - }, - "VPCs": { - "target": "com.amazonaws.route53#VPCs", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the VPCs that are associated with the\n\t\t\tspecified hosted zone.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contain the response to a GetHostedZone\n\t\t\trequest.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetQueryLoggingConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetQueryLoggingConfigRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetQueryLoggingConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchQueryLoggingConfig" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about a specified configuration for DNS query logging.

\n

For more information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS\n\t\t\tQueries.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/queryloggingconfig/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetQueryLoggingConfigRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#QueryLoggingConfigId", - "traits": { - "smithy.api#documentation": "

The ID of the configuration for DNS query logging that you want to get information\n\t\t\tabout.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetQueryLoggingConfigResponse": { - "type": "structure", - "members": { - "QueryLoggingConfig": { - "target": "com.amazonaws.route53#QueryLoggingConfig", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the query logging configuration that\n\t\t\tyou specified in a GetQueryLoggingConfig request.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetReusableDelegationSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetReusableDelegationSetRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetReusableDelegationSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#DelegationSetNotReusable" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchDelegationSet" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves information about a specified reusable delegation set, including the four\n\t\t\tname servers that are assigned to the delegation set.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/delegationset/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetReusableDelegationSetLimit": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetReusableDelegationSetLimitRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetReusableDelegationSetLimitResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchDelegationSet" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the maximum number of hosted zones that you can associate with the specified\n\t\t\treusable delegation set.

\n

For the default limit, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide. To request a higher limit,\n\t\t\t\topen a case.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/reusabledelegationsetlimit/{DelegationSetId}/{Type}", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetReusableDelegationSetLimitRequest": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.route53#ReusableDelegationSetLimitType", - "traits": { - "smithy.api#documentation": "

Specify MAX_ZONES_BY_REUSABLE_DELEGATION_SET to get the maximum number of\n\t\t\thosted zones that you can associate with the specified reusable delegation set.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DelegationSetId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the delegation set that you want to get the limit for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the request to create a hosted\n\t\t\tzone.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetReusableDelegationSetLimitResponse": { - "type": "structure", - "members": { - "Limit": { - "target": "com.amazonaws.route53#ReusableDelegationSetLimit", - "traits": { - "smithy.api#documentation": "

The current setting for the limit on hosted zones that you can associate with the\n\t\t\tspecified reusable delegation set.

", - "smithy.api#required": {} - } - }, - "Count": { - "target": "com.amazonaws.route53#UsageCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The current number of hosted zones that you can associate with the specified reusable\n\t\t\tdelegation set.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the requested limit.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetReusableDelegationSetRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the reusable delegation set that you want to get a list of name servers\n\t\t\tfor.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A request to get information about a specified reusable delegation set.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetReusableDelegationSetResponse": { - "type": "structure", - "members": { - "DelegationSet": { - "target": "com.amazonaws.route53#DelegationSet", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the reusable delegation set.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response to the GetReusableDelegationSet\n\t\t\trequest.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetTrafficPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetTrafficPolicyRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetTrafficPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicy" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about a specific traffic policy version.

\n

For information about how of deleting a traffic policy affects the response from\n\t\t\t\tGetTrafficPolicy, see DeleteTrafficPolicy.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/trafficpolicy/{Id}/{Version}", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetTrafficPolicyInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetTrafficPolicyInstanceRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetTrafficPolicyInstanceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about a specified traffic policy instance.

\n \n

\n\t\t\t\tUse GetTrafficPolicyInstance with the id of new traffic policy instance to confirm that the \n\t\t\t\tCreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request completed successfully. \n\t\t\t\tFor more information, see the State response\n\t\t\t\telement.

\n \n \n

In the Route 53 console, traffic policy instances are known as policy\n\t\t\t\trecords.

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/trafficpolicyinstance/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetTrafficPolicyInstanceCount": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetTrafficPolicyInstanceCountRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetTrafficPolicyInstanceCountResponse" - }, - "traits": { - "smithy.api#documentation": "

Gets the number of traffic policy instances that are associated with the current\n\t\t\t\tAmazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/trafficpolicyinstancecount", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetTrafficPolicyInstanceCountRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

Request to get the number of traffic policy instances that are associated with the\n\t\t\tcurrent Amazon Web Services account.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetTrafficPolicyInstanceCountResponse": { - "type": "structure", - "members": { - "TrafficPolicyInstanceCount": { - "target": "com.amazonaws.route53#TrafficPolicyInstanceCount", - "traits": { - "smithy.api#documentation": "

The number of traffic policy instances that are associated with the current Amazon Web Services account.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the resource record sets that Amazon\n\t\t\tRoute 53 created based on a specified traffic policy.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetTrafficPolicyInstanceRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyInstanceId", - "traits": { - "smithy.api#documentation": "

The ID of the traffic policy instance that you want to get information about.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Gets information about a specified traffic policy instance.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetTrafficPolicyInstanceResponse": { - "type": "structure", - "members": { - "TrafficPolicyInstance": { - "target": "com.amazonaws.route53#TrafficPolicyInstance", - "traits": { - "smithy.api#documentation": "

A complex type that contains settings for the traffic policy instance.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the resource record sets that Amazon\n\t\t\tRoute 53 created based on a specified traffic policy.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetTrafficPolicyRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

The ID of the traffic policy that you want to get information about.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Version": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", - "traits": { - "smithy.api#documentation": "

The version number of the traffic policy that you want to get information\n\t\t\tabout.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Gets information about a specific traffic policy version.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetTrafficPolicyResponse": { - "type": "structure", - "members": { - "TrafficPolicy": { - "target": "com.amazonaws.route53#TrafficPolicy", - "traits": { - "smithy.api#documentation": "

A complex type that contains settings for the specified traffic policy.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response information for the request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#HealthCheck": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#HealthCheckId", - "traits": { - "smithy.api#documentation": "

The identifier that Amazon Route 53 assigned to the health check when you created it.\n\t\t\tWhen you add or update a resource record set, you use this value to specify which health\n\t\t\tcheck to use. The value can be up to 64 characters long.

", - "smithy.api#required": {} - } - }, - "CallerReference": { - "target": "com.amazonaws.route53#HealthCheckNonce", - "traits": { - "smithy.api#documentation": "

A unique string that you specified when you created the health check.

", - "smithy.api#required": {} - } - }, - "LinkedService": { - "target": "com.amazonaws.route53#LinkedService", - "traits": { - "smithy.api#documentation": "

If the health check was created by another service, the service that created the\n\t\t\thealth check. When a health check is created by another service, you can't edit or\n\t\t\tdelete it using Amazon Route 53.

" - } - }, - "HealthCheckConfig": { - "target": "com.amazonaws.route53#HealthCheckConfig", - "traits": { - "smithy.api#documentation": "

A complex type that contains detailed information about one health check.

", - "smithy.api#required": {} - } - }, - "HealthCheckVersion": { - "target": "com.amazonaws.route53#HealthCheckVersion", - "traits": { - "smithy.api#documentation": "

The version of the health check. You can optionally pass this value in a call to\n\t\t\t\tUpdateHealthCheck to prevent overwriting another change to the health\n\t\t\tcheck.

", - "smithy.api#required": {} - } - }, - "CloudWatchAlarmConfiguration": { - "target": "com.amazonaws.route53#CloudWatchAlarmConfiguration", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the CloudWatch alarm that Amazon Route\n\t\t\t53 is monitoring for this health check.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about one health check that is associated\n\t\t\twith the current Amazon Web Services account.

" - } - }, - "com.amazonaws.route53#HealthCheckAlreadyExists": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The health check you're attempting to create already exists. Amazon Route 53 returns\n\t\t\tthis error when you submit a request that has the following values:

\n ", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.route53#HealthCheckConfig": { - "type": "structure", - "members": { - "IPAddress": { - "target": "com.amazonaws.route53#IPAddress", - "traits": { - "smithy.api#documentation": "

The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform\n\t\t\thealth checks on. If you don't specify a value for IPAddress, Route 53\n\t\t\tsends a DNS request to resolve the domain name that you specify in\n\t\t\t\tFullyQualifiedDomainName at the interval that you specify in\n\t\t\t\tRequestInterval. Using an IP address returned by DNS, Route 53 then\n\t\t\tchecks the health of the endpoint.

\n

Use one of the following formats for the value of IPAddress:

\n \n

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP\n\t\t\taddress, associate it with your EC2 instance, and specify the Elastic IP address for\n\t\t\t\tIPAddress. This ensures that the IP address of your instance will never\n\t\t\tchange.

\n

For more information, see FullyQualifiedDomainName.

\n

Constraints: Route 53 can't check the health of endpoints for which the IP address is\n\t\t\tin local, private, non-routable, or multicast ranges. For more information about IP\n\t\t\taddresses for which you can't create health checks, see the following documents:

\n \n

When the value of Type is CALCULATED or\n\t\t\t\tCLOUDWATCH_METRIC, omit IPAddress.

" - } - }, - "Port": { - "target": "com.amazonaws.route53#Port", - "traits": { - "smithy.api#documentation": "

The port on the endpoint that you want Amazon Route 53 to perform health checks\n\t\t\ton.

\n \n

Don't specify a value for Port when you specify a value for\n\t\t\t\t\tType of CLOUDWATCH_METRIC or\n\t\t\t\tCALCULATED.

\n " - } - }, - "Type": { - "target": "com.amazonaws.route53#HealthCheckType", - "traits": { - "smithy.api#documentation": "

The type of health check that you want to create, which indicates how Amazon Route 53\n\t\t\tdetermines whether an endpoint is healthy.

\n \n

You can't change the value of Type after you create a health\n\t\t\t\tcheck.

\n \n

You can create the following types of health checks:

\n \n

For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the\n\t\t\t\tAmazon Route 53 Developer Guide.

", - "smithy.api#required": {} - } - }, - "ResourcePath": { - "target": "com.amazonaws.route53#ResourcePath", - "traits": { - "smithy.api#documentation": "

The path, if any, that you want Amazon Route 53 to request when performing health\n\t\t\tchecks. The path can be any value for which your endpoint will return an HTTP status\n\t\t\tcode of 2xx or 3xx when the endpoint is healthy, for example, the file\n\t\t\t/docs/route53-health-check.html. You can also include query string parameters, for\n\t\t\texample, /welcome.html?language=jp&login=y.

" - } - }, - "FullyQualifiedDomainName": { - "target": "com.amazonaws.route53#FullyQualifiedDomainName", - "traits": { - "smithy.api#documentation": "

Amazon Route 53 behavior depends on whether you specify a value for\n\t\t\t\tIPAddress.

\n

\n If you specify a value for\n IPAddress:

\n

Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and\n\t\t\tpasses the value of FullyQualifiedDomainName in the Host\n\t\t\theader for all health checks except TCP health checks. This is typically the fully\n\t\t\tqualified DNS name of the endpoint on which you want Route 53 to perform health\n\t\t\tchecks.

\n

When Route 53 checks the health of an endpoint, here is how it constructs the\n\t\t\t\tHost header:

\n \n

If you don't specify a value for FullyQualifiedDomainName, Route 53\n\t\t\tsubstitutes the value of IPAddress in the Host header in each\n\t\t\tof the preceding cases.

\n

\n If you don't specify a value for\n IPAddress:

\n

Route 53 sends a DNS request to the domain that you specify for\n\t\t\t\tFullyQualifiedDomainName at the interval that you specify for\n\t\t\t\tRequestInterval. Using an IPv4 address that DNS returns, Route 53 then\n\t\t\tchecks the health of the endpoint.

\n \n

If you don't specify a value for IPAddress, Route 53 uses only IPv4\n\t\t\t\tto send health checks to the endpoint. If there's no resource record set with a type\n\t\t\t\tof A for the name that you specify for FullyQualifiedDomainName, the\n\t\t\t\thealth check fails with a \"DNS resolution failed\" error.

\n \n

If you want to check the health of weighted, latency, or failover resource record sets\n\t\t\tand you choose to specify the endpoint only by FullyQualifiedDomainName, we\n\t\t\trecommend that you create a separate health check for each endpoint. For example, create\n\t\t\ta health check for each HTTP server that is serving content for www.example.com. For the\n\t\t\tvalue of FullyQualifiedDomainName, specify the domain name of the server\n\t\t\t(such as us-east-2-www.example.com), not the name of the resource record sets\n\t\t\t(www.example.com).

\n \n

In this configuration, if you create a health check for which the value of\n\t\t\t\t\tFullyQualifiedDomainName matches the name of the resource record\n\t\t\t\tsets and you then associate the health check with those resource record sets, health\n\t\t\t\tcheck results will be unpredictable.

\n \n

In addition, if the value that you specify for Type is HTTP,\n\t\t\t\tHTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH,\n\t\t\tRoute 53 passes the value of FullyQualifiedDomainName in the\n\t\t\t\tHost header, as it does when you specify a value for\n\t\t\t\tIPAddress. If the value of Type is TCP, Route\n\t\t\t53 doesn't pass a Host header.

" - } - }, - "SearchString": { - "target": "com.amazonaws.route53#SearchString", - "traits": { - "smithy.api#documentation": "

If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH,\n\t\t\tthe string that you want Amazon Route 53 to search for in the response body from the\n\t\t\tspecified resource. If the string appears in the response body, Route 53 considers the\n\t\t\tresource healthy.

\n

Route 53 considers case when searching for SearchString in the response\n\t\t\tbody.

" - } - }, - "RequestInterval": { - "target": "com.amazonaws.route53#RequestInterval", - "traits": { - "smithy.api#documentation": "

The number of seconds between the time that Amazon Route 53 gets a response from your\n\t\t\tendpoint and the time that it sends the next health check request. Each Route 53 health\n\t\t\tchecker makes requests at this interval.

\n \n

You can't change the value of RequestInterval after you create a\n\t\t\t\thealth check.

\n \n

If you don't specify a value for RequestInterval, the default value is\n\t\t\t\t30 seconds.

" - } - }, - "FailureThreshold": { - "target": "com.amazonaws.route53#FailureThreshold", - "traits": { - "smithy.api#documentation": "

The number of consecutive health checks that an endpoint must pass or fail for Amazon\n\t\t\tRoute 53 to change the current status of the endpoint from unhealthy to healthy or vice\n\t\t\tversa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n

If you don't specify a value for FailureThreshold, the default value is\n\t\t\tthree health checks.

" - } - }, - "MeasureLatency": { - "target": "com.amazonaws.route53#MeasureLatency", - "traits": { - "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to measure the latency between health\n\t\t\tcheckers in multiple Amazon Web Services regions and your endpoint, and to display\n\t\t\tCloudWatch latency graphs on the Health Checks page in\n\t\t\tthe Route 53 console.

\n \n

You can't change the value of MeasureLatency after you create a\n\t\t\t\thealth check.

\n " - } - }, - "Inverted": { - "target": "com.amazonaws.route53#Inverted", - "traits": { - "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to invert the status of a health check, for\n\t\t\texample, to consider a health check unhealthy when it otherwise would be considered\n\t\t\thealthy.

" - } - }, - "Disabled": { - "target": "com.amazonaws.route53#Disabled", - "traits": { - "smithy.api#documentation": "

Stops Route 53 from performing health checks. When you disable a health check, here's\n\t\t\twhat happens:

\n \n

After you disable a health check, Route 53 considers the status of the health check to\n\t\t\talways be healthy. If you configured DNS failover, Route 53 continues to route traffic\n\t\t\tto the corresponding resources. If you want to stop routing traffic to a resource,\n\t\t\tchange the value of Inverted.

\n

Charges for a health check still apply when the health check is disabled. For more\n\t\t\tinformation, see Amazon Route 53\n\t\t\t\tPricing.

" - } - }, - "HealthThreshold": { - "target": "com.amazonaws.route53#HealthThreshold", - "traits": { - "smithy.api#documentation": "

The number of child health checks that are associated with a CALCULATED\n\t\t\thealth check that Amazon Route 53 must consider healthy for the CALCULATED\n\t\t\thealth check to be considered healthy. To specify the child health checks that you want\n\t\t\tto associate with a CALCULATED health check, use the ChildHealthChecks element.

\n

Note the following:

\n " - } - }, - "ChildHealthChecks": { - "target": "com.amazonaws.route53#ChildHealthCheckList", - "traits": { - "smithy.api#documentation": "

(CALCULATED Health Checks Only) A complex type that contains one\n\t\t\t\tChildHealthCheck element for each health check that you want to\n\t\t\tassociate with a CALCULATED health check.

" - } - }, - "EnableSNI": { - "target": "com.amazonaws.route53#EnableSNI", - "traits": { - "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to send the value of\n\t\t\t\tFullyQualifiedDomainName to the endpoint in the\n\t\t\t\tclient_hello message during TLS negotiation. This allows the endpoint\n\t\t\tto respond to HTTPS health check requests with the applicable SSL/TLS\n\t\t\tcertificate.

\n

Some endpoints require that HTTPS requests include the host name in the\n\t\t\t\tclient_hello message. If you don't enable SNI, the status of the health\n\t\t\tcheck will be SSL alert handshake_failure. A health check can also have\n\t\t\tthat status for other reasons. If SNI is enabled and you're still getting the error,\n\t\t\tcheck the SSL/TLS configuration on your endpoint and confirm that your certificate is\n\t\t\tvalid.

\n

The SSL/TLS certificate on your endpoint includes a domain name in the Common\n\t\t\t\tName field and possibly several more in the Subject Alternative\n\t\t\t\tNames field. One of the domain names in the certificate should match the\n\t\t\tvalue that you specify for FullyQualifiedDomainName. If the endpoint\n\t\t\tresponds to the client_hello message with a certificate that does not\n\t\t\tinclude the domain name that you specified in FullyQualifiedDomainName, a\n\t\t\thealth checker will retry the handshake. In the second attempt, the health checker will\n\t\t\tomit FullyQualifiedDomainName from the client_hello\n\t\t\tmessage.

" - } - }, - "Regions": { - "target": "com.amazonaws.route53#HealthCheckRegionList", - "traits": { - "smithy.api#documentation": "

A complex type that contains one Region element for each region from\n\t\t\twhich you want Amazon Route 53 health checkers to check the specified endpoint.

\n

If you don't specify any regions, Route 53 health checkers automatically performs\n\t\t\tchecks from all of the regions that are listed under Valid\n\t\t\t\tValues.

\n

If you update a health check to remove a region that has been performing health\n\t\t\tchecks, Route 53 will briefly continue to perform checks from that region to ensure that\n\t\t\tsome health checkers are always checking the endpoint (for example, if you replace three\n\t\t\tregions with four different regions).

" - } - }, - "AlarmIdentifier": { - "target": "com.amazonaws.route53#AlarmIdentifier", - "traits": { - "smithy.api#documentation": "

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53\n\t\t\thealth checkers to use to determine whether the specified health check is\n\t\t\thealthy.

" - } - }, - "InsufficientDataHealthStatus": { - "target": "com.amazonaws.route53#InsufficientDataHealthStatus", - "traits": { - "smithy.api#documentation": "

When CloudWatch has insufficient data about the metric to determine the alarm state,\n\t\t\tthe status that you want Amazon Route 53 to assign to the health check:

\n " - } - }, - "RoutingControlArn": { - "target": "com.amazonaws.route53#RoutingControlArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller\n\t\t\trouting control.

\n

For more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide..

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the health check.

" - } - }, - "com.amazonaws.route53#HealthCheckCount": { - "type": "long" - }, - "com.amazonaws.route53#HealthCheckId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - } - } - }, - "com.amazonaws.route53#HealthCheckInUse": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

This error code is not in use.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#HealthCheckNonce": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#HealthCheckObservation": { - "type": "structure", - "members": { - "Region": { - "target": "com.amazonaws.route53#HealthCheckRegion", - "traits": { - "smithy.api#documentation": "

The region of the Amazon Route 53 health checker that provided the status in\n\t\t\t\tStatusReport.

" - } - }, - "IPAddress": { - "target": "com.amazonaws.route53#IPAddress", - "traits": { - "smithy.api#documentation": "

The IP address of the Amazon Route 53 health checker that provided the failure reason\n\t\t\tin StatusReport.

" - } - }, - "StatusReport": { - "target": "com.amazonaws.route53#StatusReport", - "traits": { - "smithy.api#documentation": "

A complex type that contains the last failure reason as reported by one Amazon Route\n\t\t\t53 health checker and the time of the failed health check.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the last failure reason as reported by one Amazon Route\n\t\t\t53 health checker.

" - } - }, - "com.amazonaws.route53#HealthCheckObservations": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#HealthCheckObservation", - "traits": { - "smithy.api#xmlName": "HealthCheckObservation" - } - } - }, - "com.amazonaws.route53#HealthCheckRegion": { - "type": "enum", - "members": { - "us_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-1" - } - }, - "us_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-1" - } - }, - "us_west_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-2" - } - }, - "eu_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-1" - } - }, - "ap_southeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-1" - } - }, - "ap_southeast_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-2" - } - }, - "ap_northeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-1" - } - }, - "sa_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sa-east-1" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#HealthCheckRegionList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#HealthCheckRegion", - "traits": { - "smithy.api#xmlName": "Region" - } - }, - "traits": { - "smithy.api#length": { - "min": 3, - "max": 64 - } - } - }, - "com.amazonaws.route53#HealthCheckType": { - "type": "enum", - "members": { - "HTTP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTP" - } - }, - "HTTPS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPS" - } - }, - "HTTP_STR_MATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTP_STR_MATCH" - } - }, - "HTTPS_STR_MATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPS_STR_MATCH" - } - }, - "TCP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TCP" - } - }, - "CALCULATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CALCULATED" - } - }, - "CLOUDWATCH_METRIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLOUDWATCH_METRIC" - } - }, - "RECOVERY_CONTROL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RECOVERY_CONTROL" - } - } - } - }, - "com.amazonaws.route53#HealthCheckVersion": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.route53#HealthCheckVersionMismatch": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The value of HealthCheckVersion in the request doesn't match the value of\n\t\t\t\tHealthCheckVersion in the health check.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.route53#HealthChecks": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#HealthCheck", - "traits": { - "smithy.api#xmlName": "HealthCheck" - } - } - }, - "com.amazonaws.route53#HealthThreshold": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.route53#HostedZone": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID that Amazon Route 53 assigned to the hosted zone when you created it.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

The name of the domain. For public hosted zones, this is the name that you have\n\t\t\tregistered with your DNS registrar.

\n

For information about how to specify characters other than a-z,\n\t\t\t\t0-9, and - (hyphen) and how to specify internationalized\n\t\t\tdomain names, see CreateHostedZone.

", - "smithy.api#required": {} - } - }, - "CallerReference": { - "target": "com.amazonaws.route53#Nonce", - "traits": { - "smithy.api#documentation": "

The value that you specified for CallerReference when you created the\n\t\t\thosted zone.

", - "smithy.api#required": {} - } - }, - "Config": { - "target": "com.amazonaws.route53#HostedZoneConfig", - "traits": { - "smithy.api#documentation": "

A complex type that includes the Comment and PrivateZone\n\t\t\telements. If you omitted the HostedZoneConfig and Comment\n\t\t\telements from the request, the Config and Comment elements\n\t\t\tdon't appear in the response.

" - } - }, - "ResourceRecordSetCount": { - "target": "com.amazonaws.route53#HostedZoneRRSetCount", - "traits": { - "smithy.api#documentation": "

The number of resource record sets in the hosted zone.

" - } - }, - "LinkedService": { - "target": "com.amazonaws.route53#LinkedService", - "traits": { - "smithy.api#documentation": "

If the hosted zone was created by another service, the service that created the hosted\n\t\t\tzone. When a hosted zone is created by another service, you can't edit or delete it\n\t\t\tusing Route 53.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains general information about the hosted zone.

" - } - }, - "com.amazonaws.route53#HostedZoneAlreadyExists": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The hosted zone you're trying to create already exists. Amazon Route 53 returns this\n\t\t\terror when a hosted zone has already been created with the specified\n\t\t\t\tCallerReference.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.route53#HostedZoneConfig": { - "type": "structure", - "members": { - "Comment": { - "target": "com.amazonaws.route53#ResourceDescription", - "traits": { - "smithy.api#documentation": "

Any comments that you want to include about the hosted zone.

" - } - }, - "PrivateZone": { - "target": "com.amazonaws.route53#IsPrivateZone", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether this is a private hosted zone.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains an optional comment about your hosted zone. If you don't\n\t\t\twant to specify a comment, omit both the HostedZoneConfig and\n\t\t\t\tComment elements.

" - } - }, - "com.amazonaws.route53#HostedZoneCount": { - "type": "long" - }, - "com.amazonaws.route53#HostedZoneLimit": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.route53#HostedZoneLimitType", - "traits": { - "smithy.api#documentation": "

The limit that you requested. Valid values include the following:

\n ", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.route53#LimitValue", - "traits": { - "smithy.api#documentation": "

The current value for the limit that is specified by Type.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the type of limit that you specified in the request and\n\t\t\tthe current value for that limit.

" - } - }, - "com.amazonaws.route53#HostedZoneLimitType": { - "type": "enum", - "members": { - "MAX_RRSETS_BY_ZONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_RRSETS_BY_ZONE" - } - }, - "MAX_VPCS_ASSOCIATED_BY_ZONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_VPCS_ASSOCIATED_BY_ZONE" - } - } - } - }, - "com.amazonaws.route53#HostedZoneNotEmpty": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The hosted zone contains resource records that are not SOA or NS records.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#HostedZoneNotFound": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The specified HostedZone can't be found.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#HostedZoneNotPrivate": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The specified hosted zone is a public hosted zone, not a private hosted zone.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#HostedZoneOwner": { - "type": "structure", - "members": { - "OwningAccount": { - "target": "com.amazonaws.route53#AWSAccountID", - "traits": { - "smithy.api#documentation": "

If the hosted zone was created by an Amazon Web Services account, or was created by an\n\t\t\t\tAmazon Web Services service that creates hosted zones using the current account,\n\t\t\t\tOwningAccount contains the account ID of that account. For example,\n\t\t\twhen you use Cloud Map to create a hosted zone, Cloud Map creates the hosted\n\t\t\tzone using the current Amazon Web Services account.

" - } - }, - "OwningService": { - "target": "com.amazonaws.route53#HostedZoneOwningService", - "traits": { - "smithy.api#documentation": "

If an Amazon Web Services service uses its own account to create a hosted zone and\n\t\t\tassociate the specified VPC with that hosted zone, OwningService contains\n\t\t\tan abbreviation that identifies the service. For example, if Amazon Elastic File System\n\t\t\t(Amazon EFS) created a hosted zone and associated a VPC with the hosted zone, the value\n\t\t\tof OwningService is efs.amazonaws.com.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that identifies a hosted zone that a specified Amazon VPC is associated\n\t\t\twith and the owner of the hosted zone. If there is a value for\n\t\t\t\tOwningAccount, there is no value for OwningService, and\n\t\t\tvice versa.

" - } - }, - "com.amazonaws.route53#HostedZoneOwningService": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - } - } - }, - "com.amazonaws.route53#HostedZonePartiallyDelegated": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The hosted zone nameservers don't match the parent nameservers. The hosted zone and\n\t\t\tparent must have the same nameservers.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#HostedZoneRRSetCount": { - "type": "long" - }, - "com.amazonaws.route53#HostedZoneSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#HostedZoneSummary", - "traits": { - "smithy.api#xmlName": "HostedZoneSummary" - } - } - }, - "com.amazonaws.route53#HostedZoneSummary": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The Route 53 hosted zone ID of a private hosted zone that the specified VPC is\n\t\t\tassociated with.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

The name of the private hosted zone, such as example.com.

", - "smithy.api#required": {} - } - }, - "Owner": { - "target": "com.amazonaws.route53#HostedZoneOwner", - "traits": { - "smithy.api#documentation": "

The owner of a private hosted zone that the specified VPC is associated with. The\n\t\t\towner can be either an Amazon Web Services account or an Amazon Web Services\n\t\t\tservice.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

In the response to a ListHostedZonesByVPC request, the\n\t\t\t\tHostedZoneSummaries element contains one HostedZoneSummary\n\t\t\telement for each hosted zone that the specified Amazon VPC is associated with. Each\n\t\t\t\tHostedZoneSummary element contains the hosted zone name and ID, and\n\t\t\tinformation about who owns the hosted zone.

" - } - }, - "com.amazonaws.route53#HostedZoneType": { - "type": "enum", - "members": { - "PRIVATE_HOSTED_ZONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PrivateHostedZone" - } - } - } - }, - "com.amazonaws.route53#HostedZones": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#HostedZone", - "traits": { - "smithy.api#xmlName": "HostedZone" - } - } - }, - "com.amazonaws.route53#IPAddress": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 45 - }, - "smithy.api#pattern": "^(^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$)$" - } - }, - "com.amazonaws.route53#IPAddressCidr": { - "type": "string" - }, - "com.amazonaws.route53#IncompatibleVersion": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The resource you're trying to access is unsupported on this Amazon Route 53\n\t\t\tendpoint.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#InsufficientCloudWatchLogsResourcePolicy": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

Amazon Route 53 doesn't have the permissions required to create log streams and send\n\t\t\tquery logs to log streams. Possible causes include the following:

\n ", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#InsufficientDataHealthStatus": { - "type": "enum", - "members": { - "Healthy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Healthy" - } - }, - "Unhealthy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Unhealthy" - } - }, - "LastKnownStatus": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LastKnownStatus" - } - } - } - }, - "com.amazonaws.route53#InvalidArgument": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Parameter name is not valid.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#InvalidChangeBatch": { - "type": "structure", - "members": { - "messages": { - "target": "com.amazonaws.route53#ErrorMessages", - "traits": { - "smithy.api#documentation": "

" - } - }, - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

This exception contains a list of messages that might contain one or more error\n\t\t\tmessages. Each error message indicates one error in the change batch.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#InvalidDomainName": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The specified domain name is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#InvalidInput": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The input is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#InvalidKMSArn": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC\n\t\t\tsigning.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#InvalidKeySigningKeyName": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The key-signing key (KSK) name that you specified isn't a valid name.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#InvalidKeySigningKeyStatus": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The key-signing key (KSK) status isn't valid or another KSK has the status\n\t\t\t\tINTERNAL_FAILURE.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#InvalidPaginationToken": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The value that you specified to get the second or subsequent page of results is\n\t\t\tinvalid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#InvalidSigningStatus": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

Your hosted zone status isn't valid for this operation. In the hosted zone, change the\n\t\t\tstatus to enable DNSSEC or disable DNSSEC.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#InvalidTrafficPolicyDocument": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The format of the traffic policy document that you specified in the\n\t\t\t\tDocument element is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#InvalidVPCId": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The VPC ID that you specified either isn't a valid ID or the current account is not\n\t\t\tauthorized to access this VPC.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#Inverted": { - "type": "boolean" - }, - "com.amazonaws.route53#IsPrivateZone": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.route53#KeySigningKey": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.route53#SigningKeyName", - "traits": { - "smithy.api#documentation": "

A string used to identify a key-signing key (KSK). Name can include\n\t\t\tnumbers, letters, and underscores (_). Name must be unique for each\n\t\t\tkey-signing key in the same hosted zone.

" - } - }, - "KmsArn": { - "target": "com.amazonaws.route53#SigningKeyString", - "traits": { - "smithy.api#documentation": "

The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS). The KmsArn must be unique for each\n\t\t\tkey-signing key (KSK) in a single hosted zone.

\n

You must configure the customer managed key as follows:

\n
\n
Status
\n
\n

Enabled

\n
\n
Key spec
\n
\n

ECC_NIST_P256

\n
\n
Key usage
\n
\n

Sign and verify

\n
\n
Key policy
\n
\n

The key policy must give permission for the following actions:

\n
    \n
  • \n

    DescribeKey

    \n
    • \n
  • \n

    GetPublicKey

    \n
    • \n
  • \n

    Sign

    \n
    • \n
\n

The key policy must also include the Amazon Route 53 service in the\n\t\t\t\t\t\tprincipal for your account. Specify the following:

\n
    \n
  • \n

    \n \"Service\": \"dnssec-route53.amazonaws.com\"\n

    \n
    • \n
\n
\n
\n

For more information about working with the customer managed key in KMS, see Key Management Service\n\t\t\t\tconcepts.

" - } - }, - "Flag": { - "target": "com.amazonaws.route53#SigningKeyInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

An integer that specifies how the key is used. For key-signing key (KSK), this value\n\t\t\tis always 257.

" - } - }, - "SigningAlgorithmMnemonic": { - "target": "com.amazonaws.route53#SigningKeyString", - "traits": { - "smithy.api#documentation": "

A string used to represent the signing algorithm. This value must follow the\n\t\t\tguidelines provided by RFC-8624 Section 3.1.

" - } - }, - "SigningAlgorithmType": { - "target": "com.amazonaws.route53#SigningKeyInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

An integer used to represent the signing algorithm. This value must follow the\n\t\t\tguidelines provided by RFC-8624 Section 3.1.

" - } - }, - "DigestAlgorithmMnemonic": { - "target": "com.amazonaws.route53#SigningKeyString", - "traits": { - "smithy.api#documentation": "

A string used to represent the delegation signer digest algorithm. This value must\n\t\t\tfollow the guidelines provided by RFC-8624 Section 3.3.\n\t\t

" - } - }, - "DigestAlgorithmType": { - "target": "com.amazonaws.route53#SigningKeyInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

An integer used to represent the delegation signer digest algorithm. This value must\n\t\t\tfollow the guidelines provided by RFC-8624 Section\n\t\t\t3.3.

" - } - }, - "KeyTag": { - "target": "com.amazonaws.route53#SigningKeyTag", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

An integer used to identify the DNSSEC record for the domain name. The process used to\n\t\t\tcalculate the value is described in RFC-4034 Appendix B.

" - } - }, - "DigestValue": { - "target": "com.amazonaws.route53#SigningKeyString", - "traits": { - "smithy.api#documentation": "

A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are used to\n\t\t\tpublish the public key that resolvers can use to verify DNSSEC signatures that are used\n\t\t\tto secure certain kinds of information provided by the DNS system.

" - } - }, - "PublicKey": { - "target": "com.amazonaws.route53#SigningKeyString", - "traits": { - "smithy.api#documentation": "

The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.

" - } - }, - "DSRecord": { - "target": "com.amazonaws.route53#SigningKeyString", - "traits": { - "smithy.api#documentation": "

A string that represents a delegation signer (DS) record.

" - } - }, - "DNSKEYRecord": { - "target": "com.amazonaws.route53#SigningKeyString", - "traits": { - "smithy.api#documentation": "

A string that represents a DNSKEY record.

" - } - }, - "Status": { - "target": "com.amazonaws.route53#SigningKeyStatus", - "traits": { - "smithy.api#documentation": "

A string that represents the current key-signing key (KSK) status.

\n

Status can have one of the following values:

\n
\n
ACTIVE
\n
\n

The KSK is being used for signing.

\n
\n
INACTIVE
\n
\n

The KSK is not being used for signing.

\n
\n
DELETING
\n
\n

The KSK is in the process of being deleted.

\n
\n
ACTION_NEEDED
\n
\n

There is a problem with the KSK that requires you to take action to\n\t\t\t\t\t\tresolve. For example, the customer managed key might have been deleted,\n\t\t\t\t\t\tor the permissions for the customer managed key might have been\n\t\t\t\t\t\tchanged.

\n
\n
INTERNAL_FAILURE
\n
\n

There was an error during a request. Before you can continue to work with\n\t\t\t\t\t\tDNSSEC signing, including actions that involve this KSK, you must correct\n\t\t\t\t\t\tthe problem. For example, you may need to activate or deactivate the\n\t\t\t\t\t\tKSK.

\n
\n
" - } - }, - "StatusMessage": { - "target": "com.amazonaws.route53#SigningKeyStatusMessage", - "traits": { - "smithy.api#documentation": "

The status message provided for the following key-signing key (KSK) statuses:\n\t\t\t\tACTION_NEEDED or INTERNAL_FAILURE. The status message\n\t\t\tincludes information about what the problem might be and steps that you can take to\n\t\t\tcorrect the issue.

" - } - }, - "CreatedDate": { - "target": "com.amazonaws.route53#TimeStamp", - "traits": { - "smithy.api#documentation": "

The date when the key-signing key (KSK) was created.

" - } - }, - "LastModifiedDate": { - "target": "com.amazonaws.route53#TimeStamp", - "traits": { - "smithy.api#documentation": "

The last time that the key-signing key (KSK) was changed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A key-signing key (KSK) is a complex type that represents a public/private key pair.\n\t\t\tThe private key is used to generate a digital signature for the zone signing key (ZSK).\n\t\t\tThe public key is stored in the DNS and is used to authenticate the ZSK. A KSK is always\n\t\t\tassociated with a hosted zone; it cannot exist by itself.

" - } - }, - "com.amazonaws.route53#KeySigningKeyAlreadyExists": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

You've already created a key-signing key (KSK) with this name or with the same customer managed key ARN.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.route53#KeySigningKeyInParentDSRecord": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The key-signing key (KSK) is specified in a parent DS record.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#KeySigningKeyInUse": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The key-signing key (KSK) that you specified can't be deactivated because it's the\n\t\t\tonly KSK for a currently-enabled DNSSEC. Disable DNSSEC signing, or add or enable\n\t\t\tanother KSK.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#KeySigningKeyWithActiveStatusNotFound": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

A key-signing key (KSK) with ACTIVE status wasn't found.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#KeySigningKeys": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#KeySigningKey" - } - }, - "com.amazonaws.route53#LastVPCAssociation": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The VPC that you're trying to disassociate from the private hosted zone is the last\n\t\t\tVPC that is associated with the hosted zone. Amazon Route 53 doesn't support\n\t\t\tdisassociating the last VPC from a hosted zone.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#Latitude": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 6 - }, - "smithy.api#pattern": "^[-+]?[0-9]{1,2}(\\.[0-9]{0,2})?$" - } - }, - "com.amazonaws.route53#LimitValue": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.route53#LimitsExceeded": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This operation can't be completed because the current account has reached the\n\t\t\tlimit on the resource you are trying to create. To request a higher limit, create a case with the Amazon Web Services Support\n\t\t\tCenter.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#LinkedService": { - "type": "structure", - "members": { - "ServicePrincipal": { - "target": "com.amazonaws.route53#ServicePrincipal", - "traits": { - "smithy.api#documentation": "

If the health check or hosted zone was created by another service, the service that\n\t\t\tcreated the resource. When a resource is created by another service, you can't edit or\n\t\t\tdelete it using Amazon Route 53.

" - } - }, - "Description": { - "target": "com.amazonaws.route53#ResourceDescription", - "traits": { - "smithy.api#documentation": "

If the health check or hosted zone was created by another service, an optional\n\t\t\tdescription that can be provided by the other service. When a resource is created by\n\t\t\tanother service, you can't edit or delete it using Amazon Route 53.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

If a health check or hosted zone was created by another service,\n\t\t\t\tLinkedService is a complex type that describes the service that created\n\t\t\tthe resource. When a resource is created by another service, you can't edit or delete it\n\t\t\tusing Amazon Route 53.

" - } - }, - "com.amazonaws.route53#ListCidrBlocks": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListCidrBlocksRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListCidrBlocksResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchCidrCollectionException" - }, - { - "target": "com.amazonaws.route53#NoSuchCidrLocationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a paginated list of location objects and their CIDR blocks.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/cidrcollection/{CollectionId}/cidrblocks", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "CidrBlocks", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.route53#ListCidrBlocksRequest": { - "type": "structure", - "members": { - "CollectionId": { - "target": "com.amazonaws.route53#UUID", - "traits": { - "smithy.api#documentation": "

The UUID of the CIDR collection.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LocationName": { - "target": "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed", - "traits": { - "smithy.api#documentation": "

The name of the CIDR collection location.

", - "smithy.api#httpQuery": "location" - } - }, - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

", - "smithy.api#httpQuery": "nexttoken" - } - }, - "MaxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

Maximum number of results you want returned.

", - "smithy.api#httpQuery": "maxresults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListCidrBlocksResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n

If no value is provided, the listing of results starts from the beginning.

" - } - }, - "CidrBlocks": { - "target": "com.amazonaws.route53#CidrBlockSummaries", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the CIDR blocks.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListCidrCollections": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListCidrCollectionsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListCidrCollectionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a paginated list of CIDR collections in the Amazon Web Services account\n\t\t\t(metadata only).

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/cidrcollection", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "CidrCollections", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.route53#ListCidrCollectionsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n

If no value is provided, the listing of results starts from the beginning.

", - "smithy.api#httpQuery": "nexttoken" - } - }, - "MaxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of CIDR collections to return in the response.

", - "smithy.api#httpQuery": "maxresults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListCidrCollectionsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n

If no value is provided, the listing of results starts from the beginning.

" - } - }, - "CidrCollections": { - "target": "com.amazonaws.route53#CollectionSummaries", - "traits": { - "smithy.api#documentation": "

A complex type with information about the CIDR collection.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListCidrLocations": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListCidrLocationsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListCidrLocationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchCidrCollectionException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a paginated list of CIDR locations for the given collection (metadata only,\n\t\t\tdoes not include CIDR blocks).

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/cidrcollection/{CollectionId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "CidrLocations", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.route53#ListCidrLocationsRequest": { - "type": "structure", - "members": { - "CollectionId": { - "target": "com.amazonaws.route53#UUID", - "traits": { - "smithy.api#documentation": "

The CIDR collection ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n

If no value is provided, the listing of results starts from the beginning.

", - "smithy.api#httpQuery": "nexttoken" - } - }, - "MaxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of CIDR collection locations to return in the response.

", - "smithy.api#httpQuery": "maxresults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListCidrLocationsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n

If no value is provided, the listing of results starts from the beginning.

" - } - }, - "CidrLocations": { - "target": "com.amazonaws.route53#LocationSummaries", - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the list of CIDR locations.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListGeoLocations": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListGeoLocationsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListGeoLocationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves a list of supported geographic locations.

\n

Countries are listed first, and continents are listed last. If Amazon Route 53\n\t\t\tsupports subdivisions for a country (for example, states or provinces), the subdivisions\n\t\t\tfor that country are listed in alphabetical order immediately after the corresponding\n\t\t\tcountry.

\n

Route 53 does not perform authorization for this API because it retrieves information\n\t\t\tthat is already available to the public.

\n

For a list of supported geolocation codes, see the GeoLocation data\n\t\t\ttype.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/geolocations", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListGeoLocationsRequest": { - "type": "structure", - "members": { - "StartContinentCode": { - "target": "com.amazonaws.route53#GeoLocationContinentCode", - "traits": { - "smithy.api#documentation": "

The code for the continent with which you want to start listing locations that Amazon\n\t\t\tRoute 53 supports for geolocation. If Route 53 has already returned a page or more of\n\t\t\tresults, if IsTruncated is true, and if NextContinentCode from\n\t\t\tthe previous response has a value, enter that value in startcontinentcode\n\t\t\tto return the next page of results.

\n

Include startcontinentcode only if you want to list continents. Don't\n\t\t\tinclude startcontinentcode when you're listing countries or countries with\n\t\t\ttheir subdivisions.

", - "smithy.api#httpQuery": "startcontinentcode" - } - }, - "StartCountryCode": { - "target": "com.amazonaws.route53#GeoLocationCountryCode", - "traits": { - "smithy.api#documentation": "

The code for the country with which you want to start listing locations that Amazon\n\t\t\tRoute 53 supports for geolocation. If Route 53 has already returned a page or more of\n\t\t\tresults, if IsTruncated is true, and if\n\t\t\t\tNextCountryCode from the previous response has a value, enter that\n\t\t\tvalue in startcountrycode to return the next page of results.

", - "smithy.api#httpQuery": "startcountrycode" - } - }, - "StartSubdivisionCode": { - "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", - "traits": { - "smithy.api#documentation": "

The code for the state of the United States with which you want to start listing\n\t\t\tlocations that Amazon Route 53 supports for geolocation. If Route 53 has already\n\t\t\treturned a page or more of results, if IsTruncated is true,\n\t\t\tand if NextSubdivisionCode from the previous response has a value, enter\n\t\t\tthat value in startsubdivisioncode to return the next page of\n\t\t\tresults.

\n

To list subdivisions (U.S. states), you must include both\n\t\t\t\tstartcountrycode and startsubdivisioncode.

", - "smithy.api#httpQuery": "startsubdivisioncode" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

(Optional) The maximum number of geolocations to be included in the response body for this\n\t\t\trequest. If more than maxitems geolocations remain to be listed, then the\n\t\t\tvalue of the IsTruncated element in the response is\n\t\t\ttrue.

", - "smithy.api#httpQuery": "maxitems" - } - } - }, - "traits": { - "smithy.api#documentation": "

A request to get a list of geographic locations that Amazon Route 53 supports for\n\t\t\tgeolocation resource record sets.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListGeoLocationsResponse": { - "type": "structure", - "members": { - "GeoLocationDetailsList": { - "target": "com.amazonaws.route53#GeoLocationDetailsList", - "traits": { - "smithy.api#documentation": "

A complex type that contains one GeoLocationDetails element for each\n\t\t\tlocation that Amazon Route 53 supports for geolocation.

", - "smithy.api#required": {} - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates whether more locations remain to be listed after the last\n\t\t\tlocation in this response. If so, the value of IsTruncated is\n\t\t\t\ttrue. To get more values, submit another request and include the values\n\t\t\tof NextContinentCode, NextCountryCode, and\n\t\t\t\tNextSubdivisionCode in the startcontinentcode,\n\t\t\t\tstartcountrycode, and startsubdivisioncode, as\n\t\t\tapplicable.

", - "smithy.api#required": {} - } - }, - "NextContinentCode": { - "target": "com.amazonaws.route53#GeoLocationContinentCode", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true, you can make a follow-up request to\n\t\t\tdisplay more locations. Enter the value of NextContinentCode in the\n\t\t\t\tstartcontinentcode parameter in another ListGeoLocations\n\t\t\trequest.

" - } - }, - "NextCountryCode": { - "target": "com.amazonaws.route53#GeoLocationCountryCode", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true, you can make a follow-up request to\n\t\t\tdisplay more locations. Enter the value of NextCountryCode in the\n\t\t\t\tstartcountrycode parameter in another ListGeoLocations\n\t\t\trequest.

" - } - }, - "NextSubdivisionCode": { - "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true, you can make a follow-up request to\n\t\t\tdisplay more locations. Enter the value of NextSubdivisionCode in the\n\t\t\t\tstartsubdivisioncode parameter in another ListGeoLocations\n\t\t\trequest.

" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The value that you specified for MaxItems in the request.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type containing the response information for the request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListHealthChecks": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListHealthChecksRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListHealthChecksResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#IncompatibleVersion" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieve a list of the health checks that are associated with the current Amazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/healthcheck", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "NextMarker", - "items": "HealthChecks", - "pageSize": "MaxItems" - } - } - }, - "com.amazonaws.route53#ListHealthChecksRequest": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more health checks. To get another group, submit another\n\t\t\t\tListHealthChecks request.

\n

For the value of marker, specify the value of NextMarker\n\t\t\tfrom the previous response, which is the ID of the first health check that Amazon Route\n\t\t\t53 will return if you submit another request.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more health checks to get.

", - "smithy.api#httpQuery": "marker" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of health checks that you want ListHealthChecks to\n\t\t\treturn in response to the current request. Amazon Route 53 returns a maximum of 1000\n\t\t\titems. If you set MaxItems to a value greater than 1000, Route 53 returns\n\t\t\tonly the first 1000 health checks.

", - "smithy.api#httpQuery": "maxitems" - } - } - }, - "traits": { - "smithy.api#documentation": "

A request to retrieve a list of the health checks that are associated with the current\n\t\t\t\tAmazon Web Services account.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListHealthChecksResponse": { - "type": "structure", - "members": { - "HealthChecks": { - "target": "com.amazonaws.route53#HealthChecks", - "traits": { - "smithy.api#documentation": "

A complex type that contains one HealthCheck element for each health\n\t\t\tcheck that is associated with the current Amazon Web Services account.

", - "smithy.api#required": {} - } - }, - "Marker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "

For the second and subsequent calls to ListHealthChecks,\n\t\t\t\tMarker is the value that you specified for the marker\n\t\t\tparameter in the previous request.

", - "smithy.api#required": {} - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A flag that indicates whether there are more health checks to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of health checks by submitting\n\t\t\tanother ListHealthChecks request and specifying the value of\n\t\t\t\tNextMarker in the marker parameter.

", - "smithy.api#required": {} - } - }, - "NextMarker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true, the value of NextMarker\n\t\t\tidentifies the first health check that Amazon Route 53 returns if you submit another\n\t\t\t\tListHealthChecks request and specify the value of\n\t\t\t\tNextMarker in the marker parameter.

" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListHealthChecks that produced the current response.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response to a ListHealthChecks\n\t\t\trequest.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListHostedZones": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListHostedZonesRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListHostedZonesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#DelegationSetNotReusable" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchDelegationSet" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves a list of the public and private hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account. The response includes a HostedZones\n\t\t\tchild element for each hosted zone.

\n

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of\n\t\t\thosted zones, you can use the maxitems parameter to list them in groups of\n\t\t\tup to 100.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/hostedzone", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "NextMarker", - "items": "HostedZones", - "pageSize": "MaxItems" - }, - "smithy.test#smokeTests": [ - { - "id": "ListHostedZonesSuccess", - "params": {}, - "vendorParams": { - "region": "us-east-1" - }, - "vendorParamsShape": "aws.test#AwsVendorParams", - "expect": { - "success": {} - } - } - ] - } - }, - "com.amazonaws.route53#ListHostedZonesByName": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListHostedZonesByNameRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListHostedZonesByNameResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidDomainName" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves a list of your hosted zones in lexicographic order. The response includes a\n\t\t\t\tHostedZones child element for each hosted zone created by the current\n\t\t\t\tAmazon Web Services account.

\n

\n ListHostedZonesByName sorts hosted zones by name with the labels\n\t\t\treversed. For example:

\n

\n com.example.www.\n

\n

Note the trailing dot, which can change the sort order in some circumstances.

\n

If the domain name includes escape characters or Punycode,\n\t\t\t\tListHostedZonesByName alphabetizes the domain name using the escaped or\n\t\t\tPunycoded value, which is the format that Amazon Route 53 saves in its database. For\n\t\t\texample, to create a hosted zone for exämple.com, you specify ex\\344mple.com for\n\t\t\tthe domain name. ListHostedZonesByName alphabetizes it as:

\n

\n com.ex\\344mple.\n

\n

The labels are reversed and alphabetized using the escaped value. For more information\n\t\t\tabout valid domain name formats, including internationalized domain names, see DNS\n\t\t\t\tDomain Name Format in the Amazon Route 53 Developer\n\t\t\t\tGuide.

\n

Route 53 returns up to 100 items in each response. If you have a lot of hosted zones,\n\t\t\tuse the MaxItems parameter to list them in groups of up to 100. The\n\t\t\tresponse includes values that help navigate from one group of MaxItems\n\t\t\thosted zones to the next:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/hostedzonesbyname", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListHostedZonesByNameRequest": { - "type": "structure", - "members": { - "DNSName": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

(Optional) For your first request to ListHostedZonesByName, include the\n\t\t\t\tdnsname parameter only if you want to specify the name of the first\n\t\t\thosted zone in the response. If you don't include the dnsname parameter,\n\t\t\tAmazon Route 53 returns all of the hosted zones that were created by the current Amazon Web Services account, in ASCII order. For subsequent requests, include both\n\t\t\t\tdnsname and hostedzoneid parameters. For\n\t\t\t\tdnsname, specify the value of NextDNSName from the\n\t\t\tprevious response.

", - "smithy.api#httpQuery": "dnsname" - } - }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

(Optional) For your first request to ListHostedZonesByName, do not\n\t\t\tinclude the hostedzoneid parameter.

\n

If you have more hosted zones than the value of maxitems,\n\t\t\t\tListHostedZonesByName returns only the first maxitems\n\t\t\thosted zones. To get the next group of maxitems hosted zones, submit\n\t\t\tanother request to ListHostedZonesByName and include both\n\t\t\t\tdnsname and hostedzoneid parameters. For the value of\n\t\t\t\thostedzoneid, specify the value of the NextHostedZoneId\n\t\t\telement from the previous response.

", - "smithy.api#httpQuery": "hostedzoneid" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of hosted zones to be included in the response body for this\n\t\t\trequest. If you have more than maxitems hosted zones, then the value of the\n\t\t\t\tIsTruncated element in the response is true, and the values of\n\t\t\t\tNextDNSName and NextHostedZoneId specify the first hosted\n\t\t\tzone in the next group of maxitems hosted zones.

", - "smithy.api#httpQuery": "maxitems" - } - } - }, - "traits": { - "smithy.api#documentation": "

Retrieves a list of the public and private hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account in ASCII order by domain name.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListHostedZonesByNameResponse": { - "type": "structure", - "members": { - "HostedZones": { - "target": "com.amazonaws.route53#HostedZones", - "traits": { - "smithy.api#documentation": "

A complex type that contains general information about the hosted zone.

", - "smithy.api#required": {} - } - }, - "DNSName": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

For the second and subsequent calls to ListHostedZonesByName,\n\t\t\t\tDNSName is the value that you specified for the dnsname\n\t\t\tparameter in the request that produced the current response.

" - } - }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID that Amazon Route 53 assigned to the hosted zone when you created it.

" - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A flag that indicates whether there are more hosted zones to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of maxitems hosted zones\n\t\t\tby calling ListHostedZonesByName again and specifying the values of\n\t\t\t\tNextDNSName and NextHostedZoneId elements in the\n\t\t\t\tdnsname and hostedzoneid parameters.

", - "smithy.api#required": {} - } - }, - "NextDNSName": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true, the value of NextDNSName is the name\n\t\t\tof the first hosted zone in the next group of maxitems hosted zones. Call\n\t\t\t\tListHostedZonesByName again and specify the value of\n\t\t\t\tNextDNSName and NextHostedZoneId in the\n\t\t\t\tdnsname and hostedzoneid parameters, respectively.

\n

This element is present only if IsTruncated is true.

" - } - }, - "NextHostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true, the value of\n\t\t\t\tNextHostedZoneId identifies the first hosted zone in the next group of\n\t\t\t\tmaxitems hosted zones. Call ListHostedZonesByName again\n\t\t\tand specify the value of NextDNSName and NextHostedZoneId in\n\t\t\tthe dnsname and hostedzoneid parameters, respectively.

\n

This element is present only if IsTruncated is true.

" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListHostedZonesByName that produced the current response.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response information for the request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListHostedZonesByVPC": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListHostedZonesByVPCRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListHostedZonesByVPCResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidPaginationToken" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all the private hosted zones that a specified VPC is associated with, regardless\n\t\t\tof which Amazon Web Services account or Amazon Web Services service owns the hosted zones.\n\t\t\tThe HostedZoneOwner structure in the response contains one of the following\n\t\t\tvalues:

\n \n \n

When listing private hosted zones, the hosted zone and the Amazon VPC must\n\t\t\t\tbelong to the same partition where the hosted zones were created. A partition is a\n\t\t\t\tgroup of Amazon Web Services Regions. Each Amazon Web Services account is scoped to\n\t\t\t\tone partition.

\n

The following are the supported partitions:

\n \n

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/hostedzonesbyvpc", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListHostedZonesByVPCRequest": { - "type": "structure", - "members": { - "VPCId": { - "target": "com.amazonaws.route53#VPCId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon VPC that you want to list hosted zones for.

", - "smithy.api#httpQuery": "vpcid", - "smithy.api#required": {} - } - }, - "VPCRegion": { - "target": "com.amazonaws.route53#VPCRegion", - "traits": { - "smithy.api#documentation": "

For the Amazon VPC that you specified for VPCId, the Amazon Web Services\n\t\t\tRegion that you created the VPC in.

", - "smithy.api#httpQuery": "vpcregion", - "smithy.api#required": {} - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return.\n\t\t\tIf the specified VPC is associated with more than MaxItems hosted zones,\n\t\t\tthe response includes a NextToken element. NextToken contains\n\t\t\tan encrypted token that identifies the first hosted zone that Route 53 will return if\n\t\t\tyou submit another request.

", - "smithy.api#httpQuery": "maxitems" - } - }, - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "

If the previous response included a NextToken element, the specified VPC\n\t\t\tis associated with more hosted zones. To get more hosted zones, submit another\n\t\t\t\tListHostedZonesByVPC request.

\n

For the value of NextToken, specify the value of NextToken\n\t\t\tfrom the previous response.

\n

If the previous response didn't include a NextToken element, there are no\n\t\t\tmore hosted zones to get.

", - "smithy.api#httpQuery": "nexttoken" - } - } - }, - "traits": { - "smithy.api#documentation": "

Lists all the private hosted zones that a specified VPC is associated with, regardless\n\t\t\tof which Amazon Web Services account created the hosted zones.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListHostedZonesByVPCResponse": { - "type": "structure", - "members": { - "HostedZoneSummaries": { - "target": "com.amazonaws.route53#HostedZoneSummaries", - "traits": { - "smithy.api#documentation": "

A list that contains one HostedZoneSummary element for each hosted zone\n\t\t\tthat the specified Amazon VPC is associated with. Each HostedZoneSummary\n\t\t\telement contains the hosted zone name and ID, and information about who owns the hosted\n\t\t\tzone.

", - "smithy.api#required": {} - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The value that you specified for MaxItems in the most recent\n\t\t\t\tListHostedZonesByVPC request.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "

The value that you will use for NextToken in the next\n\t\t\t\tListHostedZonesByVPC request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListHostedZonesRequest": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more hosted zones. To get more hosted zones, submit\n\t\t\tanother ListHostedZones request.

\n

For the value of marker, specify the value of NextMarker\n\t\t\tfrom the previous response, which is the ID of the first hosted zone that Amazon Route\n\t\t\t53 will return if you submit another request.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more hosted zones to get.

", - "smithy.api#httpQuery": "marker" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return.\n\t\t\tIf you have more than maxitems hosted zones, the value of\n\t\t\t\tIsTruncated in the response is true, and the value of\n\t\t\t\tNextMarker is the hosted zone ID of the first hosted zone that Route 53\n\t\t\twill return if you submit another request.

", - "smithy.api#httpQuery": "maxitems" - } - }, - "DelegationSetId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

If you're using reusable delegation sets and you want to list all of the hosted zones\n\t\t\tthat are associated with a reusable delegation set, specify the ID of that reusable\n\t\t\tdelegation set.

", - "smithy.api#httpQuery": "delegationsetid" - } - }, - "HostedZoneType": { - "target": "com.amazonaws.route53#HostedZoneType", - "traits": { - "smithy.api#documentation": "

\n\t\t\t(Optional) Specifies if the hosted zone is private.\n\t\t

", - "smithy.api#httpQuery": "hostedzonetype" - } - } - }, - "traits": { - "smithy.api#documentation": "

A request to retrieve a list of the public and private hosted zones that are\n\t\t\tassociated with the current Amazon Web Services account.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListHostedZonesResponse": { - "type": "structure", - "members": { - "HostedZones": { - "target": "com.amazonaws.route53#HostedZones", - "traits": { - "smithy.api#documentation": "

A complex type that contains general information about the hosted zone.

", - "smithy.api#required": {} - } - }, - "Marker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "

For the second and subsequent calls to ListHostedZones,\n\t\t\t\tMarker is the value that you specified for the marker\n\t\t\tparameter in the request that produced the current response.

", - "smithy.api#required": {} - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A flag indicating whether there are more hosted zones to be listed. If the response\n\t\t\twas truncated, you can get more hosted zones by submitting another\n\t\t\t\tListHostedZones request and specifying the value of\n\t\t\t\tNextMarker in the marker parameter.

", - "smithy.api#required": {} - } - }, - "NextMarker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true, the value of NextMarker\n\t\t\tidentifies the first hosted zone in the next group of hosted zones. Submit another\n\t\t\t\tListHostedZones request, and specify the value of\n\t\t\t\tNextMarker from the response in the marker\n\t\t\tparameter.

\n

This element is present only if IsTruncated is true.

" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListHostedZones that produced the current response.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListQueryLoggingConfigs": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListQueryLoggingConfigsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListQueryLoggingConfigsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidPaginationToken" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the configurations for DNS query logging that are associated with the current\n\t\t\t\tAmazon Web Services account or the configuration that is associated with a specified\n\t\t\thosted zone.

\n

For more information about DNS query logs, see CreateQueryLoggingConfig. Additional information, including the format of\n\t\t\tDNS query logs, appears in Logging DNS Queries in\n\t\t\tthe Amazon Route 53 Developer Guide.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/queryloggingconfig", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "QueryLoggingConfigs", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.route53#ListQueryLoggingConfigsRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

(Optional) If you want to list the query logging configuration that is associated with\n\t\t\ta hosted zone, specify the ID in HostedZoneId.

\n

If you don't specify a hosted zone ID, ListQueryLoggingConfigs returns\n\t\t\tall of the configurations that are associated with the current Amazon Web Services account.

", - "smithy.api#httpQuery": "hostedzoneid" - } - }, - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "

(Optional) If the current Amazon Web Services account has more than\n\t\t\t\tMaxResults query logging configurations, use NextToken to\n\t\t\tget the second and subsequent pages of results.

\n

For the first ListQueryLoggingConfigs request, omit this value.

\n

For the second and subsequent requests, get the value of NextToken from\n\t\t\tthe previous response and specify that value for NextToken in the\n\t\t\trequest.

", - "smithy.api#httpQuery": "nexttoken" - } - }, - "MaxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

(Optional) The maximum number of query logging configurations that you want Amazon\n\t\t\tRoute 53 to return in response to the current request. If the current Amazon Web Services account has more than MaxResults configurations, use the\n\t\t\tvalue of NextToken in the response to get the next page of results.

\n

If you don't specify a value for MaxResults, Route 53 returns up to 100\n\t\t\tconfigurations.

", - "smithy.api#httpQuery": "maxresults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListQueryLoggingConfigsResponse": { - "type": "structure", - "members": { - "QueryLoggingConfigs": { - "target": "com.amazonaws.route53#QueryLoggingConfigs", - "traits": { - "smithy.api#documentation": "

An array that contains one QueryLoggingConfig element for each configuration for DNS query logging\n\t\t\tthat is associated with the current Amazon Web Services account.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "

If a response includes the last of the query logging configurations that are\n\t\t\tassociated with the current Amazon Web Services account, NextToken doesn't\n\t\t\tappear in the response.

\n

If a response doesn't include the last of the configurations, you can get more\n\t\t\tconfigurations by submitting another ListQueryLoggingConfigs request. Get the value of NextToken\n\t\t\tthat Amazon Route 53 returned in the previous response and include it in\n\t\t\t\tNextToken in the next request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListResourceRecordSets": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListResourceRecordSetsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListResourceRecordSetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the resource record sets in a specified hosted zone.

\n

\n ListResourceRecordSets returns up to 300 resource record sets at a time\n\t\t\tin ASCII order, beginning at a position specified by the name and\n\t\t\t\ttype elements.

\n

\n Sort order\n

\n

\n ListResourceRecordSets sorts results first by DNS name with the labels\n\t\t\treversed, for example:

\n

\n com.example.www.\n

\n

Note the trailing dot, which can change the sort order when the record name contains\n\t\t\tcharacters that appear before . (decimal 46) in the ASCII table. These\n\t\t\tcharacters include the following: ! \" # $ % & ' ( ) * + , -\n

\n

When multiple records have the same DNS name, ListResourceRecordSets\n\t\t\tsorts results by the record type.

\n

\n Specifying where to start listing records\n

\n

You can use the name and type elements to specify the resource record set that the\n\t\t\tlist begins with:

\n
\n
If you do not specify Name or Type
\n
\n

The results begin with the first resource record set that the hosted zone\n\t\t\t\t\t\tcontains.

\n
\n
If you specify Name but not Type
\n
\n

The results begin with the first resource record set in the list whose\n\t\t\t\t\t\tname is greater than or equal to Name.

\n
\n
If you specify Type but not Name
\n
\n

Amazon Route 53 returns the InvalidInput error.

\n
\n
If you specify both Name and Type
\n
\n

The results begin with the first resource record set in the list whose\n\t\t\t\t\t\tname is greater than or equal to Name, and whose type is\n\t\t\t\t\t\tgreater than or equal to Type.

\n
\n
\n

\n Resource record sets that are PENDING\n

\n

This action returns the most current version of the records. This includes records\n\t\t\tthat are PENDING, and that are not yet available on all Route 53 DNS\n\t\t\tservers.

\n

\n Changing resource record sets\n

\n

To ensure that you get an accurate listing of the resource record sets for a hosted\n\t\t\tzone at a point in time, do not submit a ChangeResourceRecordSets request\n\t\t\twhile you're paging through the results of a ListResourceRecordSets\n\t\t\trequest. If you do, some pages may display results without the latest changes while\n\t\t\tother pages display results with the latest changes.

\n

\n Displaying the next page of results\n

\n

If a ListResourceRecordSets command returns more than one page of\n\t\t\tresults, the value of IsTruncated is true. To display the next\n\t\t\tpage of results, get the values of NextRecordName,\n\t\t\t\tNextRecordType, and NextRecordIdentifier (if any) from the\n\t\t\tresponse. Then submit another ListResourceRecordSets request, and specify\n\t\t\tthose values for StartRecordName, StartRecordType, and\n\t\t\t\tStartRecordIdentifier.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/rrset", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListResourceRecordSetsRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that contains the resource record sets that you want to\n\t\t\tlist.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "StartRecordName": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

The first name in the lexicographic ordering of resource record sets that you want to\n\t\t\tlist. If the specified record name doesn't exist, the results begin with the first\n\t\t\tresource record set that has a name greater than the value of name.

", - "smithy.api#httpQuery": "name" - } - }, - "StartRecordType": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

The type of resource record set to begin the record listing from.

\n

Valid values for basic resource record sets: A | AAAA |\n\t\t\t\tCAA | CNAME | MX | NAPTR |\n\t\t\t\tNS | PTR | SOA | SPF |\n\t\t\t\tSRV | TXT\n

\n

Values for weighted, latency, geolocation, and failover resource record sets:\n\t\t\t\tA | AAAA | CAA | CNAME |\n\t\t\t\tMX | NAPTR | PTR | SPF |\n\t\t\t\tSRV | TXT\n

\n

Values for alias resource record sets:

\n \n

Constraint: Specifying type without specifying name returns\n\t\t\tan InvalidInput error.

", - "smithy.api#httpQuery": "type" - } - }, - "StartRecordIdentifier": { - "target": "com.amazonaws.route53#ResourceRecordSetIdentifier", - "traits": { - "smithy.api#documentation": "

\n Resource record sets that have a routing policy other than\n\t\t\t\tsimple: If results were truncated for a given DNS name and type, specify\n\t\t\tthe value of NextRecordIdentifier from the previous response to get the\n\t\t\tnext resource record set that has the current DNS name and type.

", - "smithy.api#httpQuery": "identifier" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

(Optional) The maximum number of resource records sets to include in the response body\n\t\t\tfor this request. If the response includes more than maxitems resource\n\t\t\trecord sets, the value of the IsTruncated element in the response is\n\t\t\t\ttrue, and the values of the NextRecordName and\n\t\t\t\tNextRecordType elements in the response identify the first resource\n\t\t\trecord set in the next group of maxitems resource record sets.

", - "smithy.api#httpQuery": "maxitems" - } - } - }, - "traits": { - "smithy.api#documentation": "

A request for the resource record sets that are associated with a specified hosted\n\t\t\tzone.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListResourceRecordSetsResponse": { - "type": "structure", - "members": { - "ResourceRecordSets": { - "target": "com.amazonaws.route53#ResourceRecordSets", - "traits": { - "smithy.api#documentation": "

Information about multiple resource record sets.

", - "smithy.api#required": {} - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A flag that indicates whether more resource record sets remain to be listed. If your\n\t\t\tresults were truncated, you can make a follow-up pagination request by using the\n\t\t\t\tNextRecordName element.

", - "smithy.api#required": {} - } - }, - "NextRecordName": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

If the results were truncated, the name of the next record in the list.

\n

This element is present only if IsTruncated is true.

" - } - }, - "NextRecordType": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

If the results were truncated, the type of the next record in the list.

\n

This element is present only if IsTruncated is true.

" - } - }, - "NextRecordIdentifier": { - "target": "com.amazonaws.route53#ResourceRecordSetIdentifier", - "traits": { - "smithy.api#documentation": "

\n Resource record sets that have a routing policy other than\n\t\t\t\tsimple: If results were truncated for a given DNS name and type, the\n\t\t\tvalue of SetIdentifier for the next resource record set that has the\n\t\t\tcurrent DNS name and type.

\n

For information about routing policies, see Choosing a Routing\n\t\t\t\tPolicy in the Amazon Route 53 Developer Guide.

" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of records you requested.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains list information for the resource record set.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListReusableDelegationSets": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListReusableDelegationSetsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListReusableDelegationSetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves a list of the reusable delegation sets that are associated with the current\n\t\t\t\tAmazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/delegationset", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListReusableDelegationSetsRequest": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more reusable delegation sets. To get another group,\n\t\t\tsubmit another ListReusableDelegationSets request.

\n

For the value of marker, specify the value of NextMarker\n\t\t\tfrom the previous response, which is the ID of the first reusable delegation set that\n\t\t\tAmazon Route 53 will return if you submit another request.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more reusable delegation sets to get.

", - "smithy.api#httpQuery": "marker" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The number of reusable delegation sets that you want Amazon Route 53 to return in the\n\t\t\tresponse to this request. If you specify a value greater than 100, Route 53 returns only\n\t\t\tthe first 100 reusable delegation sets.

", - "smithy.api#httpQuery": "maxitems" - } - } - }, - "traits": { - "smithy.api#documentation": "

A request to get a list of the reusable delegation sets that are associated with the\n\t\t\tcurrent Amazon Web Services account.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListReusableDelegationSetsResponse": { - "type": "structure", - "members": { - "DelegationSets": { - "target": "com.amazonaws.route53#DelegationSets", - "traits": { - "smithy.api#documentation": "

A complex type that contains one DelegationSet element for each reusable\n\t\t\tdelegation set that was created by the current Amazon Web Services account.

", - "smithy.api#required": {} - } - }, - "Marker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "

For the second and subsequent calls to ListReusableDelegationSets,\n\t\t\t\tMarker is the value that you specified for the marker\n\t\t\tparameter in the request that produced the current response.

", - "smithy.api#required": {} - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A flag that indicates whether there are more reusable delegation sets to be\n\t\t\tlisted.

", - "smithy.api#required": {} - } - }, - "NextMarker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true, the value of NextMarker\n\t\t\tidentifies the next reusable delegation set that Amazon Route 53 will return if you\n\t\t\tsubmit another ListReusableDelegationSets request and specify the value of\n\t\t\t\tNextMarker in the marker parameter.

" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListReusableDelegationSets that produced the current response.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the reusable delegation sets that are\n\t\t\tassociated with the current Amazon Web Services account.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - }, - { - "target": "com.amazonaws.route53#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists tags for one health check or hosted zone.

\n

For information about using tags for cost allocation, see Using Cost Allocation\n\t\t\t\tTags in the Billing and Cost Management User Guide.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/tags/{ResourceType}/{ResourceId}", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "ResourceType": { - "target": "com.amazonaws.route53#TagResourceType", - "traits": { - "smithy.api#documentation": "

The type of the resource.

\n ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.route53#TagResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the resource for which you want to retrieve tags.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type containing information about a request for a list of the tags that are\n\t\t\tassociated with an individual resource.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "ResourceTagSet": { - "target": "com.amazonaws.route53#ResourceTagSet", - "traits": { - "smithy.api#documentation": "

A ResourceTagSet containing tags associated with the specified\n\t\t\tresource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the health checks or hosted zones for\n\t\t\twhich you want to list tags.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListTagsForResources": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListTagsForResourcesRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListTagsForResourcesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - }, - { - "target": "com.amazonaws.route53#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists tags for up to 10 health checks or hosted zones.

\n

For information about using tags for cost allocation, see Using Cost Allocation\n\t\t\t\tTags in the Billing and Cost Management User Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/tags/{ResourceType}", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListTagsForResourcesRequest": { - "type": "structure", - "members": { - "ResourceType": { - "target": "com.amazonaws.route53#TagResourceType", - "traits": { - "smithy.api#documentation": "

The type of the resources.

\n ", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ResourceIds": { - "target": "com.amazonaws.route53#TagResourceIdList", - "traits": { - "smithy.api#documentation": "

A complex type that contains the ResourceId element for each resource for which you\n\t\t\twant to get a list of tags.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the health checks or hosted zones for\n\t\t\twhich you want to list tags.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListTagsForResourcesResponse": { - "type": "structure", - "members": { - "ResourceTagSets": { - "target": "com.amazonaws.route53#ResourceTagSetList", - "traits": { - "smithy.api#documentation": "

A list of ResourceTagSets containing tags associated with the specified\n\t\t\tresources.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type containing tags for the specified resources.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListTrafficPolicies": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListTrafficPoliciesRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListTrafficPoliciesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about the latest version for every traffic policy that is associated\n\t\t\twith the current Amazon Web Services account. Policies are listed in the order that they\n\t\t\twere created in.

\n

For information about how of deleting a traffic policy affects the response from\n\t\t\t\tListTrafficPolicies, see DeleteTrafficPolicy.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/trafficpolicies", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListTrafficPoliciesRequest": { - "type": "structure", - "members": { - "TrafficPolicyIdMarker": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

(Conditional) For your first request to ListTrafficPolicies, don't\n\t\t\tinclude the TrafficPolicyIdMarker parameter.

\n

If you have more traffic policies than the value of MaxItems,\n\t\t\t\tListTrafficPolicies returns only the first MaxItems\n\t\t\ttraffic policies. To get the next group of policies, submit another request to\n\t\t\t\tListTrafficPolicies. For the value of\n\t\t\t\tTrafficPolicyIdMarker, specify the value of\n\t\t\t\tTrafficPolicyIdMarker that was returned in the previous\n\t\t\tresponse.

", - "smithy.api#httpQuery": "trafficpolicyid" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

(Optional) The maximum number of traffic policies that you want Amazon Route 53 to\n\t\t\treturn in response to this request. If you have more than MaxItems traffic\n\t\t\tpolicies, the value of IsTruncated in the response is true,\n\t\t\tand the value of TrafficPolicyIdMarker is the ID of the first traffic\n\t\t\tpolicy that Route 53 will return if you submit another request.

", - "smithy.api#httpQuery": "maxitems" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the information about the request to list the traffic\n\t\t\tpolicies that are associated with the current Amazon Web Services account.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListTrafficPoliciesResponse": { - "type": "structure", - "members": { - "TrafficPolicySummaries": { - "target": "com.amazonaws.route53#TrafficPolicySummaries", - "traits": { - "smithy.api#documentation": "

A list that contains one TrafficPolicySummary element for each traffic\n\t\t\tpolicy that was created by the current Amazon Web Services account.

", - "smithy.api#required": {} - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A flag that indicates whether there are more traffic policies to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of traffic policies by submitting\n\t\t\tanother ListTrafficPolicies request and specifying the value of\n\t\t\t\tTrafficPolicyIdMarker in the TrafficPolicyIdMarker request\n\t\t\tparameter.

", - "smithy.api#required": {} - } - }, - "TrafficPolicyIdMarker": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated is true,\n\t\t\t\tTrafficPolicyIdMarker is the ID of the first traffic policy in the next\n\t\t\tgroup of MaxItems traffic policies.

", - "smithy.api#required": {} - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The value that you specified for the MaxItems parameter in the\n\t\t\t\tListTrafficPolicies request that produced the current response.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response information for the request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListTrafficPolicyInstancesRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListTrafficPolicyInstancesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about the traffic policy instances that you created by using the\n\t\t\tcurrent Amazon Web Services account.

\n \n

After you submit an UpdateTrafficPolicyInstance request, there's a\n\t\t\t\tbrief delay while Amazon Route 53 creates the resource record sets that are\n\t\t\t\tspecified in the traffic policy definition. For more information, see the\n\t\t\t\t\tState response element.

\n \n

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic\n\t\t\tpolicy instances, you can use the MaxItems parameter to list them in groups\n\t\t\tof up to 100.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/trafficpolicyinstances", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZone": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZoneRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZoneResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about the traffic policy instances that you created in a specified\n\t\t\thosted zone.

\n \n

After you submit a CreateTrafficPolicyInstance or an\n\t\t\t\t\tUpdateTrafficPolicyInstance request, there's a brief delay while\n\t\t\t\tAmazon Route 53 creates the resource record sets that are specified in the traffic\n\t\t\t\tpolicy definition. For more information, see the State response\n\t\t\t\telement.

\n \n

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic\n\t\t\tpolicy instances, you can use the MaxItems parameter to list them in groups\n\t\t\tof up to 100.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/trafficpolicyinstances/hostedzone", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZoneRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that you want to list traffic policy instances for.

", - "smithy.api#httpQuery": "id", - "smithy.api#required": {} - } - }, - "TrafficPolicyInstanceNameMarker": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response is true, you have\n\t\t\tmore traffic policy instances. To get more traffic policy instances, submit another\n\t\t\t\tListTrafficPolicyInstances request. For the value of\n\t\t\t\ttrafficpolicyinstancename, specify the value of\n\t\t\t\tTrafficPolicyInstanceNameMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", - "smithy.api#httpQuery": "trafficpolicyinstancename" - } - }, - "TrafficPolicyInstanceTypeMarker": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response is true, you have\n\t\t\tmore traffic policy instances. To get more traffic policy instances, submit another\n\t\t\t\tListTrafficPolicyInstances request. For the value of\n\t\t\t\ttrafficpolicyinstancetype, specify the value of\n\t\t\t\tTrafficPolicyInstanceTypeMarker from the previous response, which is\n\t\t\tthe type of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", - "smithy.api#httpQuery": "trafficpolicyinstancetype" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of traffic policy instances to be included in the response body for\n\t\t\tthis request. If you have more than MaxItems traffic policy instances, the\n\t\t\tvalue of the IsTruncated element in the response is true, and\n\t\t\tthe values of HostedZoneIdMarker,\n\t\t\t\tTrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker represent the first traffic policy\n\t\t\tinstance that Amazon Route 53 will return if you submit another request.

", - "smithy.api#httpQuery": "maxitems" - } - } - }, - "traits": { - "smithy.api#documentation": "

A request for the traffic policy instances that you created in a specified hosted\n\t\t\tzone.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZoneResponse": { - "type": "structure", - "members": { - "TrafficPolicyInstances": { - "target": "com.amazonaws.route53#TrafficPolicyInstances", - "traits": { - "smithy.api#documentation": "

A list that contains one TrafficPolicyInstance element for each traffic\n\t\t\tpolicy instance that matches the elements in the request.

", - "smithy.api#required": {} - } - }, - "TrafficPolicyInstanceNameMarker": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceNameMarker is the name of the first traffic policy\n\t\t\tinstance in the next group of traffic policy instances.

" - } - }, - "TrafficPolicyInstanceTypeMarker": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true, TrafficPolicyInstanceTypeMarker is\n\t\t\tthe DNS type of the resource record sets that are associated with the first traffic\n\t\t\tpolicy instance in the next group of traffic policy instances.

" - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A flag that indicates whether there are more traffic policy instances to be listed. If\n\t\t\tthe response was truncated, you can get the next group of traffic policy instances by\n\t\t\tsubmitting another ListTrafficPolicyInstancesByHostedZone request and\n\t\t\tspecifying the values of HostedZoneIdMarker,\n\t\t\t\tTrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker in the corresponding request\n\t\t\tparameters.

", - "smithy.api#required": {} - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The value that you specified for the MaxItems parameter in the\n\t\t\t\tListTrafficPolicyInstancesByHostedZone request that produced the\n\t\t\tcurrent response.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response information for the request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicy" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about the traffic policy instances that you created by using a\n\t\t\tspecify traffic policy version.

\n \n

After you submit a CreateTrafficPolicyInstance or an\n\t\t\t\t\tUpdateTrafficPolicyInstance request, there's a brief delay while\n\t\t\t\tAmazon Route 53 creates the resource record sets that are specified in the traffic\n\t\t\t\tpolicy definition. For more information, see the State response\n\t\t\t\telement.

\n \n

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic\n\t\t\tpolicy instances, you can use the MaxItems parameter to list them in groups\n\t\t\tof up to 100.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/trafficpolicyinstances/trafficpolicy", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyRequest": { - "type": "structure", - "members": { - "TrafficPolicyId": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

The ID of the traffic policy for which you want to list traffic policy\n\t\t\tinstances.

", - "smithy.api#httpQuery": "id", - "smithy.api#required": {} - } - }, - "TrafficPolicyVersion": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", - "traits": { - "smithy.api#documentation": "

The version of the traffic policy for which you want to list traffic policy instances.\n\t\t\tThe version must be associated with the traffic policy that is specified by\n\t\t\t\tTrafficPolicyId.

", - "smithy.api#httpQuery": "version", - "smithy.api#required": {} - } - }, - "HostedZoneIdMarker": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstancesByPolicy\n\t\t\trequest.

\n

For the value of hostedzoneid, specify the value of\n\t\t\t\tHostedZoneIdMarker from the previous response, which is the hosted zone\n\t\t\tID of the first traffic policy instance that Amazon Route 53 will return if you submit\n\t\t\tanother request.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", - "smithy.api#httpQuery": "hostedzoneid" - } - }, - "TrafficPolicyInstanceNameMarker": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstancesByPolicy\n\t\t\trequest.

\n

For the value of trafficpolicyinstancename, specify the value of\n\t\t\t\tTrafficPolicyInstanceNameMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance that Amazon Route 53 will return if you\n\t\t\tsubmit another request.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", - "smithy.api#httpQuery": "trafficpolicyinstancename" - } - }, - "TrafficPolicyInstanceTypeMarker": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstancesByPolicy\n\t\t\trequest.

\n

For the value of trafficpolicyinstancetype, specify the value of\n\t\t\t\tTrafficPolicyInstanceTypeMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance that Amazon Route 53 will return if you\n\t\t\tsubmit another request.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", - "smithy.api#httpQuery": "trafficpolicyinstancetype" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of traffic policy instances to be included in the response body for\n\t\t\tthis request. If you have more than MaxItems traffic policy instances, the\n\t\t\tvalue of the IsTruncated element in the response is true, and\n\t\t\tthe values of HostedZoneIdMarker,\n\t\t\t\tTrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker represent the first traffic policy\n\t\t\tinstance that Amazon Route 53 will return if you submit another request.

", - "smithy.api#httpQuery": "maxitems" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the information about the request to list your traffic\n\t\t\tpolicy instances.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyResponse": { - "type": "structure", - "members": { - "TrafficPolicyInstances": { - "target": "com.amazonaws.route53#TrafficPolicyInstances", - "traits": { - "smithy.api#documentation": "

A list that contains one TrafficPolicyInstance element for each traffic\n\t\t\tpolicy instance that matches the elements in the request.

", - "smithy.api#required": {} - } - }, - "HostedZoneIdMarker": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true, HostedZoneIdMarker is\n\t\t\tthe ID of the hosted zone of the first traffic policy instance in the next group of\n\t\t\ttraffic policy instances.

" - } - }, - "TrafficPolicyInstanceNameMarker": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceNameMarker is the name of the first traffic policy\n\t\t\tinstance in the next group of MaxItems traffic policy instances.

" - } - }, - "TrafficPolicyInstanceTypeMarker": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceTypeMarker is the DNS type of the resource record\n\t\t\tsets that are associated with the first traffic policy instance in the next group of\n\t\t\t\tMaxItems traffic policy instances.

" - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A flag that indicates whether there are more traffic policy instances to be listed. If\n\t\t\tthe response was truncated, you can get the next group of traffic policy instances by\n\t\t\tcalling ListTrafficPolicyInstancesByPolicy again and specifying the values\n\t\t\tof the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker,\n\t\t\tand TrafficPolicyInstanceTypeMarker elements in the corresponding request\n\t\t\tparameters.

", - "smithy.api#required": {} - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The value that you specified for the MaxItems parameter in the call to\n\t\t\t\tListTrafficPolicyInstancesByPolicy that produced the current\n\t\t\tresponse.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response information for the request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstancesRequest": { - "type": "structure", - "members": { - "HostedZoneIdMarker": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstances request. For\n\t\t\tthe value of HostedZoneId, specify the value of\n\t\t\t\tHostedZoneIdMarker from the previous response, which is the hosted zone\n\t\t\tID of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", - "smithy.api#httpQuery": "hostedzoneid" - } - }, - "TrafficPolicyInstanceNameMarker": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstances request. For\n\t\t\tthe value of trafficpolicyinstancename, specify the value of\n\t\t\t\tTrafficPolicyInstanceNameMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", - "smithy.api#httpQuery": "trafficpolicyinstancename" - } - }, - "TrafficPolicyInstanceTypeMarker": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstances request. For\n\t\t\tthe value of trafficpolicyinstancetype, specify the value of\n\t\t\t\tTrafficPolicyInstanceTypeMarker from the previous response, which is\n\t\t\tthe type of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", - "smithy.api#httpQuery": "trafficpolicyinstancetype" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of traffic policy instances that you want Amazon Route 53 to return\n\t\t\tin response to a ListTrafficPolicyInstances request. If you have more than\n\t\t\t\tMaxItems traffic policy instances, the value of the\n\t\t\t\tIsTruncated element in the response is true, and the\n\t\t\tvalues of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker,\n\t\t\tand TrafficPolicyInstanceTypeMarker represent the first traffic policy\n\t\t\tinstance in the next group of MaxItems traffic policy instances.

", - "smithy.api#httpQuery": "maxitems" - } - } - }, - "traits": { - "smithy.api#documentation": "

A request to get information about the traffic policy instances that you created by\n\t\t\tusing the current Amazon Web Services account.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstancesResponse": { - "type": "structure", - "members": { - "TrafficPolicyInstances": { - "target": "com.amazonaws.route53#TrafficPolicyInstances", - "traits": { - "smithy.api#documentation": "

A list that contains one TrafficPolicyInstance element for each traffic\n\t\t\tpolicy instance that matches the elements in the request.

", - "smithy.api#required": {} - } - }, - "HostedZoneIdMarker": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true, HostedZoneIdMarker is\n\t\t\tthe ID of the hosted zone of the first traffic policy instance that Route 53 will return\n\t\t\tif you submit another ListTrafficPolicyInstances request.

" - } - }, - "TrafficPolicyInstanceNameMarker": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceNameMarker is the name of the first traffic policy\n\t\t\tinstance that Route 53 will return if you submit another\n\t\t\t\tListTrafficPolicyInstances request.

" - } - }, - "TrafficPolicyInstanceTypeMarker": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceTypeMarker is the DNS type of the resource record\n\t\t\tsets that are associated with the first traffic policy instance that Amazon Route 53\n\t\t\twill return if you submit another ListTrafficPolicyInstances request.\n\t\t

" - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A flag that indicates whether there are more traffic policy instances to be listed. If\n\t\t\tthe response was truncated, you can get more traffic policy instances by calling\n\t\t\t\tListTrafficPolicyInstances again and specifying the values of the\n\t\t\t\tHostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker in the corresponding request\n\t\t\tparameters.

", - "smithy.api#required": {} - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The value that you specified for the MaxItems parameter in the call to\n\t\t\t\tListTrafficPolicyInstances that produced the current response.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response information for the request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListTrafficPolicyVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListTrafficPolicyVersionsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListTrafficPolicyVersionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicy" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about all of the versions for a specified traffic policy.

\n

Traffic policy versions are listed in numerical order by\n\t\t\tVersionNumber.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/trafficpolicies/{Id}/versions", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListTrafficPolicyVersionsRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

Specify the value of Id of the traffic policy for which you want to list\n\t\t\tall versions.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TrafficPolicyVersionMarker": { - "target": "com.amazonaws.route53#TrafficPolicyVersionMarker", - "traits": { - "smithy.api#documentation": "

For your first request to ListTrafficPolicyVersions, don't include the\n\t\t\t\tTrafficPolicyVersionMarker parameter.

\n

If you have more traffic policy versions than the value of MaxItems,\n\t\t\t\tListTrafficPolicyVersions returns only the first group of\n\t\t\t\tMaxItems versions. To get more traffic policy versions, submit another\n\t\t\t\tListTrafficPolicyVersions request. For the value of\n\t\t\t\tTrafficPolicyVersionMarker, specify the value of\n\t\t\t\tTrafficPolicyVersionMarker in the previous response.

", - "smithy.api#httpQuery": "trafficpolicyversion" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of traffic policy versions that you want Amazon Route 53 to include\n\t\t\tin the response body for this request. If the specified traffic policy has more than\n\t\t\t\tMaxItems versions, the value of IsTruncated in the\n\t\t\tresponse is true, and the value of the\n\t\t\t\tTrafficPolicyVersionMarker element is the ID of the first version that\n\t\t\tRoute 53 will return if you submit another request.

", - "smithy.api#httpQuery": "maxitems" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the information about the request to list your traffic\n\t\t\tpolicies.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListTrafficPolicyVersionsResponse": { - "type": "structure", - "members": { - "TrafficPolicies": { - "target": "com.amazonaws.route53#TrafficPolicies", - "traits": { - "smithy.api#documentation": "

A list that contains one TrafficPolicy element for each traffic policy\n\t\t\tversion that is associated with the specified traffic policy.

", - "smithy.api#required": {} - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A flag that indicates whether there are more traffic policies to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of traffic policies by submitting\n\t\t\tanother ListTrafficPolicyVersions request and specifying the value of\n\t\t\t\tNextMarker in the marker parameter.

", - "smithy.api#required": {} - } - }, - "TrafficPolicyVersionMarker": { - "target": "com.amazonaws.route53#TrafficPolicyVersionMarker", - "traits": { - "smithy.api#documentation": "

If IsTruncated is true, the value of\n\t\t\t\tTrafficPolicyVersionMarker identifies the first traffic policy that\n\t\t\tAmazon Route 53 will return if you submit another request. Call\n\t\t\t\tListTrafficPolicyVersions again and specify the value of\n\t\t\t\tTrafficPolicyVersionMarker in the\n\t\t\t\tTrafficPolicyVersionMarker request parameter.

\n

This element is present only if IsTruncated is true.

", - "smithy.api#required": {} - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the\n\t\t\t\tListTrafficPolicyVersions request that produced the current\n\t\t\tresponse.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response information for the request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListVPCAssociationAuthorizations": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListVPCAssociationAuthorizationsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListVPCAssociationAuthorizationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidPaginationToken" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - } - ], - "traits": { - "smithy.api#documentation": "

Gets a list of the VPCs that were created by other accounts and that can be associated\n\t\t\twith a specified hosted zone because you've submitted one or more\n\t\t\t\tCreateVPCAssociationAuthorization requests.

\n

The response includes a VPCs element with a VPC child\n\t\t\telement for each VPC that can be associated with the hosted zone.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/authorizevpcassociation", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListVPCAssociationAuthorizationsRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone for which you want a list of VPCs that can be associated\n\t\t\twith the hosted zone.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "

\n Optional: If a response includes a NextToken\n\t\t\telement, there are more VPCs that can be associated with the specified hosted zone. To\n\t\t\tget the next page of results, submit another request, and include the value of\n\t\t\t\tNextToken from the response in the nexttoken parameter in\n\t\t\tanother ListVPCAssociationAuthorizations request.

", - "smithy.api#httpQuery": "nexttoken" - } - }, - "MaxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

\n Optional: An integer that specifies the maximum number of VPCs\n\t\t\tthat you want Amazon Route 53 to return. If you don't specify a value for\n\t\t\t\tMaxResults, Route 53 returns up to 50 VPCs per page.

", - "smithy.api#httpQuery": "maxresults" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about that can be associated with your hosted\n\t\t\tzone.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListVPCAssociationAuthorizationsResponse": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that you can associate the listed VPCs with.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "

When the response includes a NextToken element, there are more VPCs that\n\t\t\tcan be associated with the specified hosted zone. To get the next page of VPCs, submit\n\t\t\tanother ListVPCAssociationAuthorizations request, and include the value of\n\t\t\tthe NextToken element from the response in the nexttoken\n\t\t\trequest parameter.

" - } - }, - "VPCs": { - "target": "com.amazonaws.route53#VPCs", - "traits": { - "smithy.api#documentation": "

The list of VPCs that are authorized to be associated with the specified hosted\n\t\t\tzone.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response information for the request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#LocalZoneGroup": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#LocationSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#LocationSummary" - } - }, - "com.amazonaws.route53#LocationSummary": { - "type": "structure", - "members": { - "LocationName": { - "target": "com.amazonaws.route53#CidrLocationNameDefaultAllowed", - "traits": { - "smithy.api#documentation": "

A string that specifies a location name.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the CIDR location.

" - } - }, - "com.amazonaws.route53#Longitude": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 7 - }, - "smithy.api#pattern": "^[-+]?[0-9]{1,3}(\\.[0-9]{0,2})?$" - } - }, - "com.amazonaws.route53#MeasureLatency": { - "type": "boolean" - }, - "com.amazonaws.route53#Message": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.route53#MetricName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.route53#Nameserver": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.route53#Namespace": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.route53#NoSuchChange": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

A change with the specified change ID does not exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchCidrCollectionException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The CIDR collection you specified, doesn't exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchCidrLocationException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The CIDR collection location doesn't match any locations in your account.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchCloudWatchLogsLogGroup": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

There is no CloudWatch Logs log group with the specified ARN.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchDelegationSet": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A reusable delegation set with the specified ID does not exist.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#NoSuchGeoLocation": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Amazon Route 53 doesn't support the specified geographic location. For a list of\n\t\t\tsupported geolocation codes, see the GeoLocation data\n\t\t\ttype.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchHealthCheck": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

No health check exists with the specified ID.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchHostedZone": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

No hosted zone exists with the ID that you specified.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchKeySigningKey": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The specified key-signing key (KSK) doesn't exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchQueryLoggingConfig": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

There is no DNS query logging configuration with the specified ID.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchTrafficPolicy": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

No traffic policy exists with the specified ID.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchTrafficPolicyInstance": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

No traffic policy instance exists with the specified ID.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#Nonce": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.route53#NotAuthorizedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Associating the specified VPC with the specified hosted zone has not been\n\t\t\tauthorized.

", - "smithy.api#error": "client", - "smithy.api#httpError": 401 - } - }, - "com.amazonaws.route53#PageMarker": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - } - } - }, - "com.amazonaws.route53#PageTruncated": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.route53#PaginationToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.route53#Period": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 60 - } - } - }, - "com.amazonaws.route53#Port": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 65535 - } - } - }, - "com.amazonaws.route53#PriorRequestNotComplete": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

If Amazon Route 53 can't process a request before the next request arrives, it will\n\t\t\treject subsequent requests for the same hosted zone and return an HTTP 400\n\t\t\t\terror (Bad request). If Route 53 returns this error repeatedly\n\t\t\tfor the same request, we recommend that you wait, in intervals of increasing duration,\n\t\t\tbefore you try the request again.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#PublicZoneVPCAssociation": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

You're trying to associate a VPC with a public hosted zone. Amazon Route 53 doesn't\n\t\t\tsupport associating a VPC with a public hosted zone.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#QueryLoggingConfig": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#QueryLoggingConfigId", - "traits": { - "smithy.api#documentation": "

The ID for a configuration for DNS query logging.

", - "smithy.api#required": {} - } - }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that CloudWatch Logs is logging queries for.

", - "smithy.api#required": {} - } - }, - "CloudWatchLogsLogGroupArn": { - "target": "com.amazonaws.route53#CloudWatchLogsLogGroupArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53\n\t\t\tis publishing logs to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about a configuration for DNS query\n\t\t\tlogging.

" - } - }, - "com.amazonaws.route53#QueryLoggingConfigAlreadyExists": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

You can create only one query logging configuration for a hosted zone, and a query\n\t\t\tlogging configuration already exists for this hosted zone.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.route53#QueryLoggingConfigId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 36 - } - } - }, - "com.amazonaws.route53#QueryLoggingConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#QueryLoggingConfig", - "traits": { - "smithy.api#xmlName": "QueryLoggingConfig" - } - } - }, - "com.amazonaws.route53#RData": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 4000 - } - } - }, - "com.amazonaws.route53#RRType": { - "type": "enum", - "members": { - "SOA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOA" - } - }, - "A": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "A" - } - }, - "TXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TXT" - } - }, - "NS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NS" - } - }, - "CNAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CNAME" - } - }, - "MX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MX" - } - }, - "NAPTR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NAPTR" - } - }, - "PTR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PTR" - } - }, - "SRV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SRV" - } - }, - "SPF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SPF" - } - }, - "AAAA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AAAA" - } - }, - "CAA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CAA" - } - }, - "DS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DS" - } - } - } - }, - "com.amazonaws.route53#RecordData": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#RecordDataEntry", - "traits": { - "smithy.api#xmlName": "RecordDataEntry" - } - } - }, - "com.amazonaws.route53#RecordDataEntry": { - "type": "string", - "traits": { - "smithy.api#documentation": "

A value that Amazon Route 53 returned for this resource record set. A\n\t\t\t\tRecordDataEntry element is one of the following:

\n ", - "smithy.api#length": { - "min": 0, - "max": 512 - } - } - }, - "com.amazonaws.route53#RequestInterval": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 10, - "max": 30 - } - } - }, - "com.amazonaws.route53#ResettableElementName": { - "type": "enum", - "members": { - "FullyQualifiedDomainName": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FullyQualifiedDomainName" - } - }, - "Regions": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Regions" - } - }, - "ResourcePath": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ResourcePath" - } - }, - "ChildHealthChecks": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ChildHealthChecks" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#ResettableElementNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#ResettableElementName", - "traits": { - "smithy.api#xmlName": "ResettableElementName" - } - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - } - } - }, - "com.amazonaws.route53#ResourceDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.route53#ResourceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 32 - } - } - }, - "com.amazonaws.route53#ResourcePath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.route53#ResourceRecord": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.route53#RData", - "traits": { - "smithy.api#documentation": "

The current or new DNS record value, not to exceed 4,000 characters. In the case of a\n\t\t\t\tDELETE action, if the current value does not match the actual value, an\n\t\t\terror is returned. For descriptions about how to format Value for different\n\t\t\trecord types, see Supported DNS Resource\n\t\t\t\tRecord Types in the Amazon Route 53 Developer\n\t\t\tGuide.

\n

You can specify more than one value for all record types except CNAME and\n\t\t\t\tSOA.

\n \n

If you're creating an alias resource record set, omit Value.

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Information specific to the resource record.

\n \n

If you're creating an alias resource record set, omit\n\t\t\t\tResourceRecord.

\n " - } - }, - "com.amazonaws.route53#ResourceRecordSet": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

For ChangeResourceRecordSets requests, the name of the record that you\n\t\t\twant to create, update, or delete. For ListResourceRecordSets responses,\n\t\t\tthe name of a record in the specified hosted zone.

\n

\n ChangeResourceRecordSets Only\n

\n

Enter a fully qualified domain name, for example, www.example.com. You\n\t\t\tcan optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53\n\t\t\tassumes that the domain name that you specify is fully qualified. This means that Route\n\t\t\t53 treats www.example.com (without a trailing dot) and\n\t\t\t\twww.example.com. (with a trailing dot) as identical.

\n

For information about how to specify characters other than a-z,\n\t\t\t\t0-9, and - (hyphen) and how to specify internationalized\n\t\t\tdomain names, see DNS Domain Name\n\t\t\t\tFormat in the Amazon Route 53 Developer Guide.

\n

You can use the asterisk (*) wildcard to replace the leftmost label in a domain name,\n\t\t\tfor example, *.example.com. Note the following:

\n ", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

The DNS record type. For information about different record types and how data is\n\t\t\tencoded for them, see Supported DNS Resource\n\t\t\t\tRecord Types in the Amazon Route 53 Developer\n\t\t\tGuide.

\n

Valid values for basic resource record sets: A | AAAA |\n\t\t\t\tCAA | CNAME | DS |MX |\n\t\t\t\tNAPTR | NS | PTR | SOA |\n\t\t\t\tSPF | SRV | TXT\n

\n

Values for weighted, latency, geolocation, and failover resource record sets:\n\t\t\t\tA | AAAA | CAA | CNAME |\n\t\t\t\tMX | NAPTR | PTR | SPF |\n\t\t\t\tSRV | TXT. When creating a group of weighted, latency,\n\t\t\tgeolocation, or failover resource record sets, specify the same value for all of the\n\t\t\tresource record sets in the group.

\n

Valid values for multivalue answer resource record sets: A |\n\t\t\t\tAAAA | MX | NAPTR | PTR |\n\t\t\t\tSPF | SRV | TXT\n

\n \n

SPF records were formerly used to verify the identity of the sender of email\n\t\t\t\tmessages. However, we no longer recommend that you create resource record sets for\n\t\t\t\twhich the value of Type is SPF. RFC 7208, Sender\n\t\t\t\t\tPolicy Framework (SPF) for Authorizing Use of Domains in Email, Version\n\t\t\t\t\t1, has been updated to say, \"...[I]ts existence and mechanism defined\n\t\t\t\tin [RFC4408] have led to some interoperability issues. Accordingly, its use is no\n\t\t\t\tlonger appropriate for SPF version 1; implementations are not to use it.\" In RFC\n\t\t\t\t7208, see section 14.1, The SPF DNS Record Type.

\n \n

Values for alias resource record sets:

\n ", - "smithy.api#required": {} - } - }, - "SetIdentifier": { - "target": "com.amazonaws.route53#ResourceRecordSetIdentifier", - "traits": { - "smithy.api#documentation": "

\n Resource record sets that have a routing policy other than\n\t\t\t\tsimple: An identifier that differentiates among multiple resource record\n\t\t\tsets that have the same combination of name and type, such as multiple weighted resource\n\t\t\trecord sets named acme.example.com that have a type of A. In a group of resource record\n\t\t\tsets that have the same name and type, the value of SetIdentifier must be\n\t\t\tunique for each resource record set.

\n

For information about routing policies, see Choosing a Routing\n\t\t\t\tPolicy in the Amazon Route 53 Developer Guide.

" - } - }, - "Weight": { - "target": "com.amazonaws.route53#ResourceRecordSetWeight", - "traits": { - "smithy.api#documentation": "

\n Weighted resource record sets only: Among resource record sets\n\t\t\tthat have the same combination of DNS name and type, a value that determines the\n\t\t\tproportion of DNS queries that Amazon Route 53 responds to using the current resource\n\t\t\trecord set. Route 53 calculates the sum of the weights for the resource record sets that\n\t\t\thave the same combination of DNS name and type. Route 53 then responds to queries based\n\t\t\ton the ratio of a resource's weight to the total. Note the following:

\n " - } - }, - "Region": { - "target": "com.amazonaws.route53#ResourceRecordSetRegion", - "traits": { - "smithy.api#documentation": "

\n Latency-based resource record sets only: The Amazon EC2 Region\n\t\t\twhere you created the resource that this resource record set refers to. The resource\n\t\t\ttypically is an Amazon Web Services resource, such as an EC2 instance or an ELB load\n\t\t\tbalancer, and is referred to by an IP address or a DNS domain name, depending on the\n\t\t\trecord type.

\n

When Amazon Route 53 receives a DNS query for a domain name and type for which you\n\t\t\thave created latency resource record sets, Route 53 selects the latency resource record\n\t\t\tset that has the lowest latency between the end user and the associated Amazon EC2\n\t\t\tRegion. Route 53 then returns the value that is associated with the selected resource\n\t\t\trecord set.

\n

Note the following:

\n " - } - }, - "GeoLocation": { - "target": "com.amazonaws.route53#GeoLocation", - "traits": { - "smithy.api#documentation": "

\n Geolocation resource record sets only: A complex type that lets you\n\t\t\tcontrol how Amazon Route 53 responds to DNS queries based on the geographic origin of\n\t\t\tthe query. For example, if you want all queries from Africa to be routed to a web server\n\t\t\twith an IP address of 192.0.2.111, create a resource record set with a\n\t\t\t\tType of A and a ContinentCode of\n\t\t\t\tAF.

\n

If you create separate resource record sets for overlapping geographic regions (for\n\t\t\texample, one resource record set for a continent and one for a country on the same\n\t\t\tcontinent), priority goes to the smallest geographic region. This allows you to route\n\t\t\tmost queries for a continent to one resource and to route queries for a country on that\n\t\t\tcontinent to a different resource.

\n

You can't create two geolocation resource record sets that specify the same geographic\n\t\t\tlocation.

\n

The value * in the CountryCode element matches all\n\t\t\tgeographic locations that aren't specified in other geolocation resource record sets\n\t\t\tthat have the same values for the Name and Type\n\t\t\telements.

\n \n

Geolocation works by mapping IP addresses to locations. However, some IP addresses\n\t\t\t\taren't mapped to geographic locations, so even if you create geolocation resource\n\t\t\t\trecord sets that cover all seven continents, Route 53 will receive some DNS queries\n\t\t\t\tfrom locations that it can't identify. We recommend that you create a resource\n\t\t\t\trecord set for which the value of CountryCode is *. Two\n\t\t\t\tgroups of queries are routed to the resource that you specify in this record:\n\t\t\t\tqueries that come from locations for which you haven't created geolocation resource\n\t\t\t\trecord sets and queries from IP addresses that aren't mapped to a location. If you\n\t\t\t\tdon't create a * resource record set, Route 53 returns a \"no answer\"\n\t\t\t\tresponse for queries from those locations.

\n \n

You can't create non-geolocation resource record sets that have the same values for\n\t\t\tthe Name and Type elements as geolocation resource record\n\t\t\tsets.

" - } - }, - "Failover": { - "target": "com.amazonaws.route53#ResourceRecordSetFailover", - "traits": { - "smithy.api#documentation": "

\n Failover resource record sets only: To configure failover, you\n\t\t\tadd the Failover element to two resource record sets. For one resource\n\t\t\trecord set, you specify PRIMARY as the value for Failover; for\n\t\t\tthe other resource record set, you specify SECONDARY. In addition, you\n\t\t\tinclude the HealthCheckId element and specify the health check that you\n\t\t\twant Amazon Route 53 to perform for each resource record set.

\n

Except where noted, the following failover behaviors assume that you have included the\n\t\t\t\tHealthCheckId element in both resource record sets:

\n \n

You can't create non-failover resource record sets that have the same values for the\n\t\t\t\tName and Type elements as failover resource record\n\t\t\tsets.

\n

For failover alias resource record sets, you must also include the\n\t\t\t\tEvaluateTargetHealth element and set the value to true.

\n

For more information about configuring failover for Route 53, see the following topics\n\t\t\tin the Amazon Route 53 Developer Guide:

\n " - } - }, - "MultiValueAnswer": { - "target": "com.amazonaws.route53#ResourceRecordSetMultiValueAnswer", - "traits": { - "smithy.api#documentation": "

\n Multivalue answer resource record sets only: To route traffic\n\t\t\tapproximately randomly to multiple resources, such as web servers, create one multivalue\n\t\t\tanswer record for each resource and specify true for\n\t\t\t\tMultiValueAnswer. Note the following:

\n \n

You can't create multivalue answer alias records.

" - } - }, - "TTL": { - "target": "com.amazonaws.route53#TTL", - "traits": { - "smithy.api#documentation": "

The resource record cache time to live (TTL), in seconds. Note the following:

\n " - } - }, - "ResourceRecords": { - "target": "com.amazonaws.route53#ResourceRecords", - "traits": { - "smithy.api#documentation": "

Information about the resource records to act upon.

\n \n

If you're creating an alias resource record set, omit\n\t\t\t\tResourceRecords.

\n " - } - }, - "AliasTarget": { - "target": "com.amazonaws.route53#AliasTarget", - "traits": { - "smithy.api#documentation": "

\n Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that\n\t\t\tyou want to route traffic to.

\n

If you're creating resource records sets for a private hosted zone, note the\n\t\t\tfollowing:

\n " - } - }, - "HealthCheckId": { - "target": "com.amazonaws.route53#HealthCheckId", - "traits": { - "smithy.api#documentation": "

If you want Amazon Route 53 to return this resource record set in response to a DNS\n\t\t\tquery only when the status of a health check is healthy, include the\n\t\t\t\tHealthCheckId element and specify the ID of the applicable health\n\t\t\tcheck.

\n

Route 53 determines whether a resource record set is healthy based on one of the\n\t\t\tfollowing:

\n \n \n

Route 53 doesn't check the health of the endpoint that is specified in the\n\t\t\t\tresource record set, for example, the endpoint specified by the IP address in the\n\t\t\t\t\tValue element. When you add a HealthCheckId element to\n\t\t\t\ta resource record set, Route 53 checks the health of the endpoint that you specified\n\t\t\t\tin the health check.

\n \n

For more information, see the following topics in the Amazon Route 53\n\t\t\t\tDeveloper Guide:

\n \n

\n When to Specify HealthCheckId\n

\n

Specifying a value for HealthCheckId is useful only when Route 53 is\n\t\t\tchoosing between two or more resource record sets to respond to a DNS query, and you\n\t\t\twant Route 53 to base the choice in part on the status of a health check. Configuring\n\t\t\thealth checks makes sense only in the following configurations:

\n \n

\n Geolocation Routing\n

\n

For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for\n\t\t\ta resource record set for the larger, associated geographic region. For example, suppose\n\t\t\tyou have resource record sets for a state in the United States, for the entire United\n\t\t\tStates, for North America, and a resource record set that has * for\n\t\t\t\tCountryCode is *, which applies to all locations. If the\n\t\t\tendpoint for the state resource record set is unhealthy, Route 53 checks for healthy\n\t\t\tresource record sets in the following order until it finds a resource record set for\n\t\t\twhich the endpoint is healthy:

\n \n

\n Specifying the Health Check Endpoint by Domain\n\t\t\tName\n

\n

If your health checks specify the endpoint only by domain name, we recommend that you\n\t\t\tcreate a separate health check for each endpoint. For example, create a health check for\n\t\t\teach HTTP server that is serving content for www.example.com.\n\t\t\tFor the value of FullyQualifiedDomainName, specify the domain name of the\n\t\t\tserver (such as us-east-2-www.example.com), not the name of the resource\n\t\t\trecord sets (www.example.com).

\n \n

Health check results will be unpredictable if you do the following:

\n \n " - } - }, - "TrafficPolicyInstanceId": { - "target": "com.amazonaws.route53#TrafficPolicyInstanceId", - "traits": { - "smithy.api#documentation": "

When you create a traffic policy instance, Amazon Route 53 automatically creates a\n\t\t\tresource record set. TrafficPolicyInstanceId is the ID of the traffic\n\t\t\tpolicy instance that Route 53 created this resource record set for.

\n \n

To delete the resource record set that is associated with a traffic policy\n\t\t\t\tinstance, use DeleteTrafficPolicyInstance. Route 53 will delete the\n\t\t\t\tresource record set automatically. If you delete the resource record set by using\n\t\t\t\t\tChangeResourceRecordSets, Route 53 doesn't automatically delete the\n\t\t\t\ttraffic policy instance, and you'll continue to be charged for it even though it's\n\t\t\t\tno longer in use.

\n " - } - }, - "CidrRoutingConfig": { - "target": "com.amazonaws.route53#CidrRoutingConfig" - }, - "GeoProximityLocation": { - "target": "com.amazonaws.route53#GeoProximityLocation", - "traits": { - "smithy.api#documentation": "

\n GeoproximityLocation resource record sets only: A complex type that lets you control how\n\t\t\t\tRoute 53 responds to DNS queries based on the geographic origin of the\n\t\t\tquery and your resources.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the resource record set to create or delete.

" - } - }, - "com.amazonaws.route53#ResourceRecordSetFailover": { - "type": "enum", - "members": { - "PRIMARY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRIMARY" - } - }, - "SECONDARY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SECONDARY" - } - } - } - }, - "com.amazonaws.route53#ResourceRecordSetIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.route53#ResourceRecordSetMultiValueAnswer": { - "type": "boolean" - }, - "com.amazonaws.route53#ResourceRecordSetRegion": { - "type": "enum", - "members": { - "us_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-1" - } - }, - "us_east_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-2" - } - }, - "us_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-1" - } - }, - "us_west_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-2" - } - }, - "ca_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ca-central-1" - } - }, - "eu_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-1" - } - }, - "eu_west_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-2" - } - }, - "eu_west_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-3" - } - }, - "eu_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-central-1" - } - }, - "eu_central_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-central-2" - } - }, - "ap_southeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-1" - } - }, - "ap_southeast_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-2" - } - }, - "ap_southeast_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-3" - } - }, - "ap_northeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-1" - } - }, - "ap_northeast_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-2" - } - }, - "ap_northeast_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-3" - } - }, - "eu_north_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-north-1" - } - }, - "sa_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sa-east-1" - } - }, - "cn_north_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cn-north-1" - } - }, - "cn_northwest_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cn-northwest-1" - } - }, - "ap_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-east-1" - } - }, - "me_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "me-south-1" - } - }, - "me_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "me-central-1" - } - }, - "ap_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-south-1" - } - }, - "ap_south_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-south-2" - } - }, - "af_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "af-south-1" - } - }, - "eu_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-south-1" - } - }, - "eu_south_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-south-2" - } - }, - "ap_southeast_4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-4" - } - }, - "il_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "il-central-1" - } - }, - "ca_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ca-west-1" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#ResourceRecordSetWeight": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.route53#ResourceRecordSets": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#ResourceRecordSet", - "traits": { - "smithy.api#xmlName": "ResourceRecordSet" - } - } - }, - "com.amazonaws.route53#ResourceRecords": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#ResourceRecord", - "traits": { - "smithy.api#xmlName": "ResourceRecord" - } - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.route53#ResourceTagSet": { - "type": "structure", - "members": { - "ResourceType": { - "target": "com.amazonaws.route53#TagResourceType", - "traits": { - "smithy.api#documentation": "

The type of the resource.

\n " - } - }, - "ResourceId": { - "target": "com.amazonaws.route53#TagResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the specified resource.

" - } - }, - "Tags": { - "target": "com.amazonaws.route53#TagList", - "traits": { - "smithy.api#documentation": "

The tags associated with the specified resource.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type containing a resource and its associated tags.

" - } - }, - "com.amazonaws.route53#ResourceTagSetList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#ResourceTagSet", - "traits": { - "smithy.api#xmlName": "ResourceTagSet" - } - } - }, - "com.amazonaws.route53#ResourceURI": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.route53#ReusableDelegationSetLimit": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.route53#ReusableDelegationSetLimitType", - "traits": { - "smithy.api#documentation": "

The limit that you requested: MAX_ZONES_BY_REUSABLE_DELEGATION_SET, the\n\t\t\tmaximum number of hosted zones that you can associate with the specified reusable\n\t\t\tdelegation set.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.route53#LimitValue", - "traits": { - "smithy.api#documentation": "

The current value for the MAX_ZONES_BY_REUSABLE_DELEGATION_SET\n\t\t\tlimit.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the type of limit that you specified in the request and\n\t\t\tthe current value for that limit.

" - } - }, - "com.amazonaws.route53#ReusableDelegationSetLimitType": { - "type": "enum", - "members": { - "MAX_ZONES_BY_REUSABLE_DELEGATION_SET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_ZONES_BY_REUSABLE_DELEGATION_SET" - } - } - } - }, - "com.amazonaws.route53#RoutingControlArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.route53#SearchString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.route53#ServeSignature": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.route53#ServicePrincipal": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - } - } - }, - "com.amazonaws.route53#SigningKeyInteger": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.route53#SigningKeyName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 128 - } - } - }, - "com.amazonaws.route53#SigningKeyStatus": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 5, - "max": 150 - } - } - }, - "com.amazonaws.route53#SigningKeyStatusMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - } - } - }, - "com.amazonaws.route53#SigningKeyString": { - "type": "string" - }, - "com.amazonaws.route53#SigningKeyTag": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 65536 - } - } - }, - "com.amazonaws.route53#Statistic": { - "type": "enum", - "members": { - "Average": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Average" - } - }, - "Sum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Sum" - } - }, - "SampleCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SampleCount" - } - }, - "Maximum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Maximum" - } - }, - "Minimum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Minimum" - } - } - } - }, - "com.amazonaws.route53#Status": { - "type": "string" - }, - "com.amazonaws.route53#StatusReport": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.route53#Status", - "traits": { - "smithy.api#documentation": "

A description of the status of the health check endpoint as reported by one of the\n\t\t\tAmazon Route 53 health checkers.

" - } - }, - "CheckedTime": { - "target": "com.amazonaws.route53#TimeStamp", - "traits": { - "smithy.api#documentation": "

The date and time that the health checker performed the health check in ISO 8601 format and Coordinated\n\t\t\tUniversal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z\n\t\t\trepresents March 27, 2017 at 17:48:16.751 UTC.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the status that one Amazon Route 53 health checker\n\t\t\treports and the time of the health check.

" - } - }, - "com.amazonaws.route53#SubnetMask": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 3 - } - } - }, - "com.amazonaws.route53#TTL": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 2147483647 - } - } - }, - "com.amazonaws.route53#Tag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.route53#TagKey", - "traits": { - "smithy.api#documentation": "

The value of Key depends on the operation that you want to\n\t\t\tperform:

\n " - } - }, - "Value": { - "target": "com.amazonaws.route53#TagValue", - "traits": { - "smithy.api#documentation": "

The value of Value depends on the operation that you want to\n\t\t\tperform:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about a tag that you want to add or edit for\n\t\t\tthe specified health check or hosted zone.

" - } - }, - "com.amazonaws.route53#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - } - } - }, - "com.amazonaws.route53#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#TagKey", - "traits": { - "smithy.api#xmlName": "Key" - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.route53#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#Tag", - "traits": { - "smithy.api#xmlName": "Tag" - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.route53#TagResourceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - } - } - }, - "com.amazonaws.route53#TagResourceIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#TagResourceId", - "traits": { - "smithy.api#xmlName": "ResourceId" - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.route53#TagResourceType": { - "type": "enum", - "members": { - "healthcheck": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "healthcheck" - } - }, - "hostedzone": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "hostedzone" - } - } - } - }, - "com.amazonaws.route53#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.route53#TestDNSAnswer": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#TestDNSAnswerRequest" - }, - "output": { - "target": "com.amazonaws.route53#TestDNSAnswerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the value that Amazon Route 53 returns in response to a DNS request for a\n\t\t\tspecified record name and type. You can optionally specify the IP address of a DNS\n\t\t\tresolver, an EDNS0 client subnet IP address, and a subnet mask.

\n

This call only supports querying public hosted zones.

\n \n

The TestDnsAnswer returns information similar to what you would expect from the answer\n\t\t\tsection of the dig command. Therefore, if you query for the name\n\t\t\tservers of a subdomain that point to the parent name servers, those will not be\n\t\t\treturned.

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/testdnsanswer", - "code": 200 - } - } - }, - "com.amazonaws.route53#TestDNSAnswerRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that you want Amazon Route 53 to simulate a query\n\t\t\tfor.

", - "smithy.api#httpQuery": "hostedzoneid", - "smithy.api#required": {} - } - }, - "RecordName": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

The name of the resource record set that you want Amazon Route 53 to simulate a query\n\t\t\tfor.

", - "smithy.api#httpQuery": "recordname", - "smithy.api#required": {} - } - }, - "RecordType": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

The type of the resource record set.

", - "smithy.api#httpQuery": "recordtype", - "smithy.api#required": {} - } - }, - "ResolverIP": { - "target": "com.amazonaws.route53#IPAddress", - "traits": { - "smithy.api#documentation": "

If you want to simulate a request from a specific DNS resolver, specify the IP address\n\t\t\tfor that resolver. If you omit this value, TestDnsAnswer uses the IP\n\t\t\taddress of a DNS resolver in the Amazon Web Services US East (N. Virginia) Region\n\t\t\t\t(us-east-1).

", - "smithy.api#httpQuery": "resolverip" - } - }, - "EDNS0ClientSubnetIP": { - "target": "com.amazonaws.route53#IPAddress", - "traits": { - "smithy.api#documentation": "

If the resolver that you specified for resolverip supports EDNS0, specify the IPv4 or\n\t\t\tIPv6 address of a client in the applicable location, for example,\n\t\t\t\t192.0.2.44 or 2001:db8:85a3::8a2e:370:7334.

", - "smithy.api#httpQuery": "edns0clientsubnetip" - } - }, - "EDNS0ClientSubnetMask": { - "target": "com.amazonaws.route53#SubnetMask", - "traits": { - "smithy.api#documentation": "

If you specify an IP address for edns0clientsubnetip, you can optionally\n\t\t\tspecify the number of bits of the IP address that you want the checking tool to include\n\t\t\tin the DNS query. For example, if you specify 192.0.2.44 for\n\t\t\t\tedns0clientsubnetip and 24 for\n\t\t\t\tedns0clientsubnetmask, the checking tool will simulate a request from\n\t\t\t192.0.2.0/24. The default value is 24 bits for IPv4 addresses and 64 bits for IPv6\n\t\t\taddresses.

\n

The range of valid values depends on whether edns0clientsubnetip is an\n\t\t\tIPv4 or an IPv6 address:

\n ", - "smithy.api#httpQuery": "edns0clientsubnetmask" - } - } - }, - "traits": { - "smithy.api#documentation": "

Gets the value that Amazon Route 53 returns in response to a DNS request for a\n\t\t\tspecified record name and type. You can optionally specify the IP address of a DNS\n\t\t\tresolver, an EDNS0 client subnet IP address, and a subnet mask.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#TestDNSAnswerResponse": { - "type": "structure", - "members": { - "Nameserver": { - "target": "com.amazonaws.route53#Nameserver", - "traits": { - "smithy.api#documentation": "

The Amazon Route 53 name server used to respond to the request.

", - "smithy.api#required": {} - } - }, - "RecordName": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

The name of the resource record set that you submitted a request for.

", - "smithy.api#required": {} - } - }, - "RecordType": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

The type of the resource record set that you submitted a request for.

", - "smithy.api#required": {} - } - }, - "RecordData": { - "target": "com.amazonaws.route53#RecordData", - "traits": { - "smithy.api#documentation": "

A list that contains values that Amazon Route 53 returned for this resource record\n\t\t\tset.

", - "smithy.api#required": {} - } - }, - "ResponseCode": { - "target": "com.amazonaws.route53#DNSRCode", - "traits": { - "smithy.api#documentation": "

A code that indicates whether the request is valid or not. The most common response\n\t\t\tcode is NOERROR, meaning that the request is valid. If the response is not\n\t\t\tvalid, Amazon Route 53 returns a response code that describes the error. For a list of\n\t\t\tpossible response codes, see DNS RCODES on the IANA website.

", - "smithy.api#required": {} - } - }, - "Protocol": { - "target": "com.amazonaws.route53#TransportProtocol", - "traits": { - "smithy.api#documentation": "

The protocol that Amazon Route 53 used to respond to the request, either\n\t\t\t\tUDP or TCP.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response to a TestDNSAnswer request.\n\t\t

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#Threshold": { - "type": "double" - }, - "com.amazonaws.route53#ThrottlingException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The limit on the number of requests per second was exceeded.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#TimeStamp": { - "type": "timestamp" - }, - "com.amazonaws.route53#TooManyHealthChecks": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

This health check can't be created because the current account has reached the limit\n\t\t\ton the number of active health checks.

\n

For information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n

For information about how to get the current limit for an account, see GetAccountLimit. To request a higher limit, create a case with the Amazon Web Services Support\n\t\t\tCenter.

\n

You have reached the maximum number of active health checks for an Amazon Web Services account. To request a higher limit, create a case with the Amazon Web Services Support\n\t\t\tCenter.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#TooManyHostedZones": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This operation can't be completed either because the current account has reached the\n\t\t\tlimit on the number of hosted zones or because you've reached the limit on the number of\n\t\t\thosted zones that can be associated with a reusable delegation set.

\n

For information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n

To get the current limit on hosted zones that can be created by an account, see GetAccountLimit.

\n

To get the current limit on hosted zones that can be associated with a reusable\n\t\t\tdelegation set, see GetReusableDelegationSetLimit.

\n

To request a higher limit, create a\n\t\t\t\tcase with the Amazon Web Services Support Center.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#TooManyKeySigningKeys": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "

You've reached the limit for the number of key-signing keys (KSKs). Remove at least\n\t\t\tone KSK, and then try again.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#TooManyTrafficPolicies": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This traffic policy can't be created because the current account has reached the limit\n\t\t\ton the number of traffic policies.

\n

For information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n

To get the current limit for an account, see GetAccountLimit.

\n

To request a higher limit, create a\n\t\t\t\tcase with the Amazon Web Services Support Center.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#TooManyTrafficPolicyInstances": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This traffic policy instance can't be created because the current account has reached\n\t\t\tthe limit on the number of traffic policy instances.

\n

For information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n

For information about how to get the current limit for an account, see GetAccountLimit.

\n

To request a higher limit, create a\n\t\t\t\tcase with the Amazon Web Services Support Center.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#TooManyTrafficPolicyVersionsForCurrentPolicy": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This traffic policy version can't be created because you've reached the limit of 1000\n\t\t\ton the number of versions that you can create for the current traffic policy.

\n

To create more traffic policy versions, you can use GetTrafficPolicy\n\t\t\tto get the traffic policy document for a specified traffic policy version, and then use\n\t\t\t\tCreateTrafficPolicy to create a new traffic policy using the traffic policy\n\t\t\tdocument.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#TooManyVPCAssociationAuthorizations": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

You've created the maximum number of authorizations that can be created for the\n\t\t\tspecified hosted zone. To authorize another VPC to be associated with the hosted zone,\n\t\t\tsubmit a DeleteVPCAssociationAuthorization request to remove an existing\n\t\t\tauthorization. To get a list of existing authorizations, submit a\n\t\t\t\tListVPCAssociationAuthorizations request.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#TrafficPolicies": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#TrafficPolicy", - "traits": { - "smithy.api#xmlName": "TrafficPolicy" - } - } - }, - "com.amazonaws.route53#TrafficPolicy": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

The ID that Amazon Route 53 assigned to a traffic policy when you created it.

", - "smithy.api#required": {} - } - }, - "Version": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", - "traits": { - "smithy.api#documentation": "

The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic\n\t\t\tpolicy, the value of Version is always 1.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.route53#TrafficPolicyName", - "traits": { - "smithy.api#documentation": "

The name that you specified when you created the traffic policy.

", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

The DNS type of the resource record sets that Amazon Route 53 creates when you use a\n\t\t\ttraffic policy to create a traffic policy instance.

", - "smithy.api#required": {} - } - }, - "Document": { - "target": "com.amazonaws.route53#TrafficPolicyDocument", - "traits": { - "smithy.api#documentation": "

The definition of a traffic policy in JSON format. You specify the JSON document to\n\t\t\tuse for a new traffic policy in the CreateTrafficPolicy request. For more\n\t\t\tinformation about the JSON format, see Traffic Policy Document Format.

", - "smithy.api#required": {} - } - }, - "Comment": { - "target": "com.amazonaws.route53#TrafficPolicyComment", - "traits": { - "smithy.api#documentation": "

The comment that you specify in the CreateTrafficPolicy request, if\n\t\t\tany.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains settings for a traffic policy.

" - } - }, - "com.amazonaws.route53#TrafficPolicyAlreadyExists": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A traffic policy that has the same value for Name already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.route53#TrafficPolicyComment": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.route53#TrafficPolicyDocument": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 102400 - } - } - }, - "com.amazonaws.route53#TrafficPolicyId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 36 - } - } - }, - "com.amazonaws.route53#TrafficPolicyInUse": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

One or more traffic policy instances were created by using the specified traffic\n\t\t\tpolicy.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#TrafficPolicyInstance": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyInstanceId", - "traits": { - "smithy.api#documentation": "

The ID that Amazon Route 53 assigned to the new traffic policy instance.

", - "smithy.api#required": {} - } - }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that Amazon Route 53 created resource record sets in.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "

The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries\n\t\t\tby using the resource record sets that are associated with this traffic policy instance.\n\t\t

", - "smithy.api#required": {} - } - }, - "TTL": { - "target": "com.amazonaws.route53#TTL", - "traits": { - "smithy.api#documentation": "

The TTL that Amazon Route 53 assigned to all of the resource record sets that it\n\t\t\tcreated in the specified hosted zone.

", - "smithy.api#required": {} - } - }, - "State": { - "target": "com.amazonaws.route53#TrafficPolicyInstanceState", - "traits": { - "smithy.api#documentation": "

The value of State is one of the following values:

\n
\n
Applied
\n
\n

Amazon Route 53 has finished creating resource record sets, and changes\n\t\t\t\t\t\thave propagated to all Route 53 edge locations.

\n
\n
Creating
\n
\n

Route 53 is creating the resource record sets. Use\n\t\t\t\t\t\t\tGetTrafficPolicyInstance to confirm that the\n\t\t\t\t\t\t\tCreateTrafficPolicyInstance request completed\n\t\t\t\t\t\tsuccessfully.

\n
\n
Failed
\n
\n

Route 53 wasn't able to create or update the resource record sets. When\n\t\t\t\t\t\tthe value of State is Failed, see\n\t\t\t\t\t\t\tMessage for an explanation of what caused the request to\n\t\t\t\t\t\tfail.

\n
\n
", - "smithy.api#required": {} - } - }, - "Message": { - "target": "com.amazonaws.route53#Message", - "traits": { - "smithy.api#documentation": "

If State is Failed, an explanation of the reason for the\n\t\t\tfailure. If State is another value, Message is empty.

", - "smithy.api#required": {} - } - }, - "TrafficPolicyId": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

The ID of the traffic policy that Amazon Route 53 used to create resource record sets\n\t\t\tin the specified hosted zone.

", - "smithy.api#required": {} - } - }, - "TrafficPolicyVersion": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", - "traits": { - "smithy.api#documentation": "

The version of the traffic policy that Amazon Route 53 used to create resource record\n\t\t\tsets in the specified hosted zone.

", - "smithy.api#required": {} - } - }, - "TrafficPolicyType": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

The DNS type that Amazon Route 53 assigned to all of the resource record sets that it\n\t\t\tcreated for this traffic policy instance.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains settings for the new traffic policy instance.

" - } - }, - "com.amazonaws.route53#TrafficPolicyInstanceAlreadyExists": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

There is already a traffic policy instance with the specified ID.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.route53#TrafficPolicyInstanceCount": { - "type": "integer" - }, - "com.amazonaws.route53#TrafficPolicyInstanceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 36 - } - } - }, - "com.amazonaws.route53#TrafficPolicyInstanceState": { - "type": "string" - }, - "com.amazonaws.route53#TrafficPolicyInstances": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#TrafficPolicyInstance", - "traits": { - "smithy.api#xmlName": "TrafficPolicyInstance" - } - } - }, - "com.amazonaws.route53#TrafficPolicyName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - } - } - }, - "com.amazonaws.route53#TrafficPolicySummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#TrafficPolicySummary", - "traits": { - "smithy.api#xmlName": "TrafficPolicySummary" - } - } - }, - "com.amazonaws.route53#TrafficPolicySummary": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

The ID that Amazon Route 53 assigned to the traffic policy when you created it.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.route53#TrafficPolicyName", - "traits": { - "smithy.api#documentation": "

The name that you specified for the traffic policy when you created it.

", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "

The DNS type of the resource record sets that Amazon Route 53 creates when you use a\n\t\t\ttraffic policy to create a traffic policy instance.

", - "smithy.api#required": {} - } - }, - "LatestVersion": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", - "traits": { - "smithy.api#documentation": "

The version number of the latest version of the traffic policy.

", - "smithy.api#required": {} - } - }, - "TrafficPolicyCount": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", - "traits": { - "smithy.api#documentation": "

The number of traffic policies that are associated with the current Amazon Web Services account.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the latest version of one traffic\n\t\t\tpolicy that is associated with the current Amazon Web Services account.

" - } - }, - "com.amazonaws.route53#TrafficPolicyVersion": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.route53#TrafficPolicyVersionMarker": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 4 - } - } - }, - "com.amazonaws.route53#TransportProtocol": { - "type": "string" - }, - "com.amazonaws.route53#UUID": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$" - } - }, - "com.amazonaws.route53#UpdateHealthCheck": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#UpdateHealthCheckRequest" - }, - "output": { - "target": "com.amazonaws.route53#UpdateHealthCheckResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#HealthCheckVersionMismatch" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an existing health check. Note that some values can't be updated.

\n

For more information about updating health checks, see Creating,\n\t\t\t\tUpdating, and Deleting Health Checks in the Amazon Route 53\n\t\t\t\tDeveloper Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/healthcheck/{HealthCheckId}", - "code": 200 - } - } - }, - "com.amazonaws.route53#UpdateHealthCheckRequest": { - "type": "structure", - "members": { - "HealthCheckId": { - "target": "com.amazonaws.route53#HealthCheckId", - "traits": { - "smithy.api#documentation": "

The ID for the health check for which you want detailed information. When you created\n\t\t\tthe health check, CreateHealthCheck returned the ID in the response, in the\n\t\t\t\tHealthCheckId element.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "HealthCheckVersion": { - "target": "com.amazonaws.route53#HealthCheckVersion", - "traits": { - "smithy.api#documentation": "

A sequential counter that Amazon Route 53 sets to 1 when you create a\n\t\t\thealth check and increments by 1 each time you update settings for the health\n\t\t\tcheck.

\n

We recommend that you use GetHealthCheck or ListHealthChecks\n\t\t\tto get the current value of HealthCheckVersion for the health check that\n\t\t\tyou want to update, and that you include that value in your\n\t\t\t\tUpdateHealthCheck request. This prevents Route 53 from overwriting an\n\t\t\tintervening update:

\n " - } - }, - "IPAddress": { - "target": "com.amazonaws.route53#IPAddress", - "traits": { - "smithy.api#documentation": "

The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform\n\t\t\thealth checks on. If you don't specify a value for IPAddress, Route 53\n\t\t\tsends a DNS request to resolve the domain name that you specify in\n\t\t\t\tFullyQualifiedDomainName at the interval that you specify in\n\t\t\t\tRequestInterval. Using an IP address that is returned by DNS, Route 53\n\t\t\tthen checks the health of the endpoint.

\n

Use one of the following formats for the value of IPAddress:

\n \n

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP\n\t\t\taddress, associate it with your EC2 instance, and specify the Elastic IP address for\n\t\t\t\tIPAddress. This ensures that the IP address of your instance never\n\t\t\tchanges. For more information, see the applicable documentation:

\n \n \n

If a health check already has a value for IPAddress, you can change\n\t\t\t\tthe value. However, you can't update an existing health check to add or remove the\n\t\t\t\tvalue of IPAddress.

\n \n

For more information, see FullyQualifiedDomainName.

\n

Constraints: Route 53 can't check the health of endpoints for which the IP address is\n\t\t\tin local, private, non-routable, or multicast ranges. For more information about IP\n\t\t\taddresses for which you can't create health checks, see the following documents:

\n " - } - }, - "Port": { - "target": "com.amazonaws.route53#Port", - "traits": { - "smithy.api#documentation": "

The port on the endpoint that you want Amazon Route 53 to perform health checks\n\t\t\ton.

\n \n

Don't specify a value for Port when you specify a value for\n\t\t\t\t\tType of CLOUDWATCH_METRIC or\n\t\t\t\tCALCULATED.

\n " - } - }, - "ResourcePath": { - "target": "com.amazonaws.route53#ResourcePath", - "traits": { - "smithy.api#documentation": "

The path that you want Amazon Route 53 to request when performing health checks. The\n\t\t\tpath can be any value for which your endpoint will return an HTTP status code of 2xx or\n\t\t\t3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.\n\t\t\tYou can also include query string parameters, for example,\n\t\t\t\t/welcome.html?language=jp&login=y.

\n

Specify this value only if you want to change it.

" - } - }, - "FullyQualifiedDomainName": { - "target": "com.amazonaws.route53#FullyQualifiedDomainName", - "traits": { - "smithy.api#documentation": "

Amazon Route 53 behavior depends on whether you specify a value for\n\t\t\t\tIPAddress.

\n \n

If a health check already has a value for IPAddress, you can change\n\t\t\t\tthe value. However, you can't update an existing health check to add or remove the\n\t\t\t\tvalue of IPAddress.

\n \n

\n If you specify a value for\n IPAddress:

\n

Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes\n\t\t\tthe value of FullyQualifiedDomainName in the Host header for\n\t\t\tall health checks except TCP health checks. This is typically the fully qualified DNS\n\t\t\tname of the endpoint on which you want Route 53 to perform health checks.

\n

When Route 53 checks the health of an endpoint, here is how it constructs the\n\t\t\t\tHost header:

\n \n

If you don't specify a value for FullyQualifiedDomainName, Route 53\n\t\t\tsubstitutes the value of IPAddress in the Host header in each\n\t\t\tof the above cases.

\n

\n If you don't specify a value for\n IPAddress:

\n

If you don't specify a value for IPAddress, Route 53 sends a DNS request\n\t\t\tto the domain that you specify in FullyQualifiedDomainName at the interval\n\t\t\tyou specify in RequestInterval. Using an IPv4 address that is returned by\n\t\t\tDNS, Route 53 then checks the health of the endpoint.

\n

If you don't specify a value for IPAddress, you can’t update the health check to remove the FullyQualifiedDomainName; if you don’t specify a value for IPAddress on creation, a \n\t\t\tFullyQualifiedDomainName is required.

\n \n

If you don't specify a value for IPAddress, Route 53 uses only IPv4\n\t\t\t\tto send health checks to the endpoint. If there's no resource record set with a type\n\t\t\t\tof A for the name that you specify for FullyQualifiedDomainName, the\n\t\t\t\thealth check fails with a \"DNS resolution failed\" error.

\n \n

If you want to check the health of weighted, latency, or failover resource record sets\n\t\t\tand you choose to specify the endpoint only by FullyQualifiedDomainName, we\n\t\t\trecommend that you create a separate health check for each endpoint. For example, create\n\t\t\ta health check for each HTTP server that is serving content for www.example.com. For the\n\t\t\tvalue of FullyQualifiedDomainName, specify the domain name of the server\n\t\t\t(such as us-east-2-www.example.com), not the name of the resource record\n\t\t\tsets (www.example.com).

\n \n

In this configuration, if the value of FullyQualifiedDomainName\n\t\t\t\tmatches the name of the resource record sets and you then associate the health check\n\t\t\t\twith those resource record sets, health check results will be unpredictable.

\n \n

In addition, if the value of Type is HTTP,\n\t\t\t\tHTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH,\n\t\t\tRoute 53 passes the value of FullyQualifiedDomainName in the\n\t\t\t\tHost header, as it does when you specify a value for\n\t\t\t\tIPAddress. If the value of Type is TCP, Route\n\t\t\t53 doesn't pass a Host header.

" - } - }, - "SearchString": { - "target": "com.amazonaws.route53#SearchString", - "traits": { - "smithy.api#documentation": "

If the value of Type is HTTP_STR_MATCH or\n\t\t\t\tHTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for\n\t\t\tin the response body from the specified resource. If the string appears in the response\n\t\t\tbody, Route 53 considers the resource healthy. (You can't change the value of\n\t\t\t\tType when you update a health check.)

" - } - }, - "FailureThreshold": { - "target": "com.amazonaws.route53#FailureThreshold", - "traits": { - "smithy.api#documentation": "

The number of consecutive health checks that an endpoint must pass or fail for Amazon\n\t\t\tRoute 53 to change the current status of the endpoint from unhealthy to healthy or vice\n\t\t\tversa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n

If you don't specify a value for FailureThreshold, the default value is\n\t\t\tthree health checks.

" - } - }, - "Inverted": { - "target": "com.amazonaws.route53#Inverted", - "traits": { - "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to invert the status of a health check, for\n\t\t\texample, to consider a health check unhealthy when it otherwise would be considered\n\t\t\thealthy.

" - } - }, - "Disabled": { - "target": "com.amazonaws.route53#Disabled", - "traits": { - "smithy.api#documentation": "

Stops Route 53 from performing health checks. When you disable a health check, here's\n\t\t\twhat happens:

\n \n

After you disable a health check, Route 53 considers the status of the health check to\n\t\t\talways be healthy. If you configured DNS failover, Route 53 continues to route traffic\n\t\t\tto the corresponding resources. If you want to stop routing traffic to a resource,\n\t\t\tchange the value of Inverted.

\n

Charges for a health check still apply when the health check is disabled. For more\n\t\t\tinformation, see Amazon Route 53\n\t\t\t\tPricing.

" - } - }, - "HealthThreshold": { - "target": "com.amazonaws.route53#HealthThreshold", - "traits": { - "smithy.api#documentation": "

The number of child health checks that are associated with a CALCULATED\n\t\t\thealth that Amazon Route 53 must consider healthy for the CALCULATED health\n\t\t\tcheck to be considered healthy. To specify the child health checks that you want to\n\t\t\tassociate with a CALCULATED health check, use the\n\t\t\t\tChildHealthChecks and ChildHealthCheck elements.

\n

Note the following:

\n " - } - }, - "ChildHealthChecks": { - "target": "com.amazonaws.route53#ChildHealthCheckList", - "traits": { - "smithy.api#documentation": "

A complex type that contains one ChildHealthCheck element for each health\n\t\t\tcheck that you want to associate with a CALCULATED health check.

" - } - }, - "EnableSNI": { - "target": "com.amazonaws.route53#EnableSNI", - "traits": { - "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to send the value of\n\t\t\t\tFullyQualifiedDomainName to the endpoint in the\n\t\t\t\tclient_hello message during TLS negotiation. This allows\n\t\t\tthe endpoint to respond to HTTPS health check requests with the applicable\n\t\t\tSSL/TLS certificate.

\n

Some endpoints require that HTTPS requests include the host name in the\n\t\t\t\tclient_hello message. If you don't enable SNI, the status of the health\n\t\t\tcheck will be SSL alert handshake_failure. A health check can also have\n\t\t\tthat status for other reasons. If SNI is enabled and you're still getting the error,\n\t\t\tcheck the SSL/TLS configuration on your endpoint and confirm that your certificate is\n\t\t\tvalid.

\n

The SSL/TLS certificate on your endpoint includes a domain name in the Common\n\t\t\t\tName field and possibly several more in the Subject Alternative\n\t\t\t\tNames field. One of the domain names in the certificate should match the\n\t\t\tvalue that you specify for FullyQualifiedDomainName. If the endpoint\n\t\t\tresponds to the client_hello message with a certificate that does not\n\t\t\tinclude the domain name that you specified in FullyQualifiedDomainName, a\n\t\t\thealth checker will retry the handshake. In the second attempt, the health checker will\n\t\t\tomit FullyQualifiedDomainName from the client_hello\n\t\t\tmessage.

" - } - }, - "Regions": { - "target": "com.amazonaws.route53#HealthCheckRegionList", - "traits": { - "smithy.api#documentation": "

A complex type that contains one Region element for each region that you\n\t\t\twant Amazon Route 53 health checkers to check the specified endpoint from.

" - } - }, - "AlarmIdentifier": { - "target": "com.amazonaws.route53#AlarmIdentifier", - "traits": { - "smithy.api#documentation": "

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53\n\t\t\thealth checkers to use to determine whether the specified health check is\n\t\t\thealthy.

" - } - }, - "InsufficientDataHealthStatus": { - "target": "com.amazonaws.route53#InsufficientDataHealthStatus", - "traits": { - "smithy.api#documentation": "

When CloudWatch has insufficient data about the metric to determine the alarm state,\n\t\t\tthe status that you want Amazon Route 53 to assign to the health check:

\n " - } - }, - "ResetElements": { - "target": "com.amazonaws.route53#ResettableElementNameList", - "traits": { - "smithy.api#documentation": "

A complex type that contains one ResettableElementName element for each\n\t\t\telement that you want to reset to the default value. Valid values for\n\t\t\t\tResettableElementName include the following:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about a request to update a health\n\t\t\tcheck.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#UpdateHealthCheckResponse": { - "type": "structure", - "members": { - "HealthCheck": { - "target": "com.amazonaws.route53#HealthCheck", - "traits": { - "smithy.api#documentation": "

A complex type that contains the response to an UpdateHealthCheck\n\t\t\trequest.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response to the UpdateHealthCheck\n\t\t\trequest.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#UpdateHostedZoneComment": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#UpdateHostedZoneCommentRequest" - }, - "output": { - "target": "com.amazonaws.route53#UpdateHostedZoneCommentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the comment for a specified hosted zone.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/hostedzone/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#UpdateHostedZoneCommentRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the hosted zone that you want to update the comment for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Comment": { - "target": "com.amazonaws.route53#ResourceDescription", - "traits": { - "smithy.api#documentation": "

The new comment for the hosted zone. If you don't specify a value for\n\t\t\t\tComment, Amazon Route 53 deletes the existing value of the\n\t\t\t\tComment element, if any.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A request to update the comment for a hosted zone.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#UpdateHostedZoneCommentResponse": { - "type": "structure", - "members": { - "HostedZone": { - "target": "com.amazonaws.route53#HostedZone", - "traits": { - "smithy.api#documentation": "

A complex type that contains the response to the UpdateHostedZoneComment\n\t\t\trequest.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response to the UpdateHostedZoneComment\n\t\t\trequest.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#UpdateTrafficPolicyComment": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#UpdateTrafficPolicyCommentRequest" - }, - "output": { - "target": "com.amazonaws.route53#UpdateTrafficPolicyCommentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicy" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the comment for a specified traffic policy version.

", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/trafficpolicy/{Id}/{Version}", - "code": 200 - } - } - }, - "com.amazonaws.route53#UpdateTrafficPolicyCommentRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

The value of Id for the traffic policy that you want to update the\n\t\t\tcomment for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Version": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", - "traits": { - "smithy.api#documentation": "

The value of Version for the traffic policy that you want to update the\n\t\t\tcomment for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Comment": { - "target": "com.amazonaws.route53#TrafficPolicyComment", - "traits": { - "smithy.api#documentation": "

The new comment for the specified traffic policy and version.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the traffic policy that you want to\n\t\t\tupdate the comment for.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#UpdateTrafficPolicyCommentResponse": { - "type": "structure", - "members": { - "TrafficPolicy": { - "target": "com.amazonaws.route53#TrafficPolicy", - "traits": { - "smithy.api#documentation": "

A complex type that contains settings for the specified traffic policy.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains the response information for the traffic policy.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#UpdateTrafficPolicyInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#UpdateTrafficPolicyInstanceRequest" - }, - "output": { - "target": "com.amazonaws.route53#UpdateTrafficPolicyInstanceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConflictingTypes" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicy" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - } - ], - "traits": { - "smithy.api#documentation": "\n

After you submit a UpdateTrafficPolicyInstance request, there's a brief delay while Route 53 creates the resource record sets \n\t\t\tthat are specified in the traffic policy definition. Use GetTrafficPolicyInstance with the id of updated traffic policy instance confirm \n\t\t\tthat the \n\t\t\tUpdateTrafficPolicyInstance request completed successfully. For more information, see the State response element.

\n \n

Updates the resource record sets in a specified hosted zone that were created based on\n\t\t\tthe settings in a specified traffic policy version.

\n

When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS\n\t\t\tqueries for the root resource record set name (such as example.com) while it replaces\n\t\t\tone group of resource record sets with another. Route 53 performs the following\n\t\t\toperations:

\n
    \n
  1. \n

    Route 53 creates a new group of resource record sets based on the specified\n\t\t\t\t\ttraffic policy. This is true regardless of how significant the differences are\n\t\t\t\t\tbetween the existing resource record sets and the new resource record sets.\n\t\t\t\t

    \n
    2. \n
  2. \n

    When all of the new resource record sets have been created, Route 53 starts to\n\t\t\t\t\trespond to DNS queries for the root resource record set name (such as\n\t\t\t\t\texample.com) by using the new resource record sets.

    \n
    3. \n
  3. \n

    Route 53 deletes the old group of resource record sets that are associated\n\t\t\t\t\twith the root resource record set name.

    \n
    4. \n
", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/trafficpolicyinstance/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#UpdateTrafficPolicyInstanceRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyInstanceId", - "traits": { - "smithy.api#documentation": "

The ID of the traffic policy instance that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TTL": { - "target": "com.amazonaws.route53#TTL", - "traits": { - "smithy.api#documentation": "

The TTL that you want Amazon Route 53 to assign to all of the updated resource record\n\t\t\tsets.

", - "smithy.api#required": {} - } - }, - "TrafficPolicyId": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "

The ID of the traffic policy that you want Amazon Route 53 to use to update resource\n\t\t\trecord sets for the specified traffic policy instance.

", - "smithy.api#required": {} - } - }, - "TrafficPolicyVersion": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", - "traits": { - "smithy.api#documentation": "

The version of the traffic policy that you want Amazon Route 53 to use to update\n\t\t\tresource record sets for the specified traffic policy instance.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the resource record sets that you want\n\t\t\tto update based on a specified traffic policy instance.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#UpdateTrafficPolicyInstanceResponse": { - "type": "structure", - "members": { - "TrafficPolicyInstance": { - "target": "com.amazonaws.route53#TrafficPolicyInstance", - "traits": { - "smithy.api#documentation": "

A complex type that contains settings for the updated traffic policy instance.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A complex type that contains information about the resource record sets that Amazon\n\t\t\tRoute 53 created based on a specified traffic policy.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#UsageCount": { - "type": "long", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.route53#VPC": { - "type": "structure", - "members": { - "VPCRegion": { - "target": "com.amazonaws.route53#VPCRegion", - "traits": { - "smithy.api#documentation": "

(Private hosted zones only) The region that an Amazon VPC was created\n\t\t\tin.

" - } - }, - "VPCId": { - "target": "com.amazonaws.route53#VPCId" - } - }, - "traits": { - "smithy.api#documentation": "

(Private hosted zones only) A complex type that contains information about an Amazon VPC.

\n

If you associate a private hosted zone with an Amazon VPC when you make a\n\t\t\t\tCreateHostedZone\n\t\t\trequest, the following parameters are also required.

" - } - }, - "com.amazonaws.route53#VPCAssociationAuthorizationNotFound": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The VPC that you specified is not authorized to be associated with the hosted\n\t\t\tzone.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#VPCAssociationNotFound": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "

The specified VPC or hosted zone weren't found.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The specified VPC and hosted zone are not currently associated.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#VPCId": { - "type": "string", - "traits": { - "smithy.api#documentation": "

(Private hosted zones only) The ID of an Amazon VPC.

", - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.route53#VPCRegion": { - "type": "enum", - "members": { - "us_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-1" - } - }, - "us_east_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-2" - } - }, - "us_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-1" - } - }, - "us_west_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-2" - } - }, - "eu_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-1" - } - }, - "eu_west_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-2" - } - }, - "eu_west_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-3" - } - }, - "eu_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-central-1" - } - }, - "eu_central_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-central-2" - } - }, - "ap_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-east-1" - } - }, - "me_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "me-south-1" - } - }, - "us_gov_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-gov-west-1" - } - }, - "us_gov_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-gov-east-1" - } - }, - "us_iso_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-iso-east-1" - } - }, - "us_iso_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-iso-west-1" - } - }, - "us_isob_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-isob-east-1" - } - }, - "me_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "me-central-1" - } - }, - "ap_southeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-1" - } - }, - "ap_southeast_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-2" - } - }, - "ap_southeast_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-3" - } - }, - "ap_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-south-1" - } - }, - "ap_south_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-south-2" - } - }, - "ap_northeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-1" - } - }, - "ap_northeast_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-2" - } - }, - "ap_northeast_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-3" - } - }, - "eu_north_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-north-1" - } - }, - "sa_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sa-east-1" - } - }, - "ca_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ca-central-1" - } - }, - "cn_north_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cn-north-1" - } - }, - "af_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "af-south-1" - } - }, - "eu_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-south-1" - } - }, - "eu_south_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-south-2" - } - }, - "ap_southeast_4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-4" - } - }, - "il_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "il-central-1" - } - }, - "ca_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ca-west-1" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#VPCs": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#VPC", - "traits": { - "smithy.api#xmlName": "VPC" - } - }, - "traits": { - "smithy.api#documentation": "

(Private hosted zones only) A list of VPC elements.

", - "smithy.api#length": { - "min": 1 } - } } - } }